com.pcbsys.nirvana.client.nEventAttributes

Package	com.pcbsys.nirvana.client
Class	public class nEventAttributes
Inheritance	nEventAttributes Object

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

Public Properties

	Property		Defined By
		applicationId : ByteArray Obtain the application id allocated to the event	nEventAttributes
		correlationId : ByteArray Obtain the correlation id allocated to the event (JMS specific)	nEventAttributes
		deadEID : Long [read-only] Obtain the id associated with the dead event, if the event is consumed from a stores used as a dead event store	nEventAttributes
		deadEventStore : ByteArray [read-only] Obtain the dead event store name allocated to the event if one exists	nEventAttributes
		deliveryMode : int Obtain the delivery mode used for this event	nEventAttributes
		destination : ByteArray Obtain the destination allocated to the event	nEventAttributes
		expiration : Long Obtain the expiration value allocated to the event	nEventAttributes
		isDelta : Boolean [read-only] Indicates if this event is a delta event	nEventAttributes
		isRegistered : Boolean [read-only] Indicates if this event was created by a nRegisteredEvent	nEventAttributes
		joinChannel : ByteArray [read-only] Obtain the join channel allocated to the event if the event was originally published via a channel join	nEventAttributes
		joinChannelInternal : ByteArray [write-only]	nEventAttributes
		joinEID : Long [read-only] Obtain the eid of the original event from the join channel	nEventAttributes
		joinPath : ByteArray [read-only] 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	nEventAttributes
		joinRealm : ByteArray [read-only] Obtain the realm on which the join channel exists if the event was originally published via a channel join	nEventAttributes
		messageId : ByteArray Obtain the message id allocated to the event (JMS specific)	nEventAttributes
		messageType : int Obtain the type of the event	nEventAttributes
		priority : int Obtain the priority allocated to the event	nEventAttributes
		publisherHost : ByteArray Obtain the publisher host allocated to the event	nEventAttributes
		publisherName : ByteArray Obtain the publisher name allocated to the event	nEventAttributes
		redelivered : Boolean [read-only] Obtain whether this event has been redelivered.	nEventAttributes
		redeliveredCount : int [read-only] Obtain the number of times the event has been redelivered.	nEventAttributes
		replyToName : ByteArray Obtain the reply to name allocated to the event	nEventAttributes
		replyType : int Obtain the reply type represented as a int value	nEventAttributes
		subscriberHost : ByteArray Obtain the subscriber host allocated to the event	nEventAttributes
		subscriberId : int Obtain the subscriber id allocated to the event	nEventAttributes
		subscriberName : ByteArray Obtain the subscriber name allocated to the event	nEventAttributes
		timestamp : Long [read-only] Obtain the timestamp allocated to the event	nEventAttributes
		timestampInt : Long [write-only]	nEventAttributes
		type : ByteArray Obtain the arbitrary value given to this event to represent it's type	nEventAttributes
		userId : ByteArray Obtain the user id allocated to the event	nEventAttributes

Public Methods

	Method		Defined By
		nEventAttributes() Generate a new nEventAttributes object	nEventAttributes

Property Detail

applicationId

property

applicationId:ByteArray

Obtain the application id allocated to the event

Implementation
public function get applicationId():ByteArray
public function set applicationId(value:ByteArray):void

correlationId

property

correlationId:ByteArray

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

Implementation
public function get correlationId():ByteArray
public function set correlationId(value:ByteArray):void

deadEID

property

deadEID:Long [read-only]

Obtain the id associated with the dead event, if the event is consumed from a stores used as a dead event store

Implementation
public function get deadEID():Long

deadEventStore

property

deadEventStore:ByteArray [read-only]

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

Implementation
public function get deadEventStore():ByteArray

deliveryMode

property

deliveryMode:int

Obtain the delivery mode used for this event

Implementation
public function get deliveryMode():int
public function set deliveryMode(value:int):void

destination

property

destination:ByteArray

Obtain the destination allocated to the event

Implementation
public function get destination():ByteArray
public function set destination(value:ByteArray):void

expiration

property

expiration:Long

Obtain the expiration value allocated to the event

Implementation
public function get expiration():Long
public function set expiration(value:Long):void

isDelta

property

isDelta:Boolean [read-only]

Indicates if this event is a delta event

Implementation
public function get isDelta():Boolean

isRegistered

property

isRegistered:Boolean [read-only]

Indicates if this event was created by a nRegisteredEvent

Implementation
public function get isRegistered():Boolean

joinChannel

property

joinChannel:ByteArray [read-only]

Obtain the join channel allocated to the event if the event was originally published via a channel join

Implementation
public function get joinChannel():ByteArray

joinChannelInternal

property

joinChannelInternal:ByteArray [write-only]

Implementation
public function set joinChannelInternal(value:ByteArray):void

joinEID

property

joinEID:Long [read-only]

Obtain the eid of the original event from the join channel

Implementation
public function get joinEID():Long

joinPath

property

joinPath:ByteArray [read-only]

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

Implementation
public function get joinPath():ByteArray

joinRealm

property

joinRealm:ByteArray [read-only]

Obtain the realm on which the join channel exists if the event was originally published via a channel join

Implementation
public function get joinRealm():ByteArray

messageId

property

messageId:ByteArray

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

Implementation
public function get messageId():ByteArray
public function set messageId(value:ByteArray):void

messageType

property

messageType:int

Obtain the type of the event

Implementation
public function get messageType():int
public function set messageType(value:int):void

priority

property

priority:int

Obtain the priority allocated to the event

Implementation
public function get priority():int
public function set priority(value:int):void

publisherHost

property

publisherHost:ByteArray

Obtain the publisher host allocated to the event

Implementation
public function get publisherHost():ByteArray
public function set publisherHost(value:ByteArray):void

publisherName

property

publisherName:ByteArray

Obtain the publisher name allocated to the event

Implementation
public function get publisherName():ByteArray
public function set publisherName(value:ByteArray):void

redelivered

property

redelivered:Boolean [read-only]

Obtain whether this event has been redelivered. Only relevant for events delivered on queues

Implementation
public function get redelivered():Boolean

redeliveredCount

property

redeliveredCount:int [read-only]

Obtain the number of times the event has been redelivered. Only relevant for events delivered on queues

Implementation
public function get redeliveredCount():int

replyToName

property

replyToName:ByteArray

Obtain the reply to name allocated to the event

Implementation
public function get replyToName():ByteArray
public function set replyToName(value:ByteArray):void

replyType

property

replyType:int

Obtain the reply type represented as a int value

Implementation
public function get replyType():int
public function set replyType(value:int):void

subscriberHost

property

subscriberHost:ByteArray

Obtain the subscriber host allocated to the event

Implementation
public function get subscriberHost():ByteArray
public function set subscriberHost(value:ByteArray):void

subscriberId

property

subscriberId:int

Obtain the subscriber id allocated to the event

Implementation
public function get subscriberId():int
public function set subscriberId(value:int):void

subscriberName

property

subscriberName:ByteArray

Obtain the subscriber name allocated to the event

Implementation
public function get subscriberName():ByteArray
public function set subscriberName(value:ByteArray):void

timestamp

property

timestamp:Long [read-only]

Obtain the timestamp allocated to the event

Implementation
public function get timestamp():Long

timestampInt

property

timestampInt:Long [write-only]

Implementation
public function set timestampInt(value:Long):void

type

property

type:ByteArray

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

Implementation
public function get type():ByteArray
public function set type(value:ByteArray):void

userId

property

userId:ByteArray

Obtain the user id allocated to the event

Implementation
public function get userId():ByteArray
public function set userId(value:ByteArray):void

Constructor Detail

nEventAttributes

()

Constructor

public function nEventAttributes()

Generate a new nEventAttributes object