cgl.narada.event

Class EventHeadersImpl

java.lang.Object

cgl.narada.event.EventHeadersImpl

All Implemented Interfaces:

EventHeaders

Deprecated.

@Deprecated
public class EventHeadersImpl
extends java.lang.Object
implements 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

Author:

Shrideep Pallickara $Date$ $Revision$

Constructor Summary

Constructors

Constructor and Description
EventHeadersImpl() Deprecated.
EventHeadersImpl(byte[] headerBytes) Deprecated.

Method Summary

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventHeadersImpl

public EventHeadersImpl()

Deprecated.

EventHeadersImpl

public EventHeadersImpl(byte[] headerBytes)

Deprecated.

Method Detail

getTemplateId

public int getTemplateId()

Deprecated.

Indicates the templateId which this event conforms to

Specified by:

getTemplateId in interface EventHeaders

getTimeStamp

public long getTimeStamp()

Deprecated.

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

Specified by:

getTimeStamp in interface EventHeaders

getSource

public int getSource()

Deprecated.

Returns the generator of this message

Specified by:

getSource in interface EventHeaders

supressDistributionToSource

public boolean supressDistributionToSource()

Deprecated.

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

Specified by:

supressDistributionToSource in interface EventHeaders

hasEventId

public boolean hasEventId()

Deprecated.

Indicates if there is an event id associated with this message

Specified by:

hasEventId in interface EventHeaders

getEventId

public EventID getEventId()

Deprecated.

Get the event identifier

Specified by:

getEventId in interface EventHeaders

isCorrelated

public boolean isCorrelated()

Deprecated.

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.

Specified by:

isCorrelated in interface EventHeaders

getCorrelationIdentifier

public EventID getCorrelationIdentifier()

Deprecated.

Returns the correlation identifier associated with the event

Specified by:

getCorrelationIdentifier in interface EventHeaders

getTimeToLive

public int getTimeToLive()

Deprecated.

Returns the time to live

Specified by:

getTimeToLive in interface EventHeaders

isSecure

public boolean isSecure()

Deprecated.

Indicates if this event is a secure event

Specified by:

isSecure in interface EventHeaders

hasSignedSecurityToken

public boolean hasSignedSecurityToken()

Deprecated.

Indicates if the event has a signature associated with it

hasSignature

public boolean hasSignature()

Deprecated.

Indicates if the event has a signature associated with it

Specified by:

hasSignature in interface EventHeaders

getSignatureAlgorithm

public java.lang.String getSignatureAlgorithm()

Deprecated.

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

Specified by:

getSignatureAlgorithm in interface EventHeaders

getSignature

public byte[] getSignature()

Deprecated.

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

Specified by:

getSignature in interface EventHeaders

hasCipherIV

public boolean hasCipherIV()

Deprecated.

Indicates if there is an IV associated with the encrypted payload

Specified by:

hasCipherIV in interface EventHeaders

getCipherIV

public byte[] getCipherIV()

Deprecated.

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

Specified by:

getCipherIV in interface EventHeaders

getCipherMode

public java.lang.String getCipherMode()

Deprecated.

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

Specified by:

getCipherMode in interface EventHeaders

getCipherPaddingScheme

public java.lang.String getCipherPaddingScheme()

Deprecated.

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

Specified by:

getCipherPaddingScheme in interface EventHeaders

hasAssertions

public boolean hasAssertions()

Deprecated.

Indicates if there are security assertions encapsulated in this event.

Specified by:

hasAssertions in interface EventHeaders

getAssertions

public java.lang.String getAssertions()

Deprecated.

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

Specified by:

getAssertions in interface EventHeaders

hasIntegrity

public boolean hasIntegrity()

Deprecated.

Indicates if the event has integerity check information.

Specified by:

hasIntegrity in interface EventHeaders

getMessageDigestScheme

public java.lang.String getMessageDigestScheme()

Deprecated.

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

Specified by:

getMessageDigestScheme in interface EventHeaders

getMessageDigest

public byte[] getMessageDigest()

Deprecated.

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

Specified by:

getMessageDigest in interface EventHeaders

isFragmented

public boolean isFragmented()

Deprecated.

Indicates if this event is a fragment of a larger event

Specified by:

isFragmented in interface EventHeaders

getFragmentationIdentifier

public java.lang.String getFragmentationIdentifier()

Deprecated.

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

Specified by:

getFragmentationIdentifier in interface EventHeaders

isLastFragment

public boolean isLastFragment()

Deprecated.

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

Specified by:

isLastFragment in interface EventHeaders

getFragmentNumber

public int getFragmentNumber()

Deprecated.

Gets the fragment number associated with this fragment

Specified by:

getFragmentNumber in interface EventHeaders

hasTotalNumberOfFragmentsInfo

public boolean hasTotalNumberOfFragmentsInfo()

Deprecated.

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

Specified by:

hasTotalNumberOfFragmentsInfo in interface EventHeaders

getTotalNumberOfFragments

public int getTotalNumberOfFragments()

Deprecated.

Gets the fragment number associated with this fragment

Specified by:

getTotalNumberOfFragments in interface EventHeaders

getFragmentationEpoch

public long getFragmentationEpoch()

Deprecated.

Gets the epoch associated with the fragmentation

Specified by:

getFragmentationEpoch in interface EventHeaders

isSliced

public boolean isSliced()

Deprecated.

Specified by:

isSliced in interface EventHeaders

getSliceStartingPoint

public int getSliceStartingPoint()

Deprecated.

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

Specified by:

getSliceStartingPoint in interface EventHeaders

getSliceEndingPoint

public int getSliceEndingPoint()

Deprecated.

Gets the slice ending point

Specified by:

getSliceEndingPoint in interface EventHeaders

hasPriorityInfo

public boolean hasPriorityInfo()

Deprecated.

Indicates if this event includes priority information

Specified by:

hasPriorityInfo in interface EventHeaders

getPriority

public int getPriority()

Deprecated.

Gets the priority associated with this event

Specified by:

getPriority in interface EventHeaders

getApplicationType

public java.lang.String getApplicationType()

Deprecated.

Gets the application type associated with this event

Specified by:

getApplicationType in interface EventHeaders

isPersistent

public boolean isPersistent()

Deprecated.

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

Specified by:

isPersistent in interface EventHeaders

isTransient

public boolean isTransient()

Deprecated.

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

Specified by:

isTransient in interface EventHeaders

isCompressed

public boolean isCompressed()

Deprecated.

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.

Specified by:

isCompressed in interface EventHeaders

getCompressionAlgorithm

public java.lang.String getCompressionAlgorithm()

Deprecated.

Get information regarding the compresssion algorithm being used

Specified by:

getCompressionAlgorithm in interface EventHeaders

getOriginalPayloadLength

public long getOriginalPayloadLength()

Deprecated.

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

Specified by:

getOriginalPayloadLength in interface EventHeaders

isPayloadCompressionFinalStep

public boolean isPayloadCompressionFinalStep()

Deprecated.

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

Specified by:

isPayloadCompressionFinalStep in interface EventHeaders

setSignatureInformation

public void setSignatureInformation(java.lang.String signatureAlgorithm,
                                    byte[] signature)

Deprecated.

Specified by:

setSignatureInformation in interface EventHeaders

setEncryptedPayloadInformation

public void setEncryptedPayloadInformation(byte[] cipherIV,
                                           java.lang.String cipherMode,
                                           java.lang.String cipherPaddingScheme)

Deprecated.

Specified by:

setEncryptedPayloadInformation in interface EventHeaders

getSignedSecurityToken

public byte[] getSignedSecurityToken()

Deprecated.

Get the Security token from the event

Specified by:

getSignedSecurityToken in interface EventHeaders

setSecurityToken

public void setSecurityToken(byte[] tokenBytes)

Deprecated.

Set the signed security token

Specified by:

setSecurityToken in interface EventHeaders

getSecurityTimeStampedSeqNo

public byte[] getSecurityTimeStampedSeqNo()

Deprecated.

Specified by:

getSecurityTimeStampedSeqNo in interface EventHeaders

setSecurityTimeStampedSequenceNo

public void setSecurityTimeStampedSequenceNo(byte[] obj)

Deprecated.

Specified by:

setSecurityTimeStampedSequenceNo in interface EventHeaders

getBytes

public byte[] getBytes()

Deprecated.

Generate the serialized representation of the event headers

Specified by:

getBytes in interface EventHeaders

isModified

public boolean isModified()

Deprecated.

Description copied from interface: EventHeaders

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

Specified by:

isModified in interface EventHeaders

createHeaderSnapshot

public int createHeaderSnapshot()

Deprecated.

Creates a snapshot of the headers contained in the event headers

getHeadersFromSnapshot

public void getHeadersFromSnapshot()

Deprecated.

Retrieves the values of headers based on the snapshot

printHeaders

public void printHeaders()

Deprecated.

main

public static void main(java.lang.String[] args)

Deprecated.

A test routine to test the functionality