com.ibm.wbi.bcm.sm.message
Class BCMMessage

java.lang.Object
|
+--com.ibm.wbi.bcm.sm.message.BCMMessage

public class BCMMessage
extends java.lang.Object
implements java.io.Serializable, com.ibm.wbi.bcm.sm.message.MQAOAddress, java.lang.Cloneable

Message holder class for holding the BCM meta-data values plus the application integration message data.

See Also:
Serialized Form

Field Summary
static int ACK_NO
          Ack not desired.
static java.lang.String ACK_NO_STRING
          Ack not desired.
static int ACK_YES
          Ack desired.
static java.lang.String ACK_YES_STRING
          Ack desired.
static java.lang.String BCMHEADER_APLICATIONID
          constant for XML element/attribute BCMHEADER_APLICATIONID: ApplicationID
static java.lang.String BCMHEADER_BCMCHEADER
          constant for XML element/attribute BCMHEADER: EPICHEADER
static java.lang.String BCMHEADER_BODYCATEGORY
          constant for XML element/attribute BCMHEADER_BODYCATEGORY: BodyCategory
static java.lang.String BCMHEADER_BODYTYPE
          constant for XML element/attribute BCMHEADER_BODYTYPE: BodyType
static java.lang.String BCMHEADER_CORRELATIONID
          constant for XML element/attribute BCMHEADER_CORRELATIONID: CorrelationID
static java.lang.String BCMHEADER_EPICBODY
          constant for XML element/attribute BCMHEADER_EPICBODY: EPICBODY
static java.lang.String BCMHEADER_EVENTTYPE
          constant for XML element/attribute BCMHEADER_EVENTTYPE: EventType
static java.lang.String BCMHEADER_EXTERNALID
          constant for XML element/attribute BCMHEADER_EXTERNALID: ExternalID
static java.lang.String BCMHEADER_HEADER
          constant for XML element/attribute BCMHEADER_HEADER: HEADER
static java.lang.String BCMHEADER_HOSTNAMEIP
          constant for XML element/attribute BCMHEADER_HOSTNAMEIP: HostNameIP
static java.lang.String BCMHEADER_INTERNALID
          constant for XML element/attribute BCMHEADER_INTERNALID: InternalID
static java.lang.String BCMHEADER_INTERNALPARTNERID
          constant for XML element/attribute BCMHEADER_INTERNALPARTNERID: InternalPartnerID
static java.lang.String BCMHEADER_LOGMESSAGEID
          constant for XML element/attribute BCMHEADER_LOGMESSAGEID: LogMessageID
static java.lang.String BCMHEADER_LOGMESSAGETYPE
          constant for XML element/attribute BCMHEADER_LOGMESSAGETYPE: LogMessageType
static java.lang.String BCMHEADER_LOGPRIORITY
          constant for XML element/attribute BCMHEADER_LOGPRIORITY: LogPriority
static java.lang.String BCMHEADER_MODELID
          constant for XML element/attribute BCMHEADER_MODELID: ModelID
static java.lang.String BCMHEADER_PROCESSINGCATEGORY
          constant for XML element/attribute BCMHEADER_PROCESSINGCATEGORY: ProcessingCategory
static java.lang.String BCMHEADER_PROCESSINSTANCEID
          constant for XML element/attribute BCMHEADER_PROCESSINSTANCEID: ProcessInstanceID
static java.lang.String BCMHEADER_PUBLICATIONTOPIC
          constant for XML element/attribute BCMHEADER_PUBLICATIONTOPIC: PublicationTopic
static java.lang.String BCMHEADER_RELATEDSUBJECTID
          constant for XML element/attribute BCMHEADER_RELATEDSUBJECTID: RelatedSubjectID
static java.lang.String BCMHEADER_REVISION
          constant for XML element/attribute BCMHEADER_REVISION: Revision
static java.lang.String BCMHEADER_SENDERINSTANCEID
          constant for XML element/attribute BCMHEADER_SENDERINSTANCEID: SenderInstanceID
static java.lang.String BCMHEADER_SESSIONID
          constant for XML element/attribute BCMHEADER_SESSIONID: SessionID
static java.lang.String BCMHEADER_SIZE
          constant for XML element/attribute BCMHEADER_SIZE: Size
static java.lang.String BCMHEADER_SUBSYSTEMID
          constant for XML element/attribute BCMHEADER_SUBSYSTEMID: SubSystemID
static java.lang.String BCMHEADER_TIMESTAMPCREATED
          constant for XML element/attribute BCMHEADER_TIMESTAMPCREATED: TimeStampCreated
static java.lang.String BCMHEADER_TIMESTAMPEXPIRED
          constant for XML element/attribute BCMHEADER_TIMESTAMPEXPIRED: TimeStampExpired
static java.lang.String BCMHEADER_TRANSACTIONREQUIRED
          constant for XML element/attribute BCMHEADER_TRANSACTIONREQUIRED: TransactionRequired
static java.lang.String BCMHEADER_TRANSPORTCORRELATIONID
          constant for XML element/attribute BCMHEADER_TRANSPORTCORRELATIONID: TransportCorrelationID
static java.lang.String BCMHEADER_USERAREA
          constant for XML element/attribute BCMHEADER_USERAREA: USERAREA
static java.lang.String BCMHEADER_USERSECURITYAREA
          constant for XML element/attribute BCMHEADER_USERSECURITYAREA: UserSecurityArea
static java.lang.String DEFAULT_BODY_CATEGORY
          The default value for a body category.
static java.lang.String DEFAULT_BODY_TYPE
          The default value for a body type.
static java.lang.String hdrVersion
          Sets default revision to 002.
protected static java.lang.String linesep
          Sets system line separator property.
static java.lang.String MSGTYPE_APPLICATION
          Default message type set to APPLICATION.
static java.lang.String NONE_DESTINATION
          Sets default destination ID.
static java.lang.String proprietaryNotice
           
static java.lang.String SenderInstanceID
          Sets default sender InstanceID.
static java.lang.String SUBSYSTEMID_DEFAULT
          Default message type set to DEFAULT.
static java.lang.String xmlBodyCategory
          Sets default body category for XML.
 
Fields inherited from interface com.ibm.wbi.bcm.sm.message.MQAOAddress
proprietaryNotice
 
Constructor Summary
BCMMessage ()
          Creates an BCMMessage with DEFAULT for the bodyType & category.
BCMMessage (java.lang.String bcmXMLMessage)
          Parses the XML string and sets the field attribute values from the XML header.
BCMMessage (java.lang.String srcID, java.lang.String messageType)
          Creates an empty message and sets the source ID and the message type from the input params.
 
Method Summary
 boolean addFilter (java.lang.String fieldName, java.lang.String fieldValue)
          Adds a simple header field filter value to the BCMMessage.
static java.lang.String binToHex (byte[] bin)
          Converts a byte[] into a hex string and appends it with 0X.
 void clearFilters ()
          Clear all filters from the table of message filters used by this BCMMessage.
static  BCMMessage copy ( BCMMessage  copy)
          Make a copy of a message.
 java.lang.String createXMLBCMMsg ()
          Create XMLDocument from the attributes.
 void delFilter (java.lang.String filterName)
          Remove a specific filter from the table of message filters used by this EpicMessage.
 boolean equals (java.lang.Object obj)
          Return whether two things are the same, used to indicate a match in the hashtable.
 java.util.Enumeration getAllFilterNames ()
          Return all defined filter names from the table of message filters used by this EpicMessage.
 java.lang.String getApplicationID ()
          Retrieve the attribute value.
 java.lang.String getApplicationName ()
          Retrieve the attribute value.
 java.lang.String getBodyCategory ()
          Retrieve the body category for this message.
 java.lang.String getBodyData ()
          Retrieve the actual data in the message.
protected  long getBodySize ()
          Retrieve the number of bytes in the body data.
 java.lang.String getBodyType ()
          Retrieve the type of the body data.
 java.lang.String getEventType ()
          Retrieve the attribute value of the secondary type.
 java.lang.String getExpirationTimeStamp ()
          Retrieve the expiration timestamp value.
 java.lang.String getExternalID ()
          Get the external ID value for this message.
 java.lang.String getFilter (java.lang.String filterName)
          Return a specific filter from the table of message filters used by this EpicMessage.
 java.lang.String getHostNameIP ()
          Retrieve the attribute value.
 java.lang.String getInternalTradingPartnerID ()
          Retrieve the attribute value.
 java.lang.String getInternalUserID ()
          Get the internal ID value for this message.
 java.lang.String getLogMessageType ()
          Retrieve the attribute value.
 java.lang.String getLogMsgID ()
          Retrieve the attribute value.
 java.lang.String getLogPriority ()
          Retrieve the attribute value.
 java.lang.String getModelID ()
          Retrieve the attribute value.
 java.lang.String getMsgHeaderVersion ()
          Retrieve the attribute value.
 java.lang.String getProcessCorrelationID ()
          Retrieve the process correlation ID for this message.
 java.lang.String getProcessingCategory ()
          Retrieve the attribute value.
 java.lang.String getProcessInstanceID ()
          Retrieve the attribute value.
 java.lang.String getPublicationTopic ()
          Retrieve the attribute value.
 java.lang.String getRelatedSubjectID ()
          Get the related subject value for this message.
 java.lang.String getSenderInstanceID ()
          Retrieve the attribute value.
 java.lang.String getSessionID ()
          Retrieve the attribute value.
 java.lang.String getSubSystemID ()
          Retrieve the attribute value.
 java.lang.String getTimeStamp ()
          Retrieve the creation timestamp value.
 java.lang.String getTransactionRequired ()
          Retrieve the attribute value.
 java.lang.String getTransportCorrelationID ()
          Retrieve the transport correlation for this message.
 java.lang.String getTransportMessageID ()
          Retrieve the transport correlation for this message.
 java.lang.String getUserArea ()
          Retrieve the attribute value.
 byte[] getUserSecurityArea ()
          Retrieve the body signature for this message.
 int hashCode ()
          Return the hashcode - used to index queues etc.
static byte[] hexToBin (java.lang.String iHex)
          Converts a hex string into a byte array.
static boolean isHexString (java.lang.String iHex)
          Tests if the input string is hexString or not.
static void main (java.lang.String[] args)
          Test driver for EpicMessage.
 void parseXMLToAttrib (java.lang.String bcmXMLMsg)
          Parses the XML Document and sets the field attibute values.
 void setApplicationID (java.lang.String value)
          Set the attribute value.
 void setBodyCategory (java.lang.String value)
          Set the attribute value.
 void setBodyData (java.lang.String XMLDocument)
          Set the attribute value.
protected  void setBodySize (long value)
          Set the attribute value.
 void setBodyType (java.lang.String value)
          Set the attribute value.
 void setEventType (java.lang.String value)
          Set the attribute value.
 void setExpirationTimeStamp (java.lang.String value)
          Set the expiration timestamp value.
 void setExternalID (java.lang.String newValue)
          Set the external ID value for this message.
 void setHostNameIP (java.lang.String value)
          Set the attribute value.
 void setInternalTradingPartnerID (java.lang.String value)
          Set the attribute value.
 void setInternalUserID (java.lang.String newValue)
          Set the internal ID value for this message.
 void setLogMessageType (java.lang.String value)
          Set the attribute value.
 void setLogMsgID (java.lang.String value)
          Set the attribute value.
 void setLogPriority (java.lang.String value)
          Set the attribute value.
 void setModelID (java.lang.String value)
          Set the attribute value.
 void setMsgHeaderVersion (java.lang.String value)
          Set the attribute value.
 void setProcessCorrelationID (java.lang.String value)
          Set the attribute value.
 void setProcessingCategory (java.lang.String value)
          Set the attribute value.
 void setProcessInstanceID (java.lang.String value)
          Set the attribute value.
 void setPublicationTopic (java.lang.String value)
          Set the attribute value.
 void setRelatedSubjectID (java.lang.String newValue)
          Set the related subject value for this message.
 void setSenderInstanceID (java.lang.String value)
          Set the attribute value.
 void setSessionID (java.lang.String value)
          Set the attribute value.
 void setSubSystemID (java.lang.String value)
          Set the attribute value.
 void setTimeStamp (java.lang.String value)
          Set the creation timestamp value.
 void setTransactionRequired (java.lang.String value)
          Set the attribute value.
 void setTransportCorrelationID (byte[] newValue)
          Set the transport correlation for this message.
 void setTransportCorrelationID (java.lang.String newValue)
          Set the transport correlation ID for this message.
 void setTransportMessageID (java.lang.String newValue)
          Set the transport message ID for this message.
 void setUniqueMsgID (java.lang.String value)
          Set the attribute value.
 void setUserArea (java.lang.String value)
          Set the attribute value.
 void setUserSecurityArea (byte[] newValue)
          Set the body signature for this message.
 void setUserSecurityArea (java.lang.String newValue)
          Set the body signature for this message.
 void setUserSecurityAreaHexString (java.lang.String newValue)
          Set the body signature for this message.
 java.lang.String toString ()
          Print attribute data.
protected  byte[] verifyByteValue (byte[] newValue)
          Check the value of the array to make sure it's OK to copy.
protected  java.lang.String verifyStringValue (java.lang.String newValue)
          Check the value of the string to make sure it's OK to copy.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

proprietaryNotice

public static final java.lang.String proprietaryNotice

NONE_DESTINATION

public static final java.lang.String NONE_DESTINATION
Sets default destination ID.

MSGTYPE_APPLICATION

public static final java.lang.String MSGTYPE_APPLICATION
Default message type set to APPLICATION.

DEFAULT_BODY_CATEGORY

public static final java.lang.String DEFAULT_BODY_CATEGORY
The default value for a body category. This is used to look up values in the configuration if the specific body category is not found.

DEFAULT_BODY_TYPE

public static final java.lang.String DEFAULT_BODY_TYPE
The default value for a body type. This is used to look up values in the configuration if the specific body type is not found.

ACK_NO

public static final int ACK_NO
Ack not desired. This is one of the values used in setAckRequested.
See Also:
#setAckRequested, ACK_NO

ACK_NO_STRING

public static final java.lang.String ACK_NO_STRING
Ack not desired. This is one of the values used in setAckRequested.
See Also:
#setAckRequested, ACK_NO

ACK_YES

public static final int ACK_YES
Ack desired. This is one of the values used in setAckRequested.
See Also:
#setAckRequested , ACK_YES_STRING

ACK_YES_STRING

public static final java.lang.String ACK_YES_STRING
Ack desired. This is one of the values used in setAckRequested.
See Also:
#setAckRequested , ACK_YES

hdrVersion

public static final java.lang.String hdrVersion
Sets default revision to 002.

xmlBodyCategory

public static final java.lang.String xmlBodyCategory
Sets default body category for XML.

linesep

protected static java.lang.String linesep
Sets system line separator property.

BCMHEADER_BCMCHEADER

public static final java.lang.String BCMHEADER_BCMCHEADER
Constant for XML element/attribute BCMHEADER: EPICHEADER.

BCMHEADER_BODYCATEGORY

public static final java.lang.String BCMHEADER_BODYCATEGORY
Constant for XML element/attribute BCMHEADER_BODYCATEGORY: BodyCategory.

BCMHEADER_BODYTYPE

public static final java.lang.String BCMHEADER_BODYTYPE
Constant for XML element/attribute BCMHEADER_BODYTYPE: BodyType.

BCMHEADER_CORRELATIONID

public static final java.lang.String BCMHEADER_CORRELATIONID
Constant for XML element/attribute BCMHEADER_CORRELATIONID: CorrelationID.

BCMHEADER_EPICBODY

public static final java.lang.String BCMHEADER_EPICBODY
Constant for XML element/attribute BCMHEADER_EPICBODY: EPICBODY.

BCMHEADER_EXTERNALID

public static final java.lang.String BCMHEADER_EXTERNALID
Constant for XML element/attribute BCMHEADER_EXTERNALID: ExternalID.

BCMHEADER_HEADER

public static final java.lang.String BCMHEADER_HEADER
Constant for XML element/attribute BCMHEADER_HEADER: HEADER.

BCMHEADER_INTERNALID

public static final java.lang.String BCMHEADER_INTERNALID
Constant for XML element/attribute BCMHEADER_INTERNALID: InternalID.

BCMHEADER_PROCESSINGCATEGORY

public static final java.lang.String BCMHEADER_PROCESSINGCATEGORY
Constant for XML element/attribute BCMHEADER_PROCESSINGCATEGORY: ProcessingCategory.

BCMHEADER_PUBLICATIONTOPIC

public static final java.lang.String BCMHEADER_PUBLICATIONTOPIC
Constant for XML element/attribute BCMHEADER_PUBLICATIONTOPIC: PublicationTopic.

BCMHEADER_RELATEDSUBJECTID

public static final java.lang.String BCMHEADER_RELATEDSUBJECTID
Constant for XML element/attribute BCMHEADER_RELATEDSUBJECTID: RelatedSubjectID.

BCMHEADER_REVISION

public static final java.lang.String BCMHEADER_REVISION
Constant for XML element/attribute BCMHEADER_REVISION: Revision.

BCMHEADER_SESSIONID

public static final java.lang.String BCMHEADER_SESSIONID
Constant for XML element/attribute BCMHEADER_SESSIONID: SessionID.

BCMHEADER_SIZE

public static final java.lang.String BCMHEADER_SIZE
Constant for XML element/attribute BCMHEADER_SIZE: Size.

BCMHEADER_TIMESTAMPCREATED

public static final java.lang.String BCMHEADER_TIMESTAMPCREATED
Constant for XML element/attribute BCMHEADER_TIMESTAMPCREATED: TimeStampCreated.

BCMHEADER_TIMESTAMPEXPIRED

public static final java.lang.String BCMHEADER_TIMESTAMPEXPIRED
Constant for XML element/attribute BCMHEADER_TIMESTAMPEXPIRED: TimeStampExpired.

BCMHEADER_TRANSPORTCORRELATIONID

public static final java.lang.String BCMHEADER_TRANSPORTCORRELATIONID
Constant for XML element/attribute BCMHEADER_TRANSPORTCORRELATIONID: TransportCorrelationID.

BCMHEADER_USERAREA

public static final java.lang.String BCMHEADER_USERAREA
Constant for XML element/attribute BCMHEADER_USERAREA: USERAREA.

SenderInstanceID

public static final java.lang.String SenderInstanceID
Sets default sender InstanceID.

SUBSYSTEMID_DEFAULT

public static final java.lang.String SUBSYSTEMID_DEFAULT
Default message type set to DEFAULT.

BCMHEADER_APLICATIONID

public static final java.lang.String BCMHEADER_APLICATIONID
Constant for XML element/attribute BCMHEADER_APLICATIONID: ApplicationID.

BCMHEADER_HOSTNAMEIP

public static final java.lang.String BCMHEADER_HOSTNAMEIP
Constant for XML element/attribute BCMHEADER_HOSTNAMEIP: HostNameIP.

BCMHEADER_INTERNALPARTNERID

public static final java.lang.String BCMHEADER_INTERNALPARTNERID
Constant for XML element/attribute BCMHEADER_INTERNALPARTNERID: InternalPartnerID.

BCMHEADER_LOGMESSAGEID

public static final java.lang.String BCMHEADER_LOGMESSAGEID
Constant for XML element/attribute BCMHEADER_LOGMESSAGEID: LogMessageID.

BCMHEADER_LOGMESSAGETYPE

public static final java.lang.String BCMHEADER_LOGMESSAGETYPE
Constant for XML element/attribute BCMHEADER_LOGMESSAGETYPE: LogMessageType.

BCMHEADER_LOGPRIORITY

public static final java.lang.String BCMHEADER_LOGPRIORITY
Constant for XML element/attribute BCMHEADER_LOGPRIORITY: LogPriority.

BCMHEADER_MODELID

public static final java.lang.String BCMHEADER_MODELID
Constant for XML element/attribute BCMHEADER_MODELID: ModelID.

BCMHEADER_PROCESSINSTANCEID

public static final java.lang.String BCMHEADER_PROCESSINSTANCEID
Constant for XML element/attribute BCMHEADER_PROCESSINSTANCEID: ProcessInstanceID.

BCMHEADER_SENDERINSTANCEID

public static final java.lang.String BCMHEADER_SENDERINSTANCEID
Constant for XML element/attribute BCMHEADER_SENDERINSTANCEID: SenderInstanceID.

BCMHEADER_SUBSYSTEMID

public static final java.lang.String BCMHEADER_SUBSYSTEMID
Constant for XML element/attribute BCMHEADER_SUBSYSTEMID: SubSystemID.

BCMHEADER_TRANSACTIONREQUIRED

public static final java.lang.String BCMHEADER_TRANSACTIONREQUIRED
Constant for XML element/attribute BCMHEADER_TRANSACTIONREQUIRED: TransactionRequired.

BCMHEADER_USERSECURITYAREA

public static final java.lang.String BCMHEADER_USERSECURITYAREA
Constant for XML element/attribute BCMHEADER_USERSECURITYAREA: UserSecurityArea.

BCMHEADER_EVENTTYPE

public static final java.lang.String BCMHEADER_EVENTTYPE
Constant for XML element/attribute BCMHEADER_EVENTTYPE: EventType.
Constructor Detail

BCMMessage

public BCMMessage()
Creates a BCMMessage with DEFAULT for the bodyType & category. Other fields are initialized with suitable defaults. This message is useable but contains no data.

BCMMessage

public BCMMessage(java.lang.String bcmXMLMessage)
throws com.ibm.wbi.bcm.common.BCMException
Parses the XML string and sets the field attribute values from the XML header. The xml document in string format should contain an BCM_HEADER element.
Parameters:
epicXMLMessage - XML String to read all the message parameters from.
Throws:
com.ibm.wbi.bcm.common.BCMException - catch parser errors

BCMMessage

public BCMMessage(java.lang.String srcID,
java.lang.String messageType)
throws com.ibm.wbi.bcm.common.BCMException
Creates an empty message and sets the source ID and the message type from the input params. The message can be further initialized by calling any of the setXXX() methods on this instance.
Method Detail

addFilter

public boolean addFilter(java.lang.String fieldName,
java.lang.String fieldValue)
Adds a simple header field filter value to the BCMMessage. 
Parameters:
fieldName - java.lang.String - Name of the field
fieldValue - java.lang.String - Value of the field to match
Returns:
Boolean - status of add (false if fieldName is null or empty).

binToHex

public static java.lang.String binToHex(byte[] bin)
Converts a byte[] into a hex string and appends it with 0X.
Parameters:
bin - The byte[] to convert.
Returns:
The Converted byte[] into the String.

clearFilters

public void clearFilters()
Clear all filters from the table of message filters used by this BCMMessage.

delFilter

public void delFilter(java.lang.String filterName)
Remove a specific filter from the table of message filters used by this EpicMessage. 
Parameters:
filterName - java.lang.String

equals

public boolean equals(java.lang.Object obj)
Return whether two things are the same, used to inidicate a match in the hashtable.
Overrides:
equals in class java.lang.Object

getAllFilterNames

public java.util.Enumeration getAllFilterNames()
Return all defined filter names from the table of message filters used by this EpicMessage. 
Returns:
java.util.Enumeration

getApplicationName

public java.lang.String getApplicationName()
Retrieve the attribute value
Specified by:
getApplicationName in interface com.ibm.wbi.bcm.sm.message.MQAOAddress
Returns:
String

getBodyCategory

public java.lang.String getBodyCategory()
Retrieve the body category for this message.
Specified by:
getBodyCategory in interface com.ibm.wbi.bcm.sm.message.MQAOAddress
Returns:
String

getBodyData

public java.lang.String getBodyData()
Retrieve the actual data in the message.
Returns:
String

getBodySize

protected long getBodySize()
Retrieve the number of bytes in the body data.
Returns:
long

getBodyType

public java.lang.String getBodyType()
Retrieve the type of the body data.
Specified by:
getBodyType in interface com.ibm.wbi.bcm.sm.message.MQAOAddress
Returns:
String

getExpirationTimeStamp

public java.lang.String getExpirationTimeStamp()
Retrieve the expiration timestamp value.
Returns:
String expiration time stamp.

getExternalID

public java.lang.String getExternalID()
Get the external ID value for this message.
Returns:
String the external ID value for this message.

getFilter

public java.lang.String getFilter(java.lang.String filterName)
Return a specific filter from the table of message filters used by this EpicMessage. 
Parameters:
filterName - java.lang.String
Returns:
java.lang.String

getMsgHeaderVersion

public java.lang.String getMsgHeaderVersion()
Retrieve the attribute value.
Returns:
String

getProcessingCategory

public java.lang.String getProcessingCategory()
Retrieve the attribute value.
Returns:
String

getPublicationTopic

public java.lang.String getPublicationTopic()
Retrieve the attribute value.
Returns:
String

getRelatedSubjectID

public java.lang.String getRelatedSubjectID()
Get the related subject value for this message.
Returns:
String the related subject value for this message.

getSessionID

public java.lang.String getSessionID()
Retrieve the attribute value.
Returns:
String

getTimeStamp

public java.lang.String getTimeStamp()
Retrieve the creation timestamp value.
Returns:
String time stamp.

getTransportCorrelationID

public java.lang.String getTransportCorrelationID()
Retrieve the transport correlation for this message.
Returns:
String the transport correlation id for this message.

getTransportMessageID

public java.lang.String getTransportMessageID()
Retrieve the transport correlation for this message.
Returns:
String the transport message id for this message.

getUserArea

public java.lang.String getUserArea()
Retrieve the attribute value.
Returns:
String

hashCode

public int hashCode()
return the hashcode - used to index queues etc. in hashtables
Specified by:
hashCode in interface com.ibm.wbi.bcm.sm.message.MQAOAddress
Overrides:
hashCode in class java.lang.Object
Tags copied from interface: com.ibm.wbi.bcm.sm.message.MQAOAddress
Returns:
int

hexToBin

public static byte[] hexToBin(java.lang.String iHex)
throws com.ibm.wbi.bcm.common.BCMException
Converts a hex string into a byte array.
Parameters:
iHex - java.lang.String string containing the hex data (2 characters per byte)
Returns:
byte[]
Throws:
com.ibm.wbi.bcm.common.BCMException - - if the string does not contain a string that can be converted

isHexString

public static boolean isHexString(java.lang.String iHex)
Tests if the input string is hexString or not. If string starts with 0x or 0X it is hexString.
Parameters:
iHex - java.lang.String string containing the hex data (2 characters per byte)
Returns:
Boolean true if input is hexString, else false.

main

public static void main(java.lang.String[] args)
Test driver for EpicMessage. Run EpicMessage$Test for the test driver.

parseXMLToAttrib

public void parseXMLToAttrib(java.lang.String bcmXMLMsg)
throws com.ibm.wbi.bcm.common.BCMException
Parses the XMLDocument and sets the field attibute values.
Parameters:
bcmXMLMsg - XML Document
Throws:
com.ibm.wbi.bcm.common.BCMException - catch parser errors

setBodyCategory

public void setBodyCategory(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value
Throws:
AdapterException - re-throws

setBodyData

public void setBodyData(java.lang.String XMLDocument)
Set the attribute value.
Parameters:
value - xml value

setBodySize

protected void setBodySize(long value)
Set the attribute value.
Parameters:
value - xml value

setBodyType

public void setBodyType(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setExpirationTimeStamp

public void setExpirationTimeStamp(java.lang.String value)
Set the expiration timestamp value.
Parameters:
value - expirationtimestamp value

setExternalID

public void setExternalID(java.lang.String newValue)
Set the external ID value for this message.
Parameters:
String - the external ID value for this message.

setMsgHeaderVersion

public void setMsgHeaderVersion(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value
Returns:
void

setProcessingCategory

public void setProcessingCategory(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setPublicationTopic

public void setPublicationTopic(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setRelatedSubjectID

public void setRelatedSubjectID(java.lang.String newValue)
Set the related subject value for this message.
Parameters:
String - the related subject value for this message.

setSessionID

public void setSessionID(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setTimeStamp

public void setTimeStamp(java.lang.String value)
Set the creation timestamp value.
Parameters:
value - timestamp value

setTransportCorrelationID

public void setTransportCorrelationID(byte[] newValue)
Set the transport correlation for this message.
Parameters:
Byte[] - the transport correlation for this message

setTransportCorrelationID

public void setTransportCorrelationID(java.lang.String newValue)
throws com.ibm.wbi.bcm.common.BCMException
Set the transport correlation ID for this message.
Parameters:
newValue - The transport correlation id value to be set.
Throws:
com.ibm.wbi.bcm.common.BCMException - if the input string is in an invalid format

setTransportMessageID

public void setTransportMessageID(java.lang.String newValue)
throws com.ibm.wbi.bcm.common.BCMException
Set the transport message ID for this message.
Parameters:
newValue - The transport message id value to be set.
Throws:
com.ibm.wbi.bcm.common.BCMException - if the input string is in an invalid format

setUniqueMsgID

public void setUniqueMsgID(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setUserArea

public void setUserArea(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

toString

public java.lang.String toString()
Print attribute data.
Overrides:
toString in class java.lang.Object
Returns:
String

verifyByteValue

protected byte[] verifyByteValue(byte[] newValue)
Check the value of the array to make sure it's OK to copy. Empty arrays will be ignored, all other values will be copied over the existing value.
Parameters:
byte[] - the new value to examine
byte - the existing value to compare to

verifyStringValue

protected java.lang.String verifyStringValue(java.lang.String newValue)
Check the value of the string to make sure it's OK to copy. Empty strings will be ignored, all other values will be copied over the existing value.
Parameters:
String - the new string value to examine.

getLogMsgID

public java.lang.String getLogMsgID()
Retrieve the attribute value.
Returns:
String

setLogMsgID

public void setLogMsgID(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

getApplicationID

public java.lang.String getApplicationID()
Retrieve the attribute value.
Returns:
String

getHostNameIP

public java.lang.String getHostNameIP()
Retrieve the attribute value.
Returns:
String

getInternalTradingPartnerID

public java.lang.String getInternalTradingPartnerID()
Retrieve the attribute value.
Returns:
String

getInternalUserID

public java.lang.String getInternalUserID()
Get the internal ID value for this message.
Returns:
String the internal ID value for this message.

getLogMessageType

public java.lang.String getLogMessageType()
Retrieve the attribute value.
Returns:
String

getLogPriority

public java.lang.String getLogPriority()
Retrieve the attribute value.
Returns:
String

getModelID

public java.lang.String getModelID()
Retrieve the attribute value.
Returns:
String

getProcessCorrelationID

public java.lang.String getProcessCorrelationID()
Retrieve the process correlation ID for this message.
Returns:
String

getProcessInstanceID

public java.lang.String getProcessInstanceID()
Retrieve the attribute value.
Returns:
String

getSenderInstanceID

public java.lang.String getSenderInstanceID()
Retrieve the attribute value.
Returns:
String

getSubSystemID

public java.lang.String getSubSystemID()
Retrieve the attribute value.
Returns:
String

getTransactionRequired

public java.lang.String getTransactionRequired()
Retrieve the attribute value.
Returns:
String

getUserSecurityArea

public byte[] getUserSecurityArea()
Retrieve the body signature for this message.
Returns:
Byte[] the userSecurityArea for this message

setApplicationID

public void setApplicationID(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setHostNameIP

public void setHostNameIP(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setInternalTradingPartnerID

public void setInternalTradingPartnerID(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setInternalUserID

public void setInternalUserID(java.lang.String newValue)
Set the internal ID value for this message.
Parameters:
String - the internal ID value for this message.

setLogMessageType

public void setLogMessageType(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setLogPriority

public void setLogPriority(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setModelID

public void setModelID(java.lang.String value)
Set the attribute value.
Parameters:
value - value

setProcessCorrelationID

public void setProcessCorrelationID(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setProcessInstanceID

public void setProcessInstanceID(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setSenderInstanceID

public void setSenderInstanceID(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setSubSystemID

public void setSubSystemID(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setTransactionRequired

public void setTransactionRequired(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value

setUserSecurityArea

public void setUserSecurityArea(byte[] newValue)
Set the body signature for this message.
Parameters:
Byte[] - The user security Area for this message.

setUserSecurityArea

public void setUserSecurityArea(java.lang.String newValue)
Set the body signature for this message.
Parameters:
newValue - This body signature value will be converted to a byte[].

setUserSecurityAreaHexString

public void setUserSecurityAreaHexString(java.lang.String newValue)
throws com.ibm.wbi.bcm.common.BCMException
Set the body signature for this message.
Parameters:
newValue - This body signature hex string representation will be converted to a byte[].
Throws:
com.ibm.wbi.bcm.common.BCMException - if the input string is in an invalid format

copy

public static BCMMessage copy(BCMMessage copy)
Make a copy of a message.

createXMLBCMMsg

public java.lang.String createXMLBCMMsg()
throws com.ibm.wbi.bcm.common.BCMException
Create XMLDocument from the attributes.
Returns:
String XML Document created from attributes.
Throws:
com.ibm.wbi.bcm.common.BCMException - catch invalid attribute data

getEventType

public java.lang.String getEventType()
Retrieve the attribute value of the secondary type.
Returns:
String

setEventType

public void setEventType(java.lang.String value)
Set the attribute value.
Parameters:
value - xml value