public interface JMSDataBinding
extends commonj.connector.runtime.DataBinding
This interface is an extension of commonj.connector.runtime.DataBinding, and presents a JMS-specific view which should be implemented for use in JMS Exports and Imports.
It exposes methods which read and write to and from a JMS message, as well as exporting which type of JMS message is supported.
DataBinding
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
$sccsid |
static int |
ANY_MESSAGE |
static int |
BASE_MESSAGE |
static int |
BYTES_MESSAGE |
static java.lang.String |
COPYRIGHT |
static int |
MAP_MESSAGE |
static int |
OBJECT_MESSAGE |
static int |
STREAM_MESSAGE |
static int |
TEXT_MESSAGE |
Modifier and Type | Method and Description |
---|---|
int |
getMessageType()
Return the message type that is supported by this data
binding.
|
boolean |
isBusinessException()
Queries the DataBinding to determine whether the received
message contains a fault (carried within a
BusinessException).
|
void |
read(javax.jms.Message message)
Read the contents of the incoming JMS Message into a
DataObject.
|
void |
setBusinessException(boolean isBusinessException)
This method is called by the runtime if the outgoing message
contains a BusinessException.
|
void |
write(javax.jms.Message message)
Write the DataObject into an outgoing JMS Message.
|
static final java.lang.String COPYRIGHT
static final java.lang.String $sccsid
static final int ANY_MESSAGE
static final int OBJECT_MESSAGE
static final int TEXT_MESSAGE
static final int BYTES_MESSAGE
static final int STREAM_MESSAGE
static final int MAP_MESSAGE
static final int BASE_MESSAGE
int getMessageType()
void read(javax.jms.Message message) throws javax.jms.JMSException
getDataObject
method is called by the runtime. An implementation of this
method will process the payload of the incoming JMS message
and will parse the data into the appropriate DataObject,
created like this: BOFactory bof =
(BOFactory)ServiceManager.INSTANCE.locateService("com/ibm/websphere/bo/BOFactory");
sampleBO = bof.create("http://namespace", "BOName");
message
- The message whose payload is to be parsed.javax.jms.JMSException
- Thrown if an error occurs
during reading of the message.void write(javax.jms.Message message) throws javax.jms.JMSException
setDataObject
method is called by the
runtime. The supplied message must be of the same type as
returned by getMessageType
. This method will
be the converse of the read
method, and will
serialize the contents of the DataObject the the wire format
in the JMS message.
message
- The message to be populated with the
serialized DataObject.javax.jms.JMSException
- Thrown if an error occurs
during writing of the message.boolean isBusinessException()
void setBusinessException(boolean isBusinessException)
isBusinessException
- True or false, specified by the
caller.