com.ibm.websphere.sib
Class SIMessageFactory
- java.lang.Object
com.ibm.websphere.sib.SIMessageFactory
- public abstract class SIMessageFactory
- extends java.lang.Object
Constructor Summary
Constructor and Description |
---|
SIMessageFactory()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
createSIMessage(commonj.sdo.DataGraph dataGraph,java.lang.String format)
Create a new SIMessage whose content is represented by the given
SDO DataGraph.
|
|
getInstance()
Get the singleton SIMessageFactory which is to be used for
creating SIMessage instances.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail
SIMessageFactory
- public SIMessageFactory()
Method Detail
getInstance
- public static SIMessageFactory getInstance( )
Get the singleton SIMessageFactory which is to be used for
creating SIMessage instances.
Returns:
The SIMessageFactory
createSIMessage
- public abstract SIMessage createSIMessage( commonj.sdo.DataGraph dataGraph,
- java.lang.String format)
- throws SIMessageDomainNotSupportedException
- SIDataGraphSchemaNotFoundException
- SIDataGraphFormatMismatchException
- SIMessageException
Create a new SIMessage whose content is represented by the given
SDO DataGraph.
The SDO version of the DataGraph passed in must be Version 1.
The DataGraph passed in can only come from another SIMessage
or have been constructed using the SIDataGraphFactory.
Parameters:
dataGraph
- The SDO DataGraph which represents the message content.
Must be specified as null if the format parameter is
SIApiConstants.JMS_FORMAT format
- The message format describing the DataGraph model. Returns:
SIMessage The new SIMessage.
Throws:
java.lang.NullPointerException
- is thrown if either the dataGraph or format
parameter is null. Note that the dataGraph is
permitted to be null if the format parameter is
SIApiConstants.JMS_FORMAT. SIMessageDomainNotSupportedException
- is thrown if the message domain
indicated by the format is not supported. SIDataGraphSchemaNotFoundException
- may be thrown if a schema indicated
by the given format is not available. SIDataGraphFormatMismatchException
- may be thrown if the given format
is not compatible with the given DataGraph. SIMessageException
- is thrown if the SIMessage could not be created
for any other reason. The linked Exception(s)
indicate the underlying problem.