XMLLogElement (Cleo VersaLex Java API)

java.lang.Object
- org.xml.sax.helpers.AttributesImpl
- - com.cleo.util.logger.XMLLogElement

All Implemented Interfaces:: java.io.Serializable, org.xml.sax.Attributes

public class XMLLogElement
extends org.xml.sax.helpers.AttributesImpl
implements java.io.Serializable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BLACK`
`static java.lang.String`	`BLUE`
`static java.lang.String`	`COMMAND`
`static java.lang.String`	`CONNECT`
`static java.lang.String`	`CRC`
`static java.lang.String`	`CYAN`
`static java.lang.String`	`DEBUG`
`static java.lang.String`	`DETAIL`
`static java.lang.String`	`DISCONNECT`
`static java.lang.String`	`END`
`static java.lang.String`	`FILE`
`static java.lang.String`	`FLAG`
`static java.lang.String`	`GREEN`
`static java.lang.String`	`HINT`
`static java.lang.String`	`INCOMING`
`static java.lang.String`	`LICENSE`
`static java.lang.String`	`MAGENTA`
`static java.lang.String`	`ORANGE`
`static java.lang.String`	`RED`
`static java.lang.String`	`REQUEST`
`static java.lang.String`	`RESPONSE`
`static java.lang.String`	`RESULT`
`static java.lang.String`	`RUN`
`static java.lang.String`	`SESSION`
`static java.lang.String`	`SYSTEM`
`static java.lang.String`	`THREAD`
`static java.lang.String`	`TRACE`
`static java.lang.String`	`TRANSFER` TRANSFER is used by LexiCom/VLTrader/Harmony logging
`static java.lang.String`	`UUID_PATTERN`
`static java.lang.String`	`XFER` XFER is used by VLProxy logging

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getDocDBTransferID(java.lang.String transferID)` Given a transfer ID string of "TransmissionTransferID;DocDBTransferID", return the "DocDBTransferID" (i.e., the UUID transfer ID) portion.
`static java.lang.String`	`getDocDBTransferID(java.lang.String transferID, boolean withSemicolon)` Given a transfer ID string of "TransmissionTransferID;DocDBTransferID", return the "DocDBTransferID" (i.e., the UUID transfer ID) portion.
`java.lang.Throwable`	`getException()` Return an associated exception captured with the event, or null if not available.
`static java.lang.String`	`getTransmissionTransferID(java.lang.String transferID)` Given a transfer ID string of "TransmissionTransferID;DocDBTransferID", return the "TransmissionTransferID" (i.e., classic/original transfer ID) portion.
`static java.lang.String`	`getTransmissionTransferID(java.lang.String transferID, boolean withSemicolon)` Given a transfer ID string of "TransmissionTransferID;DocDBTransferID", return the "TransmissionTransferID" (i.e., classic/original transfer ID) portion.
`void`	`setException(java.lang.Throwable exception)` If relevant, set an associated exception for downstream processing.
`protected static java.lang.String`	`stripInvalidAttributeNameCharacters(java.lang.String attributeName)`

Methods inherited from class org.xml.sax.helpers.AttributesImpl
addAttribute, clear, getIndex, getIndex, getLength, getLocalName, getQName, getType, getType, getType, getURI, getValue, getValue, getValue, removeAttribute, setAttribute, setAttributes, setLocalName, setQName, setType, setURI, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GREEN
```
public static final java.lang.String GREEN
```
    See Also:
    
    Constant Field Values
  - BLUE
```
public static final java.lang.String BLUE
```
    See Also:
    
    Constant Field Values
  - RED
```
public static final java.lang.String RED
```
    See Also:
    
    Constant Field Values
  - ORANGE
```
public static final java.lang.String ORANGE
```
    See Also:
    
    Constant Field Values
  - MAGENTA
```
public static final java.lang.String MAGENTA
```
    See Also:
    
    Constant Field Values
  - CYAN
```
public static final java.lang.String CYAN
```
    See Also:
    
    Constant Field Values
  - BLACK
```
public static final java.lang.String BLACK
```
    See Also:
    
    Constant Field Values
  - SESSION
```
public static final java.lang.String SESSION
```
    See Also:
    
    Constant Field Values
  - SYSTEM
```
public static final java.lang.String SYSTEM
```
    See Also:
    
    Constant Field Values
  - LICENSE
```
public static final java.lang.String LICENSE
```
    See Also:
    
    Constant Field Values
  - RUN
```
public static final java.lang.String RUN
```
    See Also:
    
    Constant Field Values
  - THREAD
```
public static final java.lang.String THREAD
```
    See Also:
    
    Constant Field Values
  - COMMAND
```
public static final java.lang.String COMMAND
```
    See Also:
    
    Constant Field Values
  - REQUEST
```
public static final java.lang.String REQUEST
```
    See Also:
    
    Constant Field Values
  - RESPONSE
```
public static final java.lang.String RESPONSE
```
    See Also:
    
    Constant Field Values
  - FILE
```
public static final java.lang.String FILE
```
    See Also:
    
    Constant Field Values
  - TRANSFER
```
public static final java.lang.String TRANSFER
```
    TRANSFER is used by LexiCom/VLTrader/Harmony logging
    
    See Also:
    
    Constant Field Values
  - CRC
```
public static final java.lang.String CRC
```
    See Also:
    
    Constant Field Values
  - DETAIL
```
public static final java.lang.String DETAIL
```
    See Also:
    
    Constant Field Values
  - HINT
```
public static final java.lang.String HINT
```
    See Also:
    
    Constant Field Values
  - FLAG
```
public static final java.lang.String FLAG
```
    See Also:
    
    Constant Field Values
  - RESULT
```
public static final java.lang.String RESULT
```
    See Also:
    
    Constant Field Values
  - INCOMING
```
public static final java.lang.String INCOMING
```
    See Also:
    
    Constant Field Values
  - DEBUG
```
public static final java.lang.String DEBUG
```
    See Also:
    
    Constant Field Values
  - TRACE
```
public static final java.lang.String TRACE
```
    See Also:
    
    Constant Field Values
  - XFER
```
public static final java.lang.String XFER
```
    XFER is used by VLProxy logging
    
    See Also:
    
    Constant Field Values
  - END
```
public static final java.lang.String END
```
    See Also:
    
    Constant Field Values
  - CONNECT
```
public static final java.lang.String CONNECT
```
    See Also:
    
    Constant Field Values
  - DISCONNECT
```
public static final java.lang.String DISCONNECT
```
    See Also:
    
    Constant Field Values
  - UUID_PATTERN
```
public static final java.lang.String UUID_PATTERN
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getException
```
public java.lang.Throwable getException()
```
    Return an associated exception captured with the event, or null if not available.
    
    Returns:
    
    exception
  - setException
```
public void setException(java.lang.Throwable exception)
```
    If relevant, set an associated exception for downstream processing.
    
    Parameters:
    
    exception - exception associated with event
  - getTransmissionTransferID
```
public static java.lang.String getTransmissionTransferID(java.lang.String transferID)
```
    Given a transfer ID string of "TransmissionTransferID;DocDBTransferID", return the "TransmissionTransferID" (i.e., classic/original transfer ID) portion. If no semicolon is found, and the string is not a UUID pattern, then the string is assumed to be the TransmissionTransferID.
    
    Parameters:
    
    transferID - the transfer ID string of form "TransmissionTransferID;DocDBTransferID".
    
    Returns:
    
    the TransmissionTransferID. Returns empty string if not present (or if input string is null).
  - getTransmissionTransferID
```
public static java.lang.String getTransmissionTransferID(java.lang.String transferID,
                                                         boolean withSemicolon)
```
    Given a transfer ID string of "TransmissionTransferID;DocDBTransferID", return the "TransmissionTransferID" (i.e., classic/original transfer ID) portion. If no semicolon is found, and the string is not a UUID pattern, then the string is assumed to be the TransmissionTransferID.
    
    Parameters:
    
    transferID - the transfer ID string of form "TransmissionTransferID;DocDBTransferID".
    
    withSemicolon - if true, returns "TransmissionTransferID;". If false, returns only "TransmissionTransferID".
    
    Returns:
    
    the TransmissionTransferID. Returns empty string if not present (or if input string is null).
  - getDocDBTransferID
```
public static java.lang.String getDocDBTransferID(java.lang.String transferID)
```
    Given a transfer ID string of "TransmissionTransferID;DocDBTransferID", return the "DocDBTransferID" (i.e., the UUID transfer ID) portion. If no semicolon is found, and the string matches a UUID pattern, then the string is assumed to be the DocDBTransferID.
    
    Parameters:
    
    transferID - the transfer ID string of form "TransmissionTransferID;DocDBTransferID".
    
    Returns:
    
    the DocDBTransferID. Returns empty string if not present (or if input string is null).
  - getDocDBTransferID
```
public static java.lang.String getDocDBTransferID(java.lang.String transferID,
                                                  boolean withSemicolon)
```
    Given a transfer ID string of "TransmissionTransferID;DocDBTransferID", return the "DocDBTransferID" (i.e., the UUID transfer ID) portion. If no semicolon is found, and the string matches a UUID pattern, then the string is assumed to be the DocDBTransferID.
    
    Parameters:
    
    transferID - the transfer ID string of form "TransmissionTransferID;DocDBTransferID".
    
    withSemicolon - if true, returns ";DocDBTransferID". If false, returns only "DocDBTransferID".
    
    Returns:
    
    the DocDBTransferID. Returns empty string if not present (or if input string is null).
  - stripInvalidAttributeNameCharacters
```
protected static java.lang.String stripInvalidAttributeNameCharacters(java.lang.String attributeName)
```

Class XMLLogElement

Field Summary

Method Summary

Methods inherited from class org.xml.sax.helpers.AttributesImpl

Methods inherited from class java.lang.Object

Field Detail

GREEN

BLUE

RED

ORANGE

MAGENTA

CYAN

BLACK

SESSION

SYSTEM

LICENSE

RUN

THREAD

COMMAND

REQUEST

RESPONSE

FILE

TRANSFER

CRC

DETAIL

HINT

FLAG

RESULT

INCOMING

DEBUG

TRACE

XFER

END

CONNECT

DISCONNECT

UUID_PATTERN

Method Detail

getException

setException

getTransmissionTransferID

getTransmissionTransferID

getDocDBTransferID

getDocDBTransferID

stripInvalidAttributeNameCharacters