cgl.narada.event
Interface EventHeaders

All Known Implementing Classes:

EventHeadersImpl

public interface EventHeaders

This class encapsulates various headers which indicate, among other things, if the event is (a) Persistent or transient (b) Has Correlation identifers (c) Security and Integrity related information (d) Fragmentation and Slicing related information (e) Compressed

Method Summary

String	getApplicationType() Gets the application type associated with this event
String	getAssertions() Retrieve SAML Assertions.
byte[]	getBytes() Get a byte stream representation of the event headers
byte[]	getCipherIV() Retrieves the IV associated with the encrypted payload.
String	getCipherMode() Retrieves the Cipher mode.
String	getCipherPaddingScheme() Retrieves the Cipher padding scheme.
String	getCompressionAlgorithm() Get information regarding the compresssion algorithm being used
EventID	getCorrelationIdentifier() Returns the correlation identifier associated with the event
EventID	getEventId() Get the event identifier
long	getFragmentationEpoch() Gets the epoch associated with the fragmentation
String	getFragmentationIdentifier() Returns the fragmentation identifier associated with this fragment.
int	getFragmentNumber() Gets the fragment number associated with this fragment
byte[]	getMessageDigest() Gets the message digest for the payload.
String	getMessageDigestScheme() Returns the message digest scheme used for computing the digest.
long	getOriginalPayloadLength() Gets the original payload length prior to compression.
int	getPriority() Gets the priority associated with this event
byte[]	getSecurityTimeStampedSeqNo()
byte[]	getSignature() Retrieve the signature associated with event.
String	getSignatureAlgorithm() Retrieves the signature Algorithm.
byte[]	getSignedSecurityToken()
int	getSliceEndingPoint() Gets the slice ending point
int	getSliceStartingPoint() Gets the slice from which point on the payload is included.
int	getSource() Returns the generator of this message
int	getTemplateId() Indicates the templateId which this event conforms to
long	getTimeStamp() Returns the timestamp for this event.
int	getTimeToLive() Returns the time to live
int	getTotalNumberOfFragments() Gets the fragment number associated with this fragment
boolean	hasAssertions() Indicates if there are security assertions encapsulated in this event.
boolean	hasCipherIV() Indicates if there is an IV associated with the encrypted payload
boolean	hasEventId() Indicates if there is an event id associated with this message
boolean	hasIntegrity() Indicates if the event has integerity check information.
boolean	hasPriorityInfo() Indicates if this event includes priority information
boolean	hasSignature() Indicates if the event has a signature associated with it
boolean	hasTotalNumberOfFragmentsInfo() Indicates if there is information pertaining to the total number of fragments
boolean	isCompressed() Indicates if the payload has been compressed.
boolean	isCorrelated() Indicates if this event is correlated with any other event.
boolean	isFragmented() Indicates if this event is a fragment of a larger event
boolean	isLastFragment() Indicates if this is the last fragment in the series of fragmented events
boolean	isModified() Indicates if the EventHeader has been modified since the last time that it was serialized.
boolean	isPayloadCompressionFinalStep() Indicates if the payload was compressed after operations such as securing, computing message digests were performed
boolean	isPersistent() Indicates if the event is a persistent one.
boolean	isSecure() Indicates if this event is a secure event
boolean	isSliced()
boolean	isTransient() Indicates if this event is a transient event.
void	setEncryptedPayloadInformation(byte[] cipherIV, String cipherMode, String cipherPaddingScheme)
void	setSecurityTimeStampedSequenceNo(byte[] obj)
void	setSecurityToken(byte[] token)
void	setSignatureInformation(String signatureAlgorithm, byte[] signature)
boolean	supressDistributionToSource() Indicates that the message should not be rerouted to it source, that is contained in the event headers

Method Detail

getTemplateId

int getTemplateId()

Indicates the templateId which this event conforms to

getTimeStamp

long getTimeStamp()

Returns the timestamp for this event. This timestamp corresponds to the value assigned by the time service

getSource

int getSource()

Returns the generator of this message

supressDistributionToSource

boolean supressDistributionToSource()

Indicates that the message should not be rerouted to it source, that is contained in the event headers

hasEventId

boolean hasEventId()

Indicates if there is an event id associated with this message

getEventId

EventID getEventId()

Get the event identifier

isCorrelated

boolean isCorrelated()

Indicates if this event is correlated with any other event. Casual constraints may entail that the correlated event be delivered prior to the delivery of this event.

getCorrelationIdentifier

EventID getCorrelationIdentifier()

Returns the correlation identifier associated with the event

getTimeToLive

int getTimeToLive()

Returns the time to live

isSecure

boolean isSecure()

Indicates if this event is a secure event

hasSignature

boolean hasSignature()

Indicates if the event has a signature associated with it

getSignatureAlgorithm

String getSignatureAlgorithm()

Retrieves the signature Algorithm. Available only if this is a secure event.

getSignature

byte[] getSignature()

Retrieve the signature associated with event. Available only if this is a secure event

hasCipherIV

boolean hasCipherIV()

Indicates if there is an IV associated with the encrypted payload

getCipherIV

byte[] getCipherIV()

Retrieves the IV associated with the encrypted payload. Available only if this is a secure event

getCipherMode

String getCipherMode()

Retrieves the Cipher mode. Available only if this is a secure event

getCipherPaddingScheme

String getCipherPaddingScheme()

Retrieves the Cipher padding scheme. Available only if this is a secure event

hasAssertions

boolean hasAssertions()

Indicates if there are security assertions encapsulated in this event.

getAssertions

String getAssertions()

Retrieve SAML Assertions. Available only if this is a secure event

hasIntegrity

boolean hasIntegrity()

Indicates if the event has integerity check information.

getMessageDigestScheme

String getMessageDigestScheme()

Returns the message digest scheme used for computing the digest. Available only if this is a secure event or has integrity

getMessageDigest

byte[] getMessageDigest()

Gets the message digest for the payload. Available only if this is a secure event or has integrity

isFragmented

boolean isFragmented()

Indicates if this event is a fragment of a larger event

getFragmentationIdentifier

String getFragmentationIdentifier()

Returns the fragmentation identifier associated with this fragment. Fragments that are part of the same event have the same fragmentation identifier, though each of them might have different event identifiers

isLastFragment

boolean isLastFragment()

Indicates if this is the last fragment in the series of fragmented events

getFragmentNumber

int getFragmentNumber()

Gets the fragment number associated with this fragment

hasTotalNumberOfFragmentsInfo

boolean hasTotalNumberOfFragmentsInfo()

Indicates if there is information pertaining to the total number of fragments

getTotalNumberOfFragments

int getTotalNumberOfFragments()

Gets the fragment number associated with this fragment

getFragmentationEpoch

long getFragmentationEpoch()

Gets the epoch associated with the fragmentation

isSliced

boolean isSliced()

getSliceStartingPoint

int getSliceStartingPoint()

Gets the slice from which point on the payload is included. For example one may be interested in the payload from size 90026 to 190000

getSliceEndingPoint

int getSliceEndingPoint()

Gets the slice ending point

hasPriorityInfo

boolean hasPriorityInfo()

Indicates if this event includes priority information

getPriority

int getPriority()

Gets the priority associated with this event

getApplicationType

String getApplicationType()

Gets the application type associated with this event

isPersistent

boolean isPersistent()

Indicates if the event is a persistent one. If it is, the event needs to be archived on storage. It is of course assumed that the event corresponds to a template that supports reliable delivery

isTransient

boolean isTransient()

Indicates if this event is a transient event. If this is a transient event it need not be archived on any storage

isCompressed

boolean isCompressed()

Indicates if the payload has been compressed. Such events are specifically used in cases where the device's network utilization costs might be at a premium.

getCompressionAlgorithm

String getCompressionAlgorithm()

Get information regarding the compresssion algorithm being used

getOriginalPayloadLength

long getOriginalPayloadLength()

Gets the original payload length prior to compression. Will return ZERO if the event doesn't have a compressed payload

isPayloadCompressionFinalStep

boolean isPayloadCompressionFinalStep()

Indicates if the payload was compressed after operations such as securing, computing message digests were performed

getBytes

byte[] getBytes()

Get a byte stream representation of the event headers

getSignedSecurityToken

byte[] getSignedSecurityToken()

setSecurityToken

void setSecurityToken(byte[] token)

setSignatureInformation

void setSignatureInformation(String signatureAlgorithm,
                             byte[] signature)

setEncryptedPayloadInformation

void setEncryptedPayloadInformation(byte[] cipherIV,
                                    String cipherMode,
                                    String cipherPaddingScheme)

getSecurityTimeStampedSeqNo

byte[] getSecurityTimeStampedSeqNo()

setSecurityTimeStampedSequenceNo

void setSecurityTimeStampedSequenceNo(byte[] obj)

isModified

boolean isModified()

Indicates if the EventHeader has been modified since the last time that it was serialized.