com.pcbsys.nirvana.base.nHeader Class Reference

This class represents a message Header. More...

Inherits fExternalable, fMissingKeyHandler, and Cloneable.

Public Member Functions
byte[]	getApplicationId ()
	Get the Application ID. More...
byte[]	getCorrelationId ()
	Get the Correlation ID. More...
byte	getDeliveryMode ()
	Get the delivery mode. More...
byte[]	getDestination ()
	Get the Message Destination. More...
fEventDictionary	getDictionary ()
	Returns the event Dictionary. More...
long	getExpiration ()
	Get the message expiration. More...
byte[]	getMessageId ()
	Get the Message ID. More...
byte	getMessageType ()
	Get the message type. More...
byte	getPriority ()
	Get the message Priority. More...
byte[]	getPubHost ()
	Get the Publish Host. More...
byte[]	getPubName ()
	Get the Publisher Name. More...
int	getRedeliveredCount ()
	Get the Redelivered Count. More...
byte[]	getReplyToName ()
	Get the Reply To Name. More...
long	getTimestamp ()
	Returns the event timestamp. More...
long	getTTL ()
	Get the message TTL. More...
byte[]	getUserId ()
	Get the User ID. More...
boolean	isRedelivered ()
	Check if the message has been redelivered. More...
	nHeader ()
	Default Constructor.
void	reset ()
	Resets the header object to an empty state.
void	setApplicationId (byte[] myApplicationId)
	Set the Application ID. More...
void	setCorrelationId (byte[] myCorrelationId)
	Set the Correlation ID. More...
void	setDeliveryMode (byte myDeliveryMode)
	Set the delivery mode. More...
void	setDestination (byte[] myDestination)
	Set the Message Destination. More...
void	setExpiration (long myExpiration)
	Set the message expiration. More...
void	setMessageId (byte[] myMessageId)
	Set the Message ID. More...
void	setMessageType (byte type)
	Set the message type. More...
void	setPriority (byte myPriority)
	Set the message Priority. More...
void	setPubHost (byte[] myPubHost)
	Set the Publish Host. More...
void	setPubName (byte[] myPubName)
	Set the Publisher Name. More...
void	setRedelivered (boolean redelivered)
	Set if the message has been redelivered. More...
void	setRedeliveredCount (int redeliveredCount)
	Set the Redelivered Count. More...
void	setReplyToName (byte[] myReplyToName)
	Set the Reply To Name. More...
void	setTimestamp (long myTimestamp)
	Set the timestamp. More...
void	setTTL (long myTTL)
	Set the message TTL. More...
void	setUserId (byte[] myUserId)
	Set the User ID. More...

Detailed Description

This class represents a message Header.

Member Function Documentation

byte [] com.pcbsys.nirvana.base.nHeader.getApplicationId

(

)

Get the Application ID.

Returns

the Application ID

byte [] com.pcbsys.nirvana.base.nHeader.getCorrelationId

(

)

Get the Correlation ID.

Returns

the Correlation ID

byte com.pcbsys.nirvana.base.nHeader.getDeliveryMode

(

)

Get the delivery mode.

Returns

the delivery mode

byte [] com.pcbsys.nirvana.base.nHeader.getDestination

(

)

Get the Message Destination.

Returns

the Message Destination

fEventDictionary com.pcbsys.nirvana.base.nHeader.getDictionary

(

)

Returns the event Dictionary.

Returns

the event Dictionary

long com.pcbsys.nirvana.base.nHeader.getExpiration

(

)

Get the message expiration.

Returns

the message expiration

byte [] com.pcbsys.nirvana.base.nHeader.getMessageId

(

)

Get the Message ID.

Returns

the Message ID

byte com.pcbsys.nirvana.base.nHeader.getMessageType

(

)

Get the message type.

Returns

the type of the message

byte com.pcbsys.nirvana.base.nHeader.getPriority

(

)

Get the message Priority.

Returns

the message Priority

byte [] com.pcbsys.nirvana.base.nHeader.getPubHost

(

)

Get the Publish Host.

Returns

the Publish Host

byte [] com.pcbsys.nirvana.base.nHeader.getPubName

(

)

Get the Publisher Name.

Returns

the Publisher Name

int com.pcbsys.nirvana.base.nHeader.getRedeliveredCount

(

)

Get the Redelivered Count.

Returns

the number of times the message has been redelivered

byte [] com.pcbsys.nirvana.base.nHeader.getReplyToName

(

)

Get the Reply To Name.

Returns

the Reply To Name

long com.pcbsys.nirvana.base.nHeader.getTimestamp

(

)

Returns the event timestamp.

Returns

the event timestamp

long com.pcbsys.nirvana.base.nHeader.getTTL

(

)

Get the message TTL.

Returns

the message TTL

byte [] com.pcbsys.nirvana.base.nHeader.getUserId

(

)

Get the User ID.

Returns

the User ID

boolean com.pcbsys.nirvana.base.nHeader.isRedelivered

(

)

Check if the message has been redelivered.

Returns

true if the message has been redelivered

void com.pcbsys.nirvana.base.nHeader.setApplicationId

(

byte[]

myApplicationId

)

Set the Application ID.

Parameters

myApplicationId

the Application ID

void com.pcbsys.nirvana.base.nHeader.setCorrelationId

(

byte[]

myCorrelationId

)

Set the Correlation ID.

Parameters

myCorrelationId

the new Correlation ID

void com.pcbsys.nirvana.base.nHeader.setDeliveryMode

(

byte

myDeliveryMode

)

Set the delivery mode.

Parameters

myDeliveryMode

the delivery mode

void com.pcbsys.nirvana.base.nHeader.setDestination

(

byte[]

myDestination

)

Set the Message Destination.

Parameters

myDestination

the new Message Destination

void com.pcbsys.nirvana.base.nHeader.setExpiration

(

long

myExpiration

)

Set the message expiration.

Parameters

myExpiration

the new message expiration

void com.pcbsys.nirvana.base.nHeader.setMessageId

(

byte[]

myMessageId

)

Set the Message ID.

Parameters

myMessageId

the new Message ID

void com.pcbsys.nirvana.base.nHeader.setMessageType

(

byte

type

)

Set the message type.

Parameters

type	the new message type

void com.pcbsys.nirvana.base.nHeader.setPriority

(

byte

myPriority

)

Set the message Priority.

Parameters

myPriority

the new priority

void com.pcbsys.nirvana.base.nHeader.setPubHost

(

byte[]

myPubHost

)

Set the Publish Host.

Parameters

myPubHost

the new Publish Host

void com.pcbsys.nirvana.base.nHeader.setPubName

(

byte[]

myPubName

)

Set the Publisher Name.

Parameters

myPubName

the new Publisher Name

void com.pcbsys.nirvana.base.nHeader.setRedelivered

(

boolean

redelivered

)

Set if the message has been redelivered.

Parameters

redelivered

true if the message has been redelivered

void com.pcbsys.nirvana.base.nHeader.setRedeliveredCount

(

int

redeliveredCount

)

Set the Redelivered Count.

Parameters

redeliveredCount

the new Redelivered Count

void com.pcbsys.nirvana.base.nHeader.setReplyToName

(

byte[]

myReplyToName

)

Set the Reply To Name.

Parameters

myReplyToName

the new Reply To Name

void com.pcbsys.nirvana.base.nHeader.setTimestamp

(

long

myTimestamp

)

Set the timestamp.

Parameters

myTimestamp

the new timestamp

void com.pcbsys.nirvana.base.nHeader.setTTL

(

long

myTTL

)

Set the message TTL.

Parameters

myTTL

the TTL of the message

void com.pcbsys.nirvana.base.nHeader.setUserId

(

byte[]

myUserId

)

Set the User ID.

Parameters

myUserId

the User ID