LexiComLogEvent (Cleo VersaLex Java API)

java.lang.Object
- com.cleo.lexicom.external.LexiComLogEvent

public class LexiComLogEvent
extends java.lang.Object

LexiComLogEvent is used to notify interested parties of a significant run event of a VersaLex runnable object (local host or action). The log event can also be from the framework, in which case the host\mailbox\action references are null. Refer to LexiComLogListener.log(LexiComLogEvent).

Events include:

   Tag: Thread     Content: No    Attributes: level (required)
                                              type (optional)
   Tag: Command    Content: No    Attributes: text, type (required)
                                              line (optional)
   Tag: Detail     Content: Yes   Attributes: level (required)
                                              type (optional)
   Tag: Hint       Content: Yes   Attributes: -
   Tag: Request    Content: No    Attributes: text, type (required)
   Tag: Incoming   Content: No    Attributes: transferID, messageID, source, folder,
                                              host, mailbox, transport (optional)
   Tag: File       Content: No    Attributes: transferID, messageID, source, direction,
                                              destination, number, fileSize,
                                              fileTimeStamp, host, mailbox (optional)
   Tag: Transfer   Content: No    Attributes: bytes, seconds (required)
                                              active, percentage, mode, blocks,
                                              errors (optional)
   Tag: Response   Content: Yes   Attributes: host (required)
   Tag: Result     Content: Yes   Attributes: text (required),
                                              command, line (from Command)
                                              transferID, messageID, source, direction,
                                              destination, number, fileSize,
                                              fileTimeStamp (from File),
                                              bytes, seconds (from Transfer)
                                              origMessageID, mdn, asyncMDN
   Tag: End        Content: No    Attributes: -

Sequential events can be tied together by using the event's threadID/commandID.

Following is a general flow of events for files sent/received via a VersaLex action:

   Thread
     Command -----------------------+ Repeated
       File -------+ Repeated       | for each
       Request     | for each       | command
         Transfer  | file sent/     | in the
       Response    | received       | action
       Result -----+----------------+
   End

 Detail and Hint events can occur at anytime.  The exact order of events between
 File and Result is protocol dependent.  Depending on the protocol, there may in fact
 be multiple Request and Response events for one File.

Following is a general flow of events for unsolicited files sent/received via the VersaLex Local Listener:

   Connect (if FTP)
     Request -----------------------+ Repeated
     Incoming (if AS2/AS3)          | for each
     File                           | file
       Transfer                     | sent/received
     Response                       | during the FTP
     Result ------------------------+ connection
   Disconnect (if FTP)

 Detail and Hint events can occur at anytime.  The exact order of events between
 Incoming and Result is protocol dependent.  Depending on the protocol, there may
 in fact be multiple Request and Response events for one File.

Constructor Summary

Constructors
Constructor and Description
`LexiComLogEvent(java.lang.String[] source, org.w3c.dom.Element event, java.lang.String message, java.util.Date date, java.lang.String threadID, java.lang.String commandID)` Constructs a LexiComLogEvent with the specified host, mailbox, action and the specified event

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LexiComLogEvent`	`fromBytes(byte[] bytes)` Converts a byte array into a LexiComLogEvent Object
`java.lang.String`	`getBy()` Returns who logged the event.
`java.lang.String`	`getColor()` Returns the log event color.
`java.lang.String`	`getCommandID()` Returns the log event command ID.
`java.util.Date`	`getDate()` Returns the log event time/date.
`org.w3c.dom.Element`	`getEvent()` Returns the log event.
`java.lang.String`	`getMessage()` Returns the log event.
`java.lang.String[]`	`getSource()` Returns the alias path for the log event.
`java.lang.String`	`getText()` Returns the log event text.
`java.lang.String`	`getThreadID()` Returns the log event thread ID.
`java.lang.String`	`getWhen()` Returns when the log event occurred.
`boolean`	`isInLogFile()` Indicates whether log event is being logged to system log file.
`boolean`	`isInMessageList()` Indicates whether log event is being shown in system messages list pane.
`static java.lang.String`	`readString(byte[] bytes, int offset)` Helper method to convert a byte array back into a Java String
`byte[]`	`toBytes()` Converts the event into a byte array
`static void`	`writeString(java.io.DataOutputStream dos, java.lang.String str)` Helper method to convert a string to bytes

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

- Constructor Detail
  - LexiComLogEvent
```
public LexiComLogEvent(java.lang.String[] source,
                       org.w3c.dom.Element event,
                       java.lang.String message,
                       java.util.Date date,
                       java.lang.String threadID,
                       java.lang.String commandID)
```
    Constructs a LexiComLogEvent with the specified host, mailbox, action and the specified event
    
    Parameters:
    
    source - the source alias path
    
    event - the log event as a DOM element
    
    message - the log event as a text string
    
    date - the time/date the event was logged
    
    threadID - the thread ID of the log event
    
    commandID - the command ID of the log event
- Method Detail
  - toBytes
```
public byte[] toBytes()
               throws java.io.IOException
```
    Converts the event into a byte array
    
    Returns:
    
    Throws:
    
    java.io.IOException
  - fromBytes
```
public static LexiComLogEvent fromBytes(byte[] bytes)
```
    Converts a byte array into a LexiComLogEvent Object
    
    Parameters:
    
    bytes -
    
    Returns:
  - getSource
```
public java.lang.String[] getSource()
```
    Returns the alias path for the log event.
    
    Returns:
    
    the alias path
  - getEvent
```
public org.w3c.dom.Element getEvent()
```
    Returns the log event.
    
    Returns:
    
    the log event as a DOM element
  - getMessage
```
public java.lang.String getMessage()
```
    Returns the log event.
    
    Returns:
    
    the log event as a text string
  - getWhen
```
public java.lang.String getWhen()
```
    Returns when the log event occurred.
    
    Returns:
    
    the when the log event occurred as a text string
  - getBy
```
public java.lang.String getBy()
```
    Returns who logged the event.
    
    Returns:
    
    who logged the event as a text string
  - getText
```
public java.lang.String getText()
```
    Returns the log event text.
    
    Returns:
    
    the log event text
  - getColor
```
public java.lang.String getColor()
```
    Returns the log event color.
    
    Returns:
    
    the log event color
  - getDate
```
public java.util.Date getDate()
```
    Returns the log event time/date.
    
    Returns:
    
    the log event time/date stamp
  - getThreadID
```
public java.lang.String getThreadID()
```
    Returns the log event thread ID. The thread ID is is constant for each run of an action and each run of the listener.
    
    Returns:
    
    the log event thread ID
  - getCommandID
```
public java.lang.String getCommandID()
```
    Returns the log event command ID. The command ID is constant for each command that is processed by the action or each message (file) that is received by the listener.
    
    Returns:
    
    the log event command ID
  - isInLogFile
```
public boolean isInLogFile()
```
    Indicates whether log event is being logged to system log file.
    
    Returns:
    
    true if included in system log file
  - isInMessageList
```
public boolean isInMessageList()
```
    Indicates whether log event is being shown in system messages list pane.
    
    Returns:
    
    true if included in system messages list pane
  - writeString
```
public static void writeString(java.io.DataOutputStream dos,
                               java.lang.String str)
                        throws java.io.IOException
```
    Helper method to convert a string to bytes
    
    Parameters:
    
    dos - - the DataOutputStream object to write the bytes to
    
    str - - The string to convert
    
    Throws:
    
    java.io.IOException
  - readString
```
public static java.lang.String readString(byte[] bytes,
                                          int offset)
```
    Helper method to convert a byte array back into a Java String
    
    Parameters:
    
    bytes - - the bytes to convert to string
    
    offset - - Offset to start reading the string
    
    Returns:

Class LexiComLogEvent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LexiComLogEvent

Method Detail

toBytes

fromBytes

getSource

getEvent

getMessage

getWhen

getBy

getText

getColor

getDate

getThreadID

getCommandID

isInLogFile

isInMessageList

writeString

readString