|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.management.protocol.messageserver.events.EventSubscription
public abstract class EventSubscription
Event is returned with subscribed info on a following subscribing messages:
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventSubscription |
create()
Creates instance of EventSubscription with no parameters set. |
static EventSubscription |
create(MessageTypes messageType,
MessagePriority priority,
java.lang.Integer origin,
java.util.Date time,
java.lang.Integer usec,
java.lang.Integer subscriberType,
java.lang.Integer attachedDataLength,
byte[] attachedData,
KeyValueCollection userData,
java.lang.Long timeGenerated,
KeyValueCollection logParameters,
java.lang.Integer messageGuid2,
java.lang.Integer messageGuid3,
byte[] messageGuid4,
java.lang.Integer keyFlags,
java.lang.Integer keyInteger,
java.lang.Integer keyLong,
java.lang.String keyString,
KeyValueCollection keyKVList)
Creates instance of EventSubscription with all parameters set. |
abstract byte[] |
getAttachedData()
Any data attached to the message |
abstract java.lang.Integer |
getAttachedDataLength()
Length of the attached data |
abstract java.lang.Integer |
getKeyFlags()
Simple key: flags. |
abstract java.lang.Integer |
getKeyInteger()
Simple key: integer value |
abstract KeyValueCollection |
getKeyKVList()
KVList key |
abstract java.lang.Integer |
getKeyLong()
Simple key: unsigned long value |
abstract java.lang.String |
getKeyString()
Simple key: string value |
abstract KeyValueCollection |
getLogParameters()
|
abstract java.lang.Integer |
getMessageGuid1()
Message GUID - Data1 member. |
abstract java.lang.Integer |
getMessageGuid2()
Message GUID - Data2 member |
abstract java.lang.Integer |
getMessageGuid3()
Message GUID - Data3 member |
abstract byte[] |
getMessageGuid4()
Message GUID - Data4 member |
abstract MessageTypes |
getMessageType()
The message type. |
abstract java.lang.Integer |
getOrigin()
Origin of the message (ID of an application) |
abstract MessagePriority |
getPriority()
Priority of the message |
abstract java.lang.Integer |
getSubscriberType()
Subscription: Type of the message to subscribe to |
abstract java.util.Date |
getTime()
Note that server sends this value in UTC format always. |
abstract java.lang.Long |
getTimeGenerated()
The time when message was generated by supplier |
abstract java.lang.Integer |
getUsec()
|
abstract KeyValueCollection |
getUserData()
Attached data packed in TKVList |
abstract void |
setAttachedData(byte[] attachedData)
Any data attached to the message |
abstract void |
setAttachedDataLength(int attachedDataLength)
Length of the attached data |
abstract void |
setAttachedDataLength(java.lang.Integer attachedDataLength)
Length of the attached data |
abstract void |
setKeyFlags(int keyFlags)
Simple key: flags. |
abstract void |
setKeyFlags(java.lang.Integer keyFlags)
Simple key: flags. |
abstract void |
setKeyInteger(int keyInteger)
Simple key: integer value |
abstract void |
setKeyInteger(java.lang.Integer keyInteger)
Simple key: integer value |
abstract void |
setKeyKVList(KeyValueCollection keyKVList)
KVList key |
abstract void |
setKeyLong(int keyLong)
Simple key: unsigned long value |
abstract void |
setKeyLong(java.lang.Integer keyLong)
Simple key: unsigned long value |
abstract void |
setKeyString(java.lang.String keyString)
Simple key: string value |
abstract void |
setLogParameters(KeyValueCollection logParameters)
|
abstract void |
setMessageGuid1(int messageGuid1)
Message GUID - Data1 member. |
abstract void |
setMessageGuid1(java.lang.Integer messageGuid1)
Message GUID - Data1 member. |
abstract void |
setMessageGuid2(int messageGuid2)
Message GUID - Data2 member |
abstract void |
setMessageGuid2(java.lang.Integer messageGuid2)
Message GUID - Data2 member |
abstract void |
setMessageGuid3(int messageGuid3)
Message GUID - Data3 member |
abstract void |
setMessageGuid3(java.lang.Integer messageGuid3)
Message GUID - Data3 member |
abstract void |
setMessageGuid4(byte[] messageGuid4)
Message GUID - Data4 member |
abstract void |
setMessageType(MessageTypes messageType)
The message type. |
abstract void |
setOrigin(int origin)
Origin of the message (ID of an application) |
abstract void |
setOrigin(java.lang.Integer origin)
Origin of the message (ID of an application) |
abstract void |
setPriority(MessagePriority priority)
Priority of the message |
abstract void |
setSubscriberType(int subscriberType)
Subscription: Type of the message to subscribe to |
abstract void |
setSubscriberType(java.lang.Integer subscriberType)
Subscription: Type of the message to subscribe to |
abstract void |
setTime(java.util.Date time)
Note that server sends this value in UTC format always. |
abstract void |
setTimeGenerated(long timeGenerated)
The time when message was generated by supplier |
abstract void |
setTimeGenerated(java.lang.Long timeGenerated)
The time when message was generated by supplier |
abstract void |
setUsec(int usec)
|
abstract void |
setUsec(java.lang.Integer usec)
|
abstract void |
setUserData(KeyValueCollection userData)
Attached data packed in TKVList |
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static EventSubscription create()
public static EventSubscription create(MessageTypes messageType, MessagePriority priority, java.lang.Integer origin, java.util.Date time, java.lang.Integer usec, java.lang.Integer subscriberType, java.lang.Integer attachedDataLength, byte[] attachedData, KeyValueCollection userData, java.lang.Long timeGenerated, KeyValueCollection logParameters, java.lang.Integer messageGuid2, java.lang.Integer messageGuid3, byte[] messageGuid4, java.lang.Integer keyFlags, java.lang.Integer keyInteger, java.lang.Integer keyLong, java.lang.String keyString, KeyValueCollection keyKVList)
messageType
- Type of the messagepriority
- Priority of the messageorigin
- Origin of the message (ID of an application)time
- Note that server sends this value in UTC format always.usec
- UsecsubscriberType
- Subscription: Type of the message to subscribe toattachedDataLength
- Length of the attached dataattachedData
- Any data attached to the messageuserData
- Attached data packed in TKVListtimeGenerated
- The time when message was generated by supplierlogParameters
- LogParametersmessageGuid2
- Message GUID - Data2 membermessageGuid3
- Message GUID - Data3 membermessageGuid4
- Message GUID - Data4 memberkeyFlags
- Simple key: flags. Can be any combination of KeyFlags enum values (using bitwise OR operator '|')keyInteger
- Simple key: integer valuekeyLong
- Simple key: unsigned long valuekeyString
- Simple key: string valuekeyKVList
- KVList key
public abstract MessageTypes getMessageType()
public abstract void setMessageType(MessageTypes messageType)
public abstract MessagePriority getPriority()
public abstract void setPriority(MessagePriority priority)
priority
- new value of the propertypublic abstract java.lang.Integer getOrigin()
public abstract void setOrigin(java.lang.Integer origin)
origin
- new value of the propertypublic abstract void setOrigin(int origin)
origin
- new value of the propertypublic abstract java.util.Date getTime()
public abstract void setTime(java.util.Date time)
time
- new value of the propertypublic abstract java.lang.Integer getUsec()
public abstract void setUsec(java.lang.Integer usec)
public abstract void setUsec(int usec)
public abstract java.lang.Integer getSubscriberType()
public abstract void setSubscriberType(java.lang.Integer subscriberType)
subscriberType
- new value of the propertypublic abstract void setSubscriberType(int subscriberType)
subscriberType
- new value of the propertypublic abstract java.lang.Integer getAttachedDataLength()
public abstract void setAttachedDataLength(java.lang.Integer attachedDataLength)
attachedDataLength
- new value of the propertypublic abstract void setAttachedDataLength(int attachedDataLength)
attachedDataLength
- new value of the propertypublic abstract byte[] getAttachedData()
public abstract void setAttachedData(byte[] attachedData)
attachedData
- new value of the propertypublic abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
userData
- new value of the propertypublic abstract java.lang.Long getTimeGenerated()
public abstract void setTimeGenerated(java.lang.Long timeGenerated)
timeGenerated
- new value of the propertypublic abstract void setTimeGenerated(long timeGenerated)
timeGenerated
- new value of the propertypublic abstract KeyValueCollection getLogParameters()
public abstract void setLogParameters(KeyValueCollection logParameters)
public abstract java.lang.Integer getMessageGuid1()
public abstract void setMessageGuid1(java.lang.Integer messageGuid1)
messageGuid1
- new value of the propertypublic abstract void setMessageGuid1(int messageGuid1)
messageGuid1
- new value of the propertypublic abstract java.lang.Integer getMessageGuid2()
public abstract void setMessageGuid2(java.lang.Integer messageGuid2)
messageGuid2
- new value of the propertypublic abstract void setMessageGuid2(int messageGuid2)
messageGuid2
- new value of the propertypublic abstract java.lang.Integer getMessageGuid3()
public abstract void setMessageGuid3(java.lang.Integer messageGuid3)
messageGuid3
- new value of the propertypublic abstract void setMessageGuid3(int messageGuid3)
messageGuid3
- new value of the propertypublic abstract byte[] getMessageGuid4()
public abstract void setMessageGuid4(byte[] messageGuid4)
messageGuid4
- new value of the propertypublic abstract java.lang.Integer getKeyFlags()
KeyFlags
public abstract void setKeyFlags(java.lang.Integer keyFlags)
KeyFlags
public abstract void setKeyFlags(int keyFlags)
KeyFlags
public abstract java.lang.Integer getKeyInteger()
public abstract void setKeyInteger(java.lang.Integer keyInteger)
keyInteger
- new value of the propertypublic abstract void setKeyInteger(int keyInteger)
keyInteger
- new value of the propertypublic abstract java.lang.Integer getKeyLong()
public abstract void setKeyLong(java.lang.Integer keyLong)
keyLong
- new value of the propertypublic abstract void setKeyLong(int keyLong)
keyLong
- new value of the propertypublic abstract java.lang.String getKeyString()
public abstract void setKeyString(java.lang.String keyString)
keyString
- new value of the propertypublic abstract KeyValueCollection getKeyKVList()
public abstract void setKeyKVList(KeyValueCollection keyKVList)
keyKVList
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |