|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
|
+--com.ibm.wbi.bcm.sm.message.BCMMessage
Message holder class for holding the BCM meta-data values plus the application integration message data.
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 |
public static final java.lang.String proprietaryNotice
public static final java.lang.String NONE_DESTINATION
public static final java.lang.String MSGTYPE_APPLICATION
public static final java.lang.String DEFAULT_BODY_CATEGORY
public static final java.lang.String DEFAULT_BODY_TYPE
public static final int ACK_NO
#setAckRequested
,
ACK_NO
public static final java.lang.String ACK_NO_STRING
#setAckRequested
,
ACK_NO
public static final int ACK_YES
#setAckRequested
,
ACK_YES_STRING
public static final java.lang.String ACK_YES_STRING
#setAckRequested
,
ACK_YES
public static final java.lang.String hdrVersion
public static final java.lang.String xmlBodyCategory
protected static java.lang.String linesep
public static final java.lang.String BCMHEADER_BCMCHEADER
public static final java.lang.String BCMHEADER_BODYCATEGORY
public static final java.lang.String BCMHEADER_BODYTYPE
public static final java.lang.String BCMHEADER_CORRELATIONID
public static final java.lang.String BCMHEADER_EPICBODY
public static final java.lang.String BCMHEADER_EXTERNALID
public static final java.lang.String BCMHEADER_HEADER
public static final java.lang.String BCMHEADER_INTERNALID
public static final java.lang.String BCMHEADER_PROCESSINGCATEGORY
public static final java.lang.String BCMHEADER_PUBLICATIONTOPIC
public static final java.lang.String BCMHEADER_RELATEDSUBJECTID
public static final java.lang.String BCMHEADER_REVISION
public static final java.lang.String BCMHEADER_SESSIONID
public static final java.lang.String BCMHEADER_SIZE
public static final java.lang.String BCMHEADER_TIMESTAMPCREATED
public static final java.lang.String BCMHEADER_TIMESTAMPEXPIRED
public static final java.lang.String BCMHEADER_TRANSPORTCORRELATIONID
public static final java.lang.String BCMHEADER_USERAREA
public static final java.lang.String SenderInstanceID
public static final java.lang.String SUBSYSTEMID_DEFAULT
public static final java.lang.String BCMHEADER_APLICATIONID
public static final java.lang.String BCMHEADER_HOSTNAMEIP
public static final java.lang.String BCMHEADER_INTERNALPARTNERID
public static final java.lang.String BCMHEADER_LOGMESSAGEID
public static final java.lang.String BCMHEADER_LOGMESSAGETYPE
public static final java.lang.String BCMHEADER_LOGPRIORITY
public static final java.lang.String BCMHEADER_MODELID
public static final java.lang.String BCMHEADER_PROCESSINSTANCEID
public static final java.lang.String BCMHEADER_SENDERINSTANCEID
public static final java.lang.String BCMHEADER_SUBSYSTEMID
public static final java.lang.String BCMHEADER_TRANSACTIONREQUIRED
public static final java.lang.String BCMHEADER_USERSECURITYAREA
public static final java.lang.String BCMHEADER_EVENTTYPE
Constructor Detail |
public BCMMessage()
public BCMMessage(java.lang.String bcmXMLMessage)
throws com.ibm.wbi.bcm.common.BCMException
epicXMLMessage
- XML String to read all the message parameters from.public BCMMessage(java.lang.String srcID,
java.lang.String messageType)
throws com.ibm.wbi.bcm.common.BCMException
Method Detail |
public boolean addFilter(java.lang.String fieldName,
java.lang.String fieldValue)
fieldName
- java.lang.String - Name of the field
fieldValue
- java.lang.String - Value of the field to matchpublic static java.lang.String binToHex(byte[] bin)
bin
- The byte[] to convert.public void clearFilters()
public void delFilter(java.lang.String filterName)
filterName
- java.lang.Stringpublic boolean equals(java.lang.Object obj)
public java.util.Enumeration getAllFilterNames()
public java.lang.String getApplicationName()
public java.lang.String getBodyCategory()
public java.lang.String getBodyData()
protected long getBodySize()
public java.lang.String getBodyType()
public java.lang.String getExpirationTimeStamp()
public java.lang.String getExternalID()
public java.lang.String getFilter(java.lang.String filterName)
filterName
- java.lang.Stringpublic java.lang.String getMsgHeaderVersion()
public java.lang.String getProcessingCategory()
public java.lang.String getPublicationTopic()
public java.lang.String getRelatedSubjectID()
public java.lang.String getSessionID()
public java.lang.String getTimeStamp()
public java.lang.String getTransportCorrelationID()
public java.lang.String getTransportMessageID()
public java.lang.String getUserArea()
public int hashCode()
public static byte[] hexToBin(java.lang.String iHex)
throws com.ibm.wbi.bcm.common.BCMException
iHex
- java.lang.String string containing the hex data (2 characters
per byte)public static boolean isHexString(java.lang.String iHex)
iHex
- java.lang.String string containing the hex data (2 characters
per byte)public static void main(java.lang.String[] args)
public void parseXMLToAttrib(java.lang.String bcmXMLMsg)
throws com.ibm.wbi.bcm.common.BCMException
bcmXMLMsg
- XML Documentpublic void setBodyCategory(java.lang.String value)
value
- xml valuepublic void setBodyData(java.lang.String XMLDocument)
value
- xml valueprotected void setBodySize(long value)
value
- xml valuepublic void setBodyType(java.lang.String value)
value
- xml valuepublic void setExpirationTimeStamp(java.lang.String value)
value
- expirationtimestamp valuepublic void setExternalID(java.lang.String newValue)
String
- the external ID value for this message.public void setMsgHeaderVersion(java.lang.String value)
value
- xml valuepublic void setProcessingCategory(java.lang.String value)
value
- xml valuepublic void setPublicationTopic(java.lang.String value)
value
- xml valuepublic void setRelatedSubjectID(java.lang.String newValue)
String
- the related subject value for this message.public void setSessionID(java.lang.String value)
value
- xml valuepublic void setTimeStamp(java.lang.String value)
value
- timestamp valuepublic void setTransportCorrelationID(byte[] newValue)
Byte[]
- the transport correlation for this messagepublic void setTransportCorrelationID(java.lang.String newValue)
throws com.ibm.wbi.bcm.common.BCMException
newValue
- The transport correlation id value to be set.public void setTransportMessageID(java.lang.String newValue)
throws com.ibm.wbi.bcm.common.BCMException
newValue
- The transport message id value to be set.public void setUniqueMsgID(java.lang.String value)
value
- xml valuepublic void setUserArea(java.lang.String value)
value
- xml valuepublic java.lang.String toString()
protected byte[] verifyByteValue(byte[] newValue)
byte[]
- the new value to examine
byte
- the existing value to compare toprotected java.lang.String verifyStringValue(java.lang.String newValue)
String
- the new string value to examine.public java.lang.String getLogMsgID()
public void setLogMsgID(java.lang.String value)
value
- xml valuepublic java.lang.String getApplicationID()
public java.lang.String getHostNameIP()
public java.lang.String getInternalTradingPartnerID()
public java.lang.String getInternalUserID()
public java.lang.String getLogMessageType()
public java.lang.String getLogPriority()
public java.lang.String getModelID()
public java.lang.String getProcessCorrelationID()
public java.lang.String getProcessInstanceID()
public java.lang.String getSenderInstanceID()
public java.lang.String getSubSystemID()
public java.lang.String getTransactionRequired()
public byte[] getUserSecurityArea()
public void setApplicationID(java.lang.String value)
value
- xml valuepublic void setHostNameIP(java.lang.String value)
value
- xml valuepublic void setInternalTradingPartnerID(java.lang.String value)
value
- xml valuepublic void setInternalUserID(java.lang.String newValue)
String
- the internal ID value for this message.public void setLogMessageType(java.lang.String value)
value
- xml valuepublic void setLogPriority(java.lang.String value)
value
- xml valuepublic void setModelID(java.lang.String value)
value
- valuepublic void setProcessCorrelationID(java.lang.String value)
value
- xml valuepublic void setProcessInstanceID(java.lang.String value)
value
- xml valuepublic void setSenderInstanceID(java.lang.String value)
value
- xml valuepublic void setSubSystemID(java.lang.String value)
value
- xml valuepublic void setTransactionRequired(java.lang.String value)
value
- xml valuepublic void setUserSecurityArea(byte[] newValue)
Byte[]
- The user security Area for this message.public void setUserSecurityArea(java.lang.String newValue)
newValue
- This body signature value will be converted to a byte[].public void setUserSecurityAreaHexString(java.lang.String newValue)
throws com.ibm.wbi.bcm.common.BCMException
newValue
- This body signature hex string representation will be
converted to a byte[].public static BCMMessage copy(BCMMessage copy)
public java.lang.String createXMLBCMMsg()
throws com.ibm.wbi.bcm.common.BCMException
public java.lang.String getEventType()
public void setEventType(java.lang.String value)
value
- xml value
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |