- com
- pcbsys
- nirvana
- client
- nEventAttributes
The nEventAttributes class is used by the nConsumeEvent object in order to store standard header values associated with nirvana client and JMS events. More...
Public Member Functions | |
boolean | allowMerging () |
If this flag is true, the event will be merged with the existing event on this Channel / Data Group. More... | |
byte[] | getApplicationId () |
Obtain the application id allocated to the event. More... | |
Object | getAttribute (String attrName) |
Return the corresponding attribute value. More... | |
Iterator | getAttributeNames () |
Obtain an iterator containing String representations of each attribute name. More... | |
Enumeration | getAttributeNamesEnumeration () |
Obtain an Enumeration containing String representations of each attribute name. More... | |
byte[] | getCorrelationId () |
Obtain the correlation id allocated to the event (JMS specific) More... | |
long | getDeadEID () |
Obtain the id associated with the dead event, if the event is consumed from a stores used as a dead event store. More... | |
byte[] | getDeadEventChannel () |
Obtain the dead event store name allocated to the event if one exists. More... | |
byte | getDeliveryMode () |
Obtain the delivery mode used for this event. More... | |
byte[] | getDestination () |
Obtain the destination allocated to the event. More... | |
long | getExpiration () |
Obtain the expiration value allocated to the event. More... | |
byte[] | getJoinChannel () |
Obtain the join channel allocated to the event if the event was originally published via a channel join. More... | |
long | getJoinEID () |
Obtain the eid of the original event from the join channel. More... | |
byte[] | getJoinPath () |
Obtain the join path allocated to the event as it travels through the joined channels if the event was originally published via a channel join. More... | |
byte[] | getJoinRealm () |
Obtain the realm on which the join channel exists if the event was originally published via a channel join. More... | |
byte[] | getMessageId () |
Obtain the message id allocated to the event (JMS specific) More... | |
byte | getMessageType () |
Obtain the type of the event. More... | |
byte | getPriority () |
Obtain the priority allocated to the event. More... | |
byte[] | getPublisherHost () |
Obtain the publisher host allocated to the event. More... | |
byte[] | getPublisherName () |
Obtain the publisher name allocated to the event. More... | |
int | getRedeliveredCount () |
Obtain the number of times the event has been redelivered. More... | |
byte[] | getReplyToName () |
Obtain the reply to name allocated to the event. More... | |
byte | getReplyType () |
Obtain the reply type represented as a byte value. More... | |
byte[] | getSubscriberHost () |
Obtain the subscriber host allocated to the event. More... | |
int | getSubscriberId () |
Obtain the subscriber id allocated to the event. More... | |
byte[] | getSubscriberName () |
Obtain the subscriber name allocated to the event. More... | |
long | getTimestamp () |
Obtain the timestamp allocated to the event. More... | |
byte[] | getType () |
Obtain the arbitrary value given to this event to represent it's type. More... | |
byte[] | getUserId () |
Obtain the user id allocated to the event. More... | |
boolean | isDelta () |
Indicates if this event is a delta event. More... | |
boolean | isRedelivered () |
Obtain whether this event has been redelivered. More... | |
boolean | isRegistered () |
Indicates if this event was created by a nRegisteredEvent. More... | |
nEventAttributes () | |
Generate a new nEventAttributes object. | |
void | setAllowMerge (boolean flag) |
Sets whether this event can be merged at the server for the Channel or Data Groups. More... | |
void | setApplicationId (byte[] myApplicationId) |
Set the application id given to this event. More... | |
void | setCorrelationId (byte[] myCorrelationId) |
Set the event correlation id (JMS specific) More... | |
void | setDeliveryMode (byte myDeliveryMode) |
Set the delivery mode. More... | |
void | setDestination (byte[] myDestination) |
Set the destination given to this event. More... | |
void | setExpiration (long myExpiration) |
Set the event expiration value. More... | |
void | setMessageId (byte[] myMessageId) |
Set the event message id (JMS specific) More... | |
void | setMessageType (byte myMessageType) |
Set the event type. More... | |
void | setPriority (byte myPriority) |
Set the event priority. More... | |
void | setPublisherHost (byte[] myPubHost) |
Set the publisher host value given to this event. More... | |
void | setPublisherName (byte[] myPubName) |
Set the publisher name given to this event. More... | |
void | setReplyToName (byte[] myReplyToName) |
Set the reply to name given to this event. More... | |
void | setReplyType (byte myReplyType) |
Set the reply type. More... | |
void | setSubscriberHost (byte[] mySubHost) |
Set the subscriber host value given to this event. More... | |
void | setSubscriberId (int mySubId) |
Set the subscriber id given to this event. More... | |
void | setSubscriberName (byte[] mySubName) |
Set the subscriber name given to this event. More... | |
void | setSubscriberNames (String[] mySubName) throws nIllegalArgumentException |
Set the subscriber names given to this event. More... | |
void | setType (byte[] myType) |
Set the arbitrary event type given to this event. More... | |
void | setUserId (byte[] myUserId) |
Set the user id given to this event. More... | |
Static Public Attributes | |
static final byte | JMS_BASE_MESSAGE_TYPE = com.pcbsys.nirvana.base.nConstants.JMS_BASE_MESSAGE_TYPE |
Specifies a message type for event of JMS base Message Impl. | |
static final byte | JMS_BYTES_MESSAGE_TYPE = com.pcbsys.nirvana.base.nConstants.JMS_BYTES_MESSAGE_TYPE |
Specifies a message type for event of JMS BytesMessage. | |
static final byte | JMS_MAP_MESSAGE_TYPE = com.pcbsys.nirvana.base.nConstants.JMS_MAP_MESSAGE_TYPE |
Specifies a message type for event of JMS MapMessage. | |
static final byte | JMS_OBJECT_MESSAGE_TYPE = com.pcbsys.nirvana.base.nConstants.JMS_OBJECT_MESSAGE_TYPE |
Specifies a message type for event of JMS ObjectMessage. | |
static final byte | JMS_STREAM_MESSAGE_TYPE = com.pcbsys.nirvana.base.nConstants.JMS_STREAM_MESSAGE_TYPE |
Specifies a message type for event of JMS StreamMessage. | |
static final byte | JMS_TEXT_MESSAGE_TYPE = com.pcbsys.nirvana.base.nConstants.JMS_TEXT_MESSAGE_TYPE |
Specifies a message type for event of JMS TextMessage. | |
The nEventAttributes class is used by the nConsumeEvent object in order to store standard header values associated with nirvana client and JMS events.
Not all vallues are set all the time. Some values are only set by the realm server, whereas other values are available to be programatically set.
The majority of values are specific to JMS Message headers, and as such would not be required to be used by a standard nConsumeEvent
boolean com.pcbsys.nirvana.client.nEventAttributes.allowMerging | ( | ) |
If this flag is true, the event will be merged with the existing event on this Channel / Data Group.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getApplicationId | ( | ) |
Obtain the application id allocated to the event.
Object com.pcbsys.nirvana.client.nEventAttributes.getAttribute | ( | String | attrName | ) |
Return the corresponding attribute value.
attrName | the name of the attribute you are looking for |
Iterator com.pcbsys.nirvana.client.nEventAttributes.getAttributeNames | ( | ) |
Obtain an iterator containing String representations of each attribute name.
Enumeration com.pcbsys.nirvana.client.nEventAttributes.getAttributeNamesEnumeration | ( | ) |
Obtain an Enumeration containing String representations of each attribute name.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getCorrelationId | ( | ) |
Obtain the correlation id allocated to the event (JMS specific)
long com.pcbsys.nirvana.client.nEventAttributes.getDeadEID | ( | ) |
Obtain the id associated with the dead event, if the event is consumed from a stores used as a dead event store.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getDeadEventChannel | ( | ) |
Obtain the dead event store name allocated to the event if one exists.
byte com.pcbsys.nirvana.client.nEventAttributes.getDeliveryMode | ( | ) |
Obtain the delivery mode used for this event.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getDestination | ( | ) |
Obtain the destination allocated to the event.
long com.pcbsys.nirvana.client.nEventAttributes.getExpiration | ( | ) |
Obtain the expiration value allocated to the event.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getJoinChannel | ( | ) |
Obtain the join channel allocated to the event if the event was originally published via a channel join.
long com.pcbsys.nirvana.client.nEventAttributes.getJoinEID | ( | ) |
Obtain the eid of the original event from the join channel.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getJoinPath | ( | ) |
Obtain the join path allocated to the event as it travels through the joined channels if the event was originally published via a channel join.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getJoinRealm | ( | ) |
Obtain the realm on which the join channel exists if the event was originally published via a channel join.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getMessageId | ( | ) |
Obtain the message id allocated to the event (JMS specific)
byte com.pcbsys.nirvana.client.nEventAttributes.getMessageType | ( | ) |
Obtain the type of the event.
byte com.pcbsys.nirvana.client.nEventAttributes.getPriority | ( | ) |
Obtain the priority allocated to the event.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getPublisherHost | ( | ) |
Obtain the publisher host allocated to the event.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getPublisherName | ( | ) |
Obtain the publisher name allocated to the event.
int com.pcbsys.nirvana.client.nEventAttributes.getRedeliveredCount | ( | ) |
Obtain the number of times the event has been redelivered.
Only relevant for events delivered on queues
byte [] com.pcbsys.nirvana.client.nEventAttributes.getReplyToName | ( | ) |
Obtain the reply to name allocated to the event.
byte com.pcbsys.nirvana.client.nEventAttributes.getReplyType | ( | ) |
Obtain the reply type represented as a byte value.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getSubscriberHost | ( | ) |
Obtain the subscriber host allocated to the event.
int com.pcbsys.nirvana.client.nEventAttributes.getSubscriberId | ( | ) |
Obtain the subscriber id allocated to the event.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getSubscriberName | ( | ) |
Obtain the subscriber name allocated to the event.
long com.pcbsys.nirvana.client.nEventAttributes.getTimestamp | ( | ) |
Obtain the timestamp allocated to the event.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getType | ( | ) |
Obtain the arbitrary value given to this event to represent it's type.
byte [] com.pcbsys.nirvana.client.nEventAttributes.getUserId | ( | ) |
Obtain the user id allocated to the event.
boolean com.pcbsys.nirvana.client.nEventAttributes.isDelta | ( | ) |
Indicates if this event is a delta event.
boolean com.pcbsys.nirvana.client.nEventAttributes.isRedelivered | ( | ) |
Obtain whether this event has been redelivered.
Only relevant for events delivered on queues
boolean com.pcbsys.nirvana.client.nEventAttributes.isRegistered | ( | ) |
Indicates if this event was created by a nRegisteredEvent.
void com.pcbsys.nirvana.client.nEventAttributes.setAllowMerge | ( | boolean | flag | ) |
Sets whether this event can be merged at the server for the Channel or Data Groups.
flag | true to permit the merge, false if not |
void com.pcbsys.nirvana.client.nEventAttributes.setApplicationId | ( | byte[] | myApplicationId | ) |
Set the application id given to this event.
myApplicationId | the byte array value representing the application id of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setCorrelationId | ( | byte[] | myCorrelationId | ) |
Set the event correlation id (JMS specific)
myCorrelationId | the byte array value representing the correlation id of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setDeliveryMode | ( | byte | myDeliveryMode | ) |
Set the delivery mode.
myDeliveryMode | the byte value representing the delivery mode |
void com.pcbsys.nirvana.client.nEventAttributes.setDestination | ( | byte[] | myDestination | ) |
Set the destination given to this event.
myDestination | the byte array value representing the destination used by the event |
void com.pcbsys.nirvana.client.nEventAttributes.setExpiration | ( | long | myExpiration | ) |
Set the event expiration value.
myExpiration | the long value representing the expiration of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setMessageId | ( | byte[] | myMessageId | ) |
Set the event message id (JMS specific)
myMessageId | the byte array value representing the message id of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setMessageType | ( | byte | myMessageType | ) |
Set the event type.
myMessageType | the byte value representing the type of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setPriority | ( | byte | myPriority | ) |
Set the event priority.
myPriority | the byte value representing the priority |
void com.pcbsys.nirvana.client.nEventAttributes.setPublisherHost | ( | byte[] | myPubHost | ) |
Set the publisher host value given to this event.
myPubHost | the byte array value representing the publisher host of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setPublisherName | ( | byte[] | myPubName | ) |
Set the publisher name given to this event.
myPubName | the byte array value representing the publisher name of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setReplyToName | ( | byte[] | myReplyToName | ) |
Set the reply to name given to this event.
myReplyToName | the byte array value representing the reply to name of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setReplyType | ( | byte | myReplyType | ) |
Set the reply type.
myReplyType | the byte representation of the reply type |
void com.pcbsys.nirvana.client.nEventAttributes.setSubscriberHost | ( | byte[] | mySubHost | ) |
Set the subscriber host value given to this event.
mySubHost | the byte array value representing the subscriber host of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setSubscriberId | ( | int | mySubId | ) |
Set the subscriber id given to this event.
mySubId | the byte array value representing the subscriber id of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setSubscriberName | ( | byte[] | mySubName | ) |
Set the subscriber name given to this event.
mySubName | the byte array value representing the subscriber name of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setSubscriberNames | ( | String[] | mySubName | ) | throws nIllegalArgumentException |
Set the subscriber names given to this event.
mySubName | the string array value representing the subscriber names of the event |
nIllegalArgumentException | if mySubName greater than 32767 |
void com.pcbsys.nirvana.client.nEventAttributes.setType | ( | byte[] | myType | ) |
Set the arbitrary event type given to this event.
myType | the byte array value representing the type of the event |
void com.pcbsys.nirvana.client.nEventAttributes.setUserId | ( | byte[] | myUserId | ) |
Set the user id given to this event.
myUserId | the byte array value representing the user id of the event |