fiorano.esb.record

Class ESBRecord

java.lang.Object

fiorano.esb.record.ESBRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ESBRecord
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENT_TYPE_BYTES Represents the Bytes Content-Type
static java.lang.String	CONTENT_TYPE_BYTES_STR
static int	CONTENT_TYPE_OBJECT Represents unknown (object) content type
static int	CONTENT_TYPE_TEXT Represents the Text Content-Type
static java.lang.String	CONTENT_TYPE_TEXT_STR
static int	CONTENT_TYPE_XML Represents the XML Content-Type
static java.lang.String	CONTENT_TYPE_XML_STR
static java.lang.String	PROP_CORRELATION_ID
static java.lang.String	PROP_DESTINATION
static java.lang.String	PROP_MESSAGE_ID
static java.lang.String	PROP_PRIORITY
static java.lang.String	PROP_REPLY_TO
static java.lang.String	PROP_TIMESTAMP
static java.lang.String	PROP_TTL

Constructor Summary

Constructors

Constructor and Description
ESBRecord() Constructs an instance of ESBRecord

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttachment(java.lang.String id, javax.activation.DataHandler content) Adds an Attachment to the ESBRecord
static java.lang.String	base64Encode(byte[] blob) return Base64BinaryValue as String
void	clearProperties() clears the properties
java.lang.Object	clone() Clones the ESBRecord
javax.activation.DataHandler	getAttachment(java.lang.String id) Returns attachment with the specified id.
byte[]	getBinaryContent() Returns the blob if the content type is binary
boolean	getBooleanProperty(java.lang.String string) Returns the value of specified property as type boolean.
byte	getByteProperty(java.lang.String string) Returns the value of specified property as type byte.
javax.xml.transform.Source	getContent() Retrieve the content of the message
java.lang.String	getContentAsString() Retrieves the content of the message as string
int	getContentType() Returns the type of the Content.
double	getDoubleProperty(java.lang.String string) Returns the value of specified property as type Double .
float	getFloatProperty(java.lang.String string) Returns the value of specified property as type Long.
int	getIntProperty(java.lang.String string) Returns the value of specified property as type Integer .
java.lang.String	getJMSCorrelationID() Returns the MSCorrelationID as type String.
long	getLongProperty(java.lang.String string) Returns the value of specified property as type Long.
javax.xml.namespace.QName	getName() Returns the QName of this message.
java.lang.Object	getObjectProperty(java.lang.String string) Returns the value of specified property as type Object.
java.util.Map	getProperties() Returns the Map containing the Properties.
java.util.Map	getPropertiesClone() Returns properties clone for object
java.lang.Object	getProperty(java.lang.String name) Retrieve the value of the specified message property.
java.lang.String	getPropertyAsString(java.lang.String name) Retrieves the value of the specified message property as String.
Keys	getPropertyNames() Lists all the properties by name for this message
static int	getPropertyType(java.lang.Object propValue) Returns property record for class
int	getPropertyType(java.lang.String name)
java.util.Map	getPropertyTypesClone() Returns propertyTypes clone for object
javax.security.auth.Subject	getSecuritySubject() Returns security subject associated with this message.
short	getShortProperty(java.lang.String string) Returns the value of specified property as type short.
javax.xml.transform.Source	getSource(org.w3c.dom.Node contentNode) Converts the specified Dom Node to DOMSource
javax.xml.transform.Source	getSource(java.lang.String contentXML) Converts the specified String ot SAXSource
java.lang.String	getStringProperty(java.lang.String string) Returns the value of specified property as type String.
java.lang.String	getText() Returns the text as type String.
java.util.Iterator	listAttachments() Returns the List of attachment IDs
void	loadContent(byte[] blob) Sets the specified byte[] as the content of the message
void	loadContent(org.w3c.dom.Node contentNode) Sets the specified DOMNode as the content of the message
void	loadContent(java.lang.String contentXML) Sets the specified XML as the content of the message
void	loadProperties(ESBRecord record, boolean bOverwrite) properties are overwriiten if passed boolean is true
boolean	propertyExists(java.lang.String string) checks the existence of the property.
void	removeAttachment(java.lang.String id) Removes the attachment with the specified id.
void	setBooleanProperty(java.lang.String string, boolean b) Sets the boolean property for given string value
void	setByteProperty(java.lang.String string, byte b) Sets the byte property for given string
void	setContent(javax.xml.transform.Source content) Set the content of the message
void	setContentType(int contentType) Sets the Content type of the ESB Record.
void	setDoubleProperty(java.lang.String string, double v) Sets the double property for given string
void	setFloatProperty(java.lang.String string, float v) Sets the float property for given string
void	setIntProperty(java.lang.String string, int i) Sets the int property for given string
void	setJMSCorrelationID(java.lang.String correlationID) sets the JMSCorrelationID.
void	setLongProperty(java.lang.String string, long l) Sets the long property for given string
void	setName(javax.xml.namespace.QName qname) Sets the name of the message.
void	setObjectProperty(java.lang.String string, java.lang.Object object) Sets the Object property for given string
void	setProperty(java.lang.String name, int propertyType, java.lang.Object value) Set a message property to the message
void	setProperty(java.lang.String name, java.lang.Object value) Set a message property to the message
void	setSecuritySubject(javax.security.auth.Subject subject) Sets security subject for object
void	setShortProperty(java.lang.String string, short i) Sets the short property for given string
void	setStringProperty(java.lang.String string, java.lang.String string1) Sets the string property for given string
void	setText(java.lang.String string) sets the text of type String.
static org.w3c.dom.Node	toDOM(javax.xml.transform.Source source) Utility method to get the DOM equivalent of the specified Source object
static org.w3c.dom.Node	toDOM(java.lang.String source) Utility method to get the DOM equivalent of the specified String object

Methods inherited from class java.lang.Object

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

Field Detail

PROP_MESSAGE_ID

public static final java.lang.String PROP_MESSAGE_ID

PROP_DESTINATION

public static final java.lang.String PROP_DESTINATION

PROP_REPLY_TO

public static final java.lang.String PROP_REPLY_TO

PROP_TIMESTAMP

public static final java.lang.String PROP_TIMESTAMP

PROP_CORRELATION_ID

public static final java.lang.String PROP_CORRELATION_ID

PROP_PRIORITY

public static final java.lang.String PROP_PRIORITY

PROP_TTL

public static final java.lang.String PROP_TTL

CONTENT_TYPE_XML

public static final int CONTENT_TYPE_XML

Represents the XML Content-Type

CONTENT_TYPE_TEXT

public static final int CONTENT_TYPE_TEXT

Represents the Text Content-Type

CONTENT_TYPE_BYTES

public static final int CONTENT_TYPE_BYTES

Represents the Bytes Content-Type

CONTENT_TYPE_OBJECT

public static final int CONTENT_TYPE_OBJECT

Represents unknown (object) content type

CONTENT_TYPE_XML_STR

public static final java.lang.String CONTENT_TYPE_XML_STR

CONTENT_TYPE_TEXT_STR

public static final java.lang.String CONTENT_TYPE_TEXT_STR

CONTENT_TYPE_BYTES_STR

public static final java.lang.String CONTENT_TYPE_BYTES_STR

Constructor Detail

ESBRecord

public ESBRecord()

Constructs an instance of ESBRecord

Method Detail

getPropertyType

public static int getPropertyType(java.lang.Object propValue)

Returns property record for class

Parameters:

propValue -

Returns:

property type

toDOM

public static org.w3c.dom.Node toDOM(javax.xml.transform.Source source)
                              throws ESBException

Utility method to get the DOM equivalent of the specified Source object

Parameters:

source - Source to be converted to DOM

Returns:

Node equivalent of Source

Throws:

ESBException - error converting Source to Dom Node

toDOM

public static org.w3c.dom.Node toDOM(java.lang.String source)
                              throws ESBException

Utility method to get the DOM equivalent of the specified String object

Parameters:

source - String to be converted to DOM

Returns:

Node equivalent of String

Throws:

ESBException - error converting String to Dom Node

base64Encode

public static java.lang.String base64Encode(byte[] blob)

return Base64BinaryValue as String

Parameters:

blob -

Returns:

Base64BinaryValue as String

getName

public javax.xml.namespace.QName getName()

Returns the QName of this message. Name of the message can be used for Message Identification

Returns:

QName of this Message object

getContentType

public int getContentType()

Returns the type of the Content.

Returns:

content-type this will be one of CONTENT_TYPE_XML, CONTENT_TYPE_TEXT or CONTENT_TYPE_BYTES

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws ESBException

Retrieve the value of the specified message property.

Parameters:

name - name of the property

Returns:

value of the property

Throws:

ESBException

getPropertyType

public int getPropertyType(java.lang.String name)

Parameters:

name -

Returns:

property type

getPropertyAsString

public java.lang.String getPropertyAsString(java.lang.String name)
                                     throws ESBException

Retrieves the value of the specified message property as String.

Parameters:

name - name of the property

Returns:

string value of the property

Throws:

ESBException

getBooleanProperty

public boolean getBooleanProperty(java.lang.String string)
                           throws ESBException

Returns the value of specified property as type boolean.

Parameters:

string - name of the property

Returns:

boolean value of the property

Throws:

ESBException

getByteProperty

public byte getByteProperty(java.lang.String string)
                     throws ESBException

Returns the value of specified property as type byte.

Parameters:

string - name of the property

Returns:

byte value of the property

Throws:

ESBException

getShortProperty

public short getShortProperty(java.lang.String string)
                       throws ESBException

Returns the value of specified property as type short.

Parameters:

string - name of the property

Returns:

short value of the property

Throws:

ESBException

getIntProperty

public int getIntProperty(java.lang.String string)
                   throws ESBException

Returns the value of specified property as type Integer .

Parameters:

string - name of the property

Returns:

int value of the property

Throws:

ESBException

getLongProperty

public long getLongProperty(java.lang.String string)
                     throws ESBException

Returns the value of specified property as type Long.

Parameters:

string - of the property

Returns:

long value of the property

Throws:

ESBException

getFloatProperty

public float getFloatProperty(java.lang.String string)
                       throws ESBException

Returns the value of specified property as type Long.

Parameters:

string - of the property

Returns:

float value of the property

Throws:

ESBException

getDoubleProperty

public double getDoubleProperty(java.lang.String string)
                         throws ESBException

Returns the value of specified property as type Double .

Parameters:

string - of the property

Returns:

double value of the property

Throws:

ESBException

getStringProperty

public java.lang.String getStringProperty(java.lang.String string)
                                   throws ESBException

Returns the value of specified property as type String.

Parameters:

string - of the property

Returns:

string value of the property

Throws:

ESBException

getObjectProperty

public java.lang.Object getObjectProperty(java.lang.String string)
                                   throws ESBException

Returns the value of specified property as type Object.

Parameters:

string - of the property

Returns:

Object value of the property

Throws:

ESBException

getProperties

public java.util.Map getProperties()

Returns the Map containing the Properties.

Returns:

Map containg properties

getPropertyNames

public Keys getPropertyNames()

Lists all the properties by name for this message

Returns:

Iterator containing the message property names

setBooleanProperty

public void setBooleanProperty(java.lang.String string,
                      boolean b)
                        throws ESBException

Sets the boolean property for given string value

Parameters:

string - propertyName

b - boolean value set for the property

Throws:

ESBException

setByteProperty

public void setByteProperty(java.lang.String string,
                   byte b)
                     throws ESBException

Sets the byte property for given string

Parameters:

string - propertyName

b - byte value set for the property

Throws:

ESBException

setShortProperty

public void setShortProperty(java.lang.String string,
                    short i)
                      throws ESBException

Sets the short property for given string

Parameters:

string - propertyName

i - short value set for the property

Throws:

ESBException

setIntProperty

public void setIntProperty(java.lang.String string,
                  int i)
                    throws ESBException

Sets the int property for given string

Parameters:

string - propertyName

i - integer value set for the property

Throws:

ESBException

setLongProperty

public void setLongProperty(java.lang.String string,
                   long l)
                     throws ESBException

Sets the long property for given string

Parameters:

string - propertyName

l - long value set for the property

Throws:

ESBException

setFloatProperty

public void setFloatProperty(java.lang.String string,
                    float v)
                      throws ESBException

Sets the float property for given string

Parameters:

string - propertyName

v - float value set for the property

Throws:

ESBException

setDoubleProperty

public void setDoubleProperty(java.lang.String string,
                     double v)
                       throws ESBException

Sets the double property for given string

Parameters:

string - propertyName

v - double value set for the property

Throws:

ESBException

setStringProperty

public void setStringProperty(java.lang.String string,
                     java.lang.String string1)
                       throws ESBException

Sets the string property for given string

Parameters:

string - propertyName

string1 - string value to be set for the property

Throws:

ESBException

setObjectProperty

public void setObjectProperty(java.lang.String string,
                     java.lang.Object object)
                       throws ESBException

Sets the Object property for given string

Parameters:

string - propertyName

object - object set for the property

Throws:

ESBException

getText

public java.lang.String getText()
                         throws ESBException

Returns the text as type String.

Returns:

string

Throws:

ESBException

setText

public void setText(java.lang.String string)

sets the text of type String.

Parameters:

string - setting the text with this value

getJMSCorrelationID

public java.lang.String getJMSCorrelationID()
                                     throws ESBException

Returns the MSCorrelationID as type String.

Returns:

string

Throws:

ESBException

setJMSCorrelationID

public void setJMSCorrelationID(java.lang.String correlationID)
                         throws ESBException

sets the JMSCorrelationID.

Parameters:

correlationID - setting the JMSCorrelationID with this value

Throws:

ESBException

clearProperties

public void clearProperties()
                     throws ESBException

clears the properties

Throws:

ESBException

propertyExists

public boolean propertyExists(java.lang.String string)

checks the existence of the property.

Parameters:

string - The property to be checked

Returns:

boolean

getBinaryContent

public byte[] getBinaryContent()
                        throws ESBException

Returns the blob if the content type is binary

Returns:

bytes content of this message

Throws:

ESBException

getContent

public javax.xml.transform.Source getContent()

Retrieve the content of the message

Returns:

Source content

getPropertiesClone

public java.util.Map getPropertiesClone()

Returns properties clone for object

Returns:

clone of properties

getPropertyTypesClone

public java.util.Map getPropertyTypesClone()

Returns propertyTypes clone for object

Returns:

clone of property types

getContentAsString

public java.lang.String getContentAsString()
                                    throws ESBException

Retrieves the content of the message as string

Returns:

message content as String

Throws:

ESBException

getAttachment

public javax.activation.DataHandler getAttachment(java.lang.String id)

Returns attachment with the specified id.

Parameters:

id - representing the attachement

Returns:

Attachment content handler

getSecuritySubject

public javax.security.auth.Subject getSecuritySubject()

Returns security subject associated with this message.

Returns:

Security credentials of this message.

getSource

public javax.xml.transform.Source getSource(java.lang.String contentXML)

Converts the specified String ot SAXSource

Parameters:

contentXML - string to be converted

Returns:

SAXSource

getSource

public javax.xml.transform.Source getSource(org.w3c.dom.Node contentNode)

Converts the specified Dom Node to DOMSource

Parameters:

contentNode - Dom Node to be converted

Returns:

DOMSource

setContentType

public void setContentType(int contentType)

Sets the Content type of the ESB Record.
Default is CONTENT_TYPE_XML.
Valid values are CONTENT_TYPE_XML, CONTENT_TYPE_TEXT or CONTENT_TYPE_BYTES

Parameters:

contentType - content type to be set.

setName

public void setName(javax.xml.namespace.QName qname)

Sets the name of the message.

Parameters:

qname - name of the message

setProperty

public void setProperty(java.lang.String name,
               java.lang.Object value)

Set a message property to the message

Parameters:

name - property name

value - value of the property

setProperty

public void setProperty(java.lang.String name,
               int propertyType,
               java.lang.Object value)

Set a message property to the message

Parameters:

name - property name

value - value of the property

propertyType -

setContent

public void setContent(javax.xml.transform.Source content)

Set the content of the message

Parameters:

content - message content

setSecuritySubject

public void setSecuritySubject(javax.security.auth.Subject subject)

Sets security subject for object

Parameters:

subject - security credentials for the message

loadProperties

public void loadProperties(ESBRecord record,
                  boolean bOverwrite)

properties are overwriiten if passed boolean is true

Parameters:

record -

bOverwrite -

clone

public java.lang.Object clone()

Clones the ESBRecord

Overrides:

clone in class java.lang.Object

Returns:

clones ESBRecord

Throws:

java.lang.RuntimeException - if unable to clone ESBRecord

addAttachment

public void addAttachment(java.lang.String id,
                 javax.activation.DataHandler content)
                   throws ESBException

Adds an Attachment to the ESBRecord

Parameters:

id - id of the attachment

content - Attachment handler

Throws:

ESBException

removeAttachment

public void removeAttachment(java.lang.String id)
                      throws ESBException

Removes the attachment with the specified id.

Parameters:

id - attachment id.

Throws:

ESBException

listAttachments

public java.util.Iterator listAttachments()

Returns the List of attachment IDs

Returns:

Iterator containing attachment IDs

loadContent

public void loadContent(java.lang.String contentXML)

Sets the specified XML as the content of the message

Parameters:

contentXML -

loadContent

public void loadContent(byte[] blob)

Sets the specified byte[] as the content of the message

Parameters:

blob -

loadContent

public void loadContent(org.w3c.dom.Node contentNode)

Sets the specified DOMNode as the content of the message

Parameters:

contentNode -