com.ibm.websphere.sibx.smobo
Interface ServiceMessageObject
All Superinterfaces:
commonj.sdo.DataObject, java.io.Serializable
- public interface ServiceMessageObject
- extends commonj.sdo.DataObject
The following features are supported:
Field Summary
Modifier and Type | Field and Description |
---|---|
|
$sccsid
|
|
COPYRIGHT
|
|
SMO_EXCEPTION_TYPE
This is the value set into the MessageType field of the SMOHeader
when the SMO represents an exception message.
|
|
SMO_REQUEST_TYPE
This is the value set into the MessageType field of the SMOHeader
when the SMO represents a request message.
|
|
SMO_RESPONSE_TYPE
This is the value set into the MessageType field of the SMOHeader
when the SMO represents a response message.
|
|
UNMODELLED_FAULT_ORIGIN
This is the value set into the failInfo.origin field for an
unmodelled fault
|
Method Summary
Modifier and Type | Method and Description |
---|---|
addAttachment(java.lang.String contentID,java.lang.String contentType,byte[] data)
Creates a new attachment with the provided content and adds it to
the ServiceMessageObject.
|
|
getAttachment(java.lang.String contentID)
Searches the ServiceMessageObject for an attachment with the given 'contentID'
and returns the attachment.
|
|
|
getAttachmentData(java.lang.String contentID)
Searches the ServiceMessageObject for an attachment with the given 'contentID'
and returns the value of the '
Data ' attribute of the attachment.
|
|
getAttachments()
Returns the value of the 'Attachments' containment reference list.
|
|
getBody()
Returns the value of the 'Body' containment reference.
|
|
getBodyForSCAMessage(boolean isFaultMessage,boolean copySMOBody)
Deprecated.
|
|
getBodyPopulated()
Deprecated.
|
getContext()
Returns the value of the 'Context' containment reference.
|
|
getHeaders()
Returns the value of the 'Headers' containment reference.
|
|
|
getSoapFaultInfoPopulated()
Deprecated.
|
removeAttachment(java.lang.String contentID)
Searches the ServiceMessageObject for an attachment with the given 'contentID'
and removes the attachment from the ServiceMessageObject.
|
|
|
saveSCAData(com.ibm.wsspi.sca.message.Message donorSCAMessage,ServiceMessageObject requestSMO)
Deprecated.
|
|
setBody(java.lang.Object value)
Sets the value of the '
Body ' containment reference.
|
|
setBodyPopulated()
Deprecated.
|
|
setContext(ContextType value)
Sets the value of the '
Context ' containment reference.
|
|
setHeaders(HeadersType value)
Sets the value of the '
Headers ' containment reference.
|
|
setSoapFaultInfoPopulated()
Deprecated.
|
Methods inherited from interface commonj.sdo.DataObject |
---|
createDataObject, createDataObject, createDataObject, createDataObject, createDataObject, createDataObject, delete, detach, get, get, get, getBigDecimal, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getBytes, getBytes, getBytes, getChangeSummary, getChar, getChar, getChar, getContainer, getContainmentProperty, getDataGraph, getDataObject, getDataObject, getDataObject, getDate, getDate, getDate, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInstanceProperties, getInstanceProperty, getInt, getInt, getInt, getList, getList, getList, getLong, getLong, getLong, getProperty, getRootObject, getSequence, getSequence, getSequence, getSequence, getShort, getShort, getShort, getString, getString, getString, getType, isSet, isSet, isSet, set, set, set, setBigDecimal, setBigDecimal, setBigDecimal, setBigInteger, setBigInteger, setBigInteger, setBoolean, setBoolean, setBoolean, setByte, setByte, setByte, setBytes, setBytes, setBytes, setChar, setChar, setChar, setDataObject, setDataObject, setDataObject, setDate, setDate, setDate, setDouble, setDouble, setDouble, setFloat, setFloat, setFloat, setInt, setInt, setInt, setList, setList, setList, setLong, setLong, setLong, setShort, setShort, setShort, setString, setString, setString, unset, unset, unset |
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
$sccsid
- static final java.lang.String $sccsid
See Also:
SMO_REQUEST_TYPE
- static final java.lang.String SMO_REQUEST_TYPE
This is the value set into the MessageType field of the SMOHeader
when the SMO represents a request message.
See Also:
SMO_RESPONSE_TYPE
- static final java.lang.String SMO_RESPONSE_TYPE
This is the value set into the MessageType field of the SMOHeader
when the SMO represents a response message.
See Also:
SMO_EXCEPTION_TYPE
- static final java.lang.String SMO_EXCEPTION_TYPE
This is the value set into the MessageType field of the SMOHeader
when the SMO represents an exception message.
See Also:
UNMODELLED_FAULT_ORIGIN
- static final java.lang.String UNMODELLED_FAULT_ORIGIN
This is the value set into the failInfo.origin field for an
unmodelled fault
See Also:
Method Detail
getContext
- ContextType getContext()
Returns the value of the 'Context' containment reference.
This context folder contains both the transient and correlation contexts.
setContext
- void setContext(ContextType value)
Sets the value of the '
Context
' containment reference.
getHeaders
- HeadersType getHeaders()
Returns the value of the 'Headers' containment reference.
This headers folder contains all of the other headers, fault information and message properties.
setHeaders
- void setHeaders(HeadersType value)
Sets the value of the '
Headers
' containment reference.
getBody
- java.lang.Object getBody()
Returns the value of the 'Body' containment reference.
This body is the payload of the message and might typically contain application data.
setBody
- void setBody(java.lang.Object value)
Sets the value of the '
Body
' containment reference.
Parameters:
value
- the new value of the 'Body' containment reference. Note that
this must be a commonj.sdo.DataObject rather than a simple java.lang.Object. See Also:
getAttachments
- java.util.List<AttachmentType> getAttachments( )
Returns the value of the 'Attachments' containment reference list.
The list contents are of type
AttachmentType
.
Returns:
the value of the 'Attachments' containment reference list.
getBodyForSCAMessage
- java.lang.Object getBodyForSCAMessage( boolean isFaultMessage,
- boolean copySMOBody)
Deprecated.
non javadoc
Returns:
getBodyPopulated
- boolean getBodyPopulated()
Deprecated.
non javadoc
Returns:
setBodyPopulated
- void setBodyPopulated()
Deprecated.
non javadoc
getSoapFaultInfoPopulated
- boolean getSoapFaultInfoPopulated( )
Deprecated.
non javadoc
Returns:
setSoapFaultInfoPopulated
- void setSoapFaultInfoPopulated( )
Deprecated.
non javadoc
saveSCAData
- void saveSCAData(com.ibm.wsspi.sca.message.Message donorSCAMessage,
- ServiceMessageObject requestSMO)
Deprecated.
non javadoc
addAttachment
- AttachmentType addAttachment(java.lang.String contentID,
- java.lang.String contentType,
- byte[] data)
Creates a new attachment with the provided content and adds it to
the ServiceMessageObject.
Parameters:
contentID
- value of the ' Content ID
' attribute. contentType
- the value of the ' Content Type
' attribute. data
- value of the ' Data
' attribute. Returns:
the 'AttachmentType' which was created and added to the ServiceMessageObject.
Throws:
java.lang.IllegalArgumentException
- if the contentID is null, or if the ServiceMessageObject already contains
an attachment with the same contentID. getAttachment
- AttachmentType getAttachment(java.lang.String contentID)
Searches the ServiceMessageObject for an attachment with the given 'contentID'
and returns the attachment.
Parameters:
contentID
- value of the ' Content ID
'
attribute to search for. Returns:
the 'AttachmentType' with the given 'contentID', or null if no such attachment is found.
getAttachmentData
- byte[] getAttachmentData(java.lang.String contentID)
Searches the ServiceMessageObject for an attachment with the given 'contentID'
and returns the value of the '
Data
' attribute of the attachment.
Parameters:
contentID
- value of the ' Content ID
'
attribute to search for. Returns:
the value of the 'Data' attribute of the 'AttachmentType' with the given 'contentID', or null if no such attachment is found.
removeAttachment
- AttachmentType removeAttachment( java.lang.String contentID)
Searches the ServiceMessageObject for an attachment with the given 'contentID'
and removes the attachment from the ServiceMessageObject.
Parameters:
contentID
- value of the ' Content ID
'
attribute to search for. Returns:
the 'AttachmentType' with the given 'contentID' that was removed
from the ServiceMessageObject, or null if no such attachment is found.