Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.messageserver.events
Class EventLogMessage

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.management.protocol.messageserver.events.EventLogMessage
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventLogMessage
extends Message

Regular log message sent from message server by subscription


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventLogMessage create()
          Creates instance of EventLogMessage with no parameters set.
static EventLogMessage create(LogLevel level, java.util.Date time, java.lang.Integer usec, java.lang.String messageHeader, java.lang.Integer entryId, java.lang.String entryText, byte[] entryData, LogCategory entryCategory, java.lang.String clientHost, java.lang.Integer clientId, java.lang.String clientName, AttributeList attributes)
          Creates instance of EventLogMessage with all parameters set.
abstract  AttributeList getAttributes()
          Attributes for interaction support
abstract  java.lang.String getClientHost()
           
abstract  java.lang.Integer getClientId()
           
abstract  java.lang.String getClientName()
           
abstract  LogCategory getEntryCategory()
           
abstract  byte[] getEntryData()
           
abstract  java.lang.Integer getEntryId()
           
abstract  java.lang.String getEntryText()
           
abstract  LogLevel getLevel()
           
abstract  java.lang.String getMessageHeader()
           
abstract  java.util.Date getTime()
          Note that server sends this value in UTC format always.
abstract  java.lang.Integer getUsec()
           
abstract  void setAttributes(AttributeList attributes)
          Attributes for interaction support
abstract  void setClientHost(java.lang.String clientHost)
           
abstract  void setClientId(int clientId)
           
abstract  void setClientId(java.lang.Integer clientId)
           
abstract  void setClientName(java.lang.String clientName)
           
abstract  void setEntryCategory(LogCategory entryCategory)
           
abstract  void setEntryData(byte[] entryData)
           
abstract  void setEntryId(int entryId)
           
abstract  void setEntryId(java.lang.Integer entryId)
           
abstract  void setEntryText(java.lang.String entryText)
           
abstract  void setLevel(LogLevel level)
           
abstract  void setMessageHeader(java.lang.String messageHeader)
           
abstract  void setTime(java.util.Date time)
          Note that server sends this value in UTC format always.
abstract  void setUsec(int usec)
           
abstract  void setUsec(java.lang.Integer usec)
           
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static EventLogMessage create()
Creates instance of EventLogMessage with no parameters set.

Returns:
instance of EventLogMessage

create

public static EventLogMessage create(LogLevel level,
                                     java.util.Date time,
                                     java.lang.Integer usec,
                                     java.lang.String messageHeader,
                                     java.lang.Integer entryId,
                                     java.lang.String entryText,
                                     byte[] entryData,
                                     LogCategory entryCategory,
                                     java.lang.String clientHost,
                                     java.lang.Integer clientId,
                                     java.lang.String clientName,
                                     AttributeList attributes)
Creates instance of EventLogMessage with all parameters set.

Parameters:
level - Level
time - Note that server sends this value in UTC format always.
usec - Usec
messageHeader - MessageHeader
entryId - EntryId
entryText - EntryText
entryData - EntryData
entryCategory - EntryCategory
clientHost - ClientHost
clientId - ClientId
clientName - ClientName
attributes - Attributes for interaction support
Returns:
instance of EventLogMessage

getLevel

public abstract LogLevel getLevel()

setLevel

public abstract void setLevel(LogLevel level)

getTime

public abstract java.util.Date getTime()
Note that server sends this value in UTC format always.

Returns:
property value

setTime

public abstract void setTime(java.util.Date time)
Note that server sends this value in UTC format always.

Parameters:
time - new value of the property

getUsec

public abstract java.lang.Integer getUsec()

setUsec

public abstract void setUsec(java.lang.Integer usec)

setUsec

public abstract void setUsec(int usec)

getMessageHeader

public abstract java.lang.String getMessageHeader()

setMessageHeader

public abstract void setMessageHeader(java.lang.String messageHeader)

getEntryId

public abstract java.lang.Integer getEntryId()

setEntryId

public abstract void setEntryId(java.lang.Integer entryId)

setEntryId

public abstract void setEntryId(int entryId)

getEntryText

public abstract java.lang.String getEntryText()

setEntryText

public abstract void setEntryText(java.lang.String entryText)

getEntryData

public abstract byte[] getEntryData()

setEntryData

public abstract void setEntryData(byte[] entryData)

getEntryCategory

public abstract LogCategory getEntryCategory()

setEntryCategory

public abstract void setEntryCategory(LogCategory entryCategory)

getClientHost

public abstract java.lang.String getClientHost()

setClientHost

public abstract void setClientHost(java.lang.String clientHost)

getClientId

public abstract java.lang.Integer getClientId()

setClientId

public abstract void setClientId(java.lang.Integer clientId)

setClientId

public abstract void setClientId(int clientId)

getClientName

public abstract java.lang.String getClientName()

setClientName

public abstract void setClientName(java.lang.String clientName)

getAttributes

public abstract AttributeList getAttributes()
Attributes for interaction support

Returns:
property value

setAttributes

public abstract void setAttributes(AttributeList attributes)
Attributes for interaction support

Parameters:
attributes - new value of the property

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.