com.pcbsys.nirvana.client.nEventAttributes Class Reference

The nEventAttributes class is used by the nConsumeEvent object in order to store standard header values associated with nirvana client, p2p and JMS events. More...


Public Member Functions

bool allowMerging ()
 If this flag is true, the event will be merged with the existing event on this Channel / Data Group.
byte[] getApplicationId ()
 Obtain the application id allocated to the event.
byte[] getCorrelationId ()
 Obtain the correlation id allocated to the event (JMS specific).
long getDeadEID ()
 Obtain the id associated with the dead event, if the event is consumed from a stores used as a dead event store.
byte[] getDeadEventChannel ()
 Obtain the dead event store name allocated to the event if one exists.
byte getDeliveryMode ()
 Obtain the delivery mode used for this event.
byte[] getDestination ()
 Obtain the destination allocated to the event.
long getExpiration ()
 Obtain the expiration value allocated to the event.
byte[] getJoinChannel ()
 Obtain the join channel allocated to the event if the event was originally published via a channel join.
long getJoinEID ()
 Obtain the eid of the original event from the join channel.
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.
byte[] getJoinRealm ()
 Obtain the realm on which the join channel exists if the event was originally published via a channel join.
byte[] getMessageId ()
 Obtain the message id allocated to the event (JMS specific).
sbyte getMessageType ()
 Obtain the type of the event.
byte getPriority ()
 Obtain the priority allocated to the event.
byte[] getPublisherHost ()
 Obtain the publisher host allocated to the event.
byte[] getPublisherName ()
 Obtain the publisher name allocated to the event.
int getRedeliveredCount ()
 Obtain the number of times the event has been redelivered.
byte[] getReplyToName ()
 Obtain the reply to name allocated to the event.
byte getReplyType ()
 Obtain the reply type represented as a byte value.
byte[] getSubscriberHost ()
 Obtain the subscriber host allocated to the event.
int getSubscriberId ()
 Obtain the subscriber id allocated to the event.
byte[] getSubscriberName ()
 Obtain the subscriber name allocated to the event.
long getTimestamp ()
 Obtain the time stamp allocated to the event.
byte[] getType ()
 Obtain the arbitrary value given to this event to represent it's type.
byte[] getUserId ()
 Obtain the user id allocated to the event.
bool isDelta ()
 Indicates if this event is a delta event.
bool isRedelivered ()
 Obtain whether this event has been redelivered.
bool isRegistered ()
 Indicates if this event was created by a nRegisteredEvent.
 nEventAttributes ()
 Generate a new nEventAttributes object.
void setAllowMerge (bool flag)
 Sets whether this event can be merged at the server for the Channel or Data Groups.
void setApplicationId (byte[] myApplicationId)
 Set the application id given to this event.
void setCorrelationId (byte[] myCorrelationId)
 Set the event correlation id (JMS specific).
void setDeliveryMode (byte myDeliveryMode)
 Set the delivery mode.
void setDestination (byte[] myDestination)
 Set the destination given to this event.
void setExpiration (long myExpiration)
 Set the event expiration value.
void setMessageId (byte[] myMessageId)
 Set the event message id (JMS specific).
void setMessageType (sbyte myMessageType)
 Set the event type.
void setPriority (byte myPriority)
 Set the event priority.
void setPublisherHost (byte[] myPubHost)
 Set the publisher host value given to this event.
void setPublisherName (byte[] myPubName)
 Set the publisher name given to this event.
void setReplyToName (byte[] myReplyToName)
 Set the reply to name given to this event.
void setReplyType (byte myReplyType)
 Set the reply type.
void setSubscriberHost (byte[] mySubHost)
 Set the subscriber host value given to this event.
void setSubscriberId (int mySubId)
 Set the subscriber id given to this event.
void setSubscriberName (byte[] mySubName)
 Set the subscriber name given to this event.
void setSubscriberNames (string[] mySubName)
 Set the subscriber names given to this event.
void setType (byte[] myType)
 Set the arbitrary event type given to this event.
void setUserId (byte[] myUserId)
 Set the user id given to this event.

Detailed Description

The nEventAttributes class is used by the nConsumeEvent object in order to store standard header values associated with nirvana client, p2p and JMS events.

Not all values 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

Member Function Documentation

bool 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.

Returns:
if event can be merged

byte [] com.pcbsys.nirvana.client.nEventAttributes.getApplicationId (  ) 

Obtain the application id allocated to the event.

Returns:
the application id represented as a byte array value

byte [] com.pcbsys.nirvana.client.nEventAttributes.getCorrelationId (  ) 

Obtain the correlation id allocated to the event (JMS specific).

Returns:
the correlation id represented as a byte array value

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.

Returns:
the dead event id

byte [] com.pcbsys.nirvana.client.nEventAttributes.getDeadEventChannel (  ) 

Obtain the dead event store name allocated to the event if one exists.

Returns:
the dead event store used by the channel from which this event came represented as a byte array value

byte com.pcbsys.nirvana.client.nEventAttributes.getDeliveryMode (  ) 

Obtain the delivery mode used for this event.

Returns:
the byte value that represents the delivery mode

byte [] com.pcbsys.nirvana.client.nEventAttributes.getDestination (  ) 

Obtain the destination allocated to the event.

Returns:
the destination represented as a byte array value

long com.pcbsys.nirvana.client.nEventAttributes.getExpiration (  ) 

Obtain the expiration value allocated to the event.

Returns:
the expiration represented as a long value

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.

Returns:
the joined channel represented as a byte array value

long com.pcbsys.nirvana.client.nEventAttributes.getJoinEID (  ) 

Obtain the eid of the original event from the join channel.

Returns:
the eid of the event from the joined channel represented as a long value

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.

Returns:
the join path of the event, represented as a byte array value

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.

Returns:
the joined channel's realm represented as a byte array value

byte [] com.pcbsys.nirvana.client.nEventAttributes.getMessageId (  ) 

Obtain the message id allocated to the event (JMS specific).

Returns:
the message id represented as a byte array value

sbyte com.pcbsys.nirvana.client.nEventAttributes.getMessageType (  ) 

Obtain the type of the event.

Returns:
the type represented as a byte value

byte com.pcbsys.nirvana.client.nEventAttributes.getPriority (  ) 

Obtain the priority allocated to the event.

Returns:
the priority represented as a byte value

byte [] com.pcbsys.nirvana.client.nEventAttributes.getPublisherHost (  ) 

Obtain the publisher host allocated to the event.

Returns:
the publisher host represented as a byte array value

byte [] com.pcbsys.nirvana.client.nEventAttributes.getPublisherName (  ) 

Obtain the publisher name allocated to the event.

Returns:
the publisher name represented as a byte array value

int com.pcbsys.nirvana.client.nEventAttributes.getRedeliveredCount (  ) 

Obtain the number of times the event has been redelivered.

Only relevant for events delivered on queues

Returns:
the number of times the event has been redelivered via the queue

byte [] com.pcbsys.nirvana.client.nEventAttributes.getReplyToName (  ) 

Obtain the reply to name allocated to the event.

Returns:
the reply to name represented as a byte array value

byte com.pcbsys.nirvana.client.nEventAttributes.getReplyType (  ) 

Obtain the reply type represented as a byte value.

Returns:
the reply type

byte [] com.pcbsys.nirvana.client.nEventAttributes.getSubscriberHost (  ) 

Obtain the subscriber host allocated to the event.

Returns:
the subscriber host represented as a byte array value

int com.pcbsys.nirvana.client.nEventAttributes.getSubscriberId (  ) 

Obtain the subscriber id allocated to the event.

Returns:
the subscriber id represented as an int value

byte [] com.pcbsys.nirvana.client.nEventAttributes.getSubscriberName (  ) 

Obtain the subscriber name allocated to the event.

Returns:
the subscriber name represented as a byte array value

long com.pcbsys.nirvana.client.nEventAttributes.getTimestamp (  ) 

Obtain the time stamp allocated to the event.

Returns:
the time stamp represented as a long value

byte [] com.pcbsys.nirvana.client.nEventAttributes.getType (  ) 

Obtain the arbitrary value given to this event to represent it's type.

Returns:
the message type represented as a byte array value

byte [] com.pcbsys.nirvana.client.nEventAttributes.getUserId (  ) 

Obtain the user id allocated to the event.

Returns:
the user id represented as a byte array value

bool com.pcbsys.nirvana.client.nEventAttributes.isDelta (  ) 

Indicates if this event is a delta event.

Returns:
true if this event is a delta derived from a registered event update, false if the event is a full event (snapshot)

bool com.pcbsys.nirvana.client.nEventAttributes.isRedelivered (  ) 

Obtain whether this event has been redelivered.

Only relevant for events delivered on queues

Returns:
if the event has already been delivered via the queue

bool com.pcbsys.nirvana.client.nEventAttributes.isRegistered (  ) 

Indicates if this event was created by a nRegisteredEvent.

Returns:
true if this event comes from a nRegisteredEvent

void com.pcbsys.nirvana.client.nEventAttributes.setAllowMerge ( bool  flag  ) 

Sets whether this event can be merged at the server for the Channel or Data Groups.

Parameters:
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.

Parameters:
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).

Parameters:
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.

Parameters:
myDeliveryMode the byte value representing the delivery mode

void com.pcbsys.nirvana.client.nEventAttributes.setDestination ( byte[]  myDestination  ) 

Set the destination given to this event.

Parameters:
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.

Parameters:
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).

Parameters:
myMessageId the byte array value representing the message id of the event

void com.pcbsys.nirvana.client.nEventAttributes.setMessageType ( sbyte  myMessageType  ) 

Set the event type.

Parameters:
myMessageType the byte value representing the type of the event

void com.pcbsys.nirvana.client.nEventAttributes.setPriority ( byte  myPriority  ) 

Set the event priority.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
mySubName the byte array value representing the subscriber name of the event

void com.pcbsys.nirvana.client.nEventAttributes.setSubscriberNames ( string[]  mySubName  ) 

Set the subscriber names given to this event.

Parameters:
mySubName the byte string value representing the subscriber names of the event

void com.pcbsys.nirvana.client.nEventAttributes.setType ( byte[]  myType  ) 

Set the arbitrary event type given to this event.

Parameters:
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.

Parameters:
myUserId the byte array value representing the user id of the event