|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The XOCPApplicationSession interface represents an XOCP application session.
Inner Class Summary | |
static interface |
XOCPApplicationSession.CreateException
A CreateException is thrown if conversation creation fails. |
static interface |
XOCPApplicationSession.InitException
An InitException is thrown if XOCPApplicationSession initialization fails. |
static interface |
XOCPApplicationSession.RegisterException
A RegisterException is thrown if an error occurred during registration. |
static interface |
XOCPApplicationSession.ShutDownException
A ShutDownException is thrown if XOCPApplicationSession shutdown fails. |
Method Summary | |
Conversation |
createConversation(java.lang.String caId,
java.lang.String myRole,
long timeout)
Creates a conversation of the specified Collaboration Agreement global identifier and conversation role, and with the specified timeout. |
CAInstance |
getCA(java.lang.String caId)
Gets the Collaboration Agreement with this global identifier. |
java.lang.String |
getCAId(java.util.Properties properties)
Gets the global identifier of the Collaboration Agreement associated with this session based on the specified properties. |
java.lang.String[] |
getCAIds()
Gets the global identifiers of all the Collaboration Agreements for this session. |
Conversation |
getConversation(java.lang.String conversationId)
Gets the conversation with the specified conversation ID. |
Conversation[] |
getConversations()
Gets all of the conversations in which this XOCP application session is involved, including both conversations initiated and conversations in which the collaborator participated using this XOCP application session. |
java.lang.String |
getDeliveryChannelName()
Gets the name of the Delivery Channel associated with this XOCP application session. |
java.lang.String |
getTradingPartner()
Gets the name of the trading partner associated with this XOCP application session. |
boolean |
hasConversation(java.lang.String conversationId)
Determines whether the specified conversation exists (true) or not (false). |
boolean |
hasMessageErrorListener()
Determines whether the message error handler was registered for this XOCP application session (true) or not (false). |
boolean |
hasMessageListener(java.lang.String caId,
java.lang.String myRole)
Determines whether the message listener was registered for the specified Collaboration Agreement global identifier (true) or not (false). |
void |
registerMessageErrorListener(XOCPMessageErrorListener listener)
Registers a message error handler with this XOCP application session. |
void |
registerMessageListener(java.lang.String caId,
java.lang.String myRole,
XOCPMessageListener listener)
Registers a message listener with this XOCP application session. |
void |
shutDown()
Shuts down the XOCP application session. |
XOCPMessageErrorListener |
unregisterMessageErrorListener()
Unregisters the message error handler from this XOCP application session. |
XOCPMessageListener |
unregisterMessageListener(java.lang.String caId,
java.lang.String myRole)
Unregisters the message listener from this XOCP application session. |
Method Detail |
public CAInstance getCA(java.lang.String caId)
caId
- Collaboration Agreement global identifier.public java.lang.String getCAId(java.util.Properties properties)
BusinessProcessName
- name of the Business Process.
BusinessProcessVersion
- version of the Business Process.
otherTradingPartner
- the other Trading Partner in this CA.
toRole
- the role of the other Trading Partner.
properties
- Properties uniquely identifying the CApublic java.lang.String[] getCAIds()
public java.lang.String getDeliveryChannelName()
public java.lang.String getTradingPartner()
public Conversation createConversation(java.lang.String caId, java.lang.String myRole, long timeout) throws XOCPApplicationSession.CreateException
caId
- Collaboration Agreement global identifier.myRole
- Conversation role.timeout
- Conversation timeout, in seconds. This value overrides
the default value defined with the conversation definition in the repository.
Specify zero (0) to use the value defined in the repository, or to use no timeout
if 0 is also set in the repository.public Conversation getConversation(java.lang.String conversationId)
conversationId
- Conversation ID of the conversation to access.public Conversation[] getConversations()
public boolean hasConversation(java.lang.String conversationId)
conversationId
- Conversation ID to check.public boolean hasMessageListener(java.lang.String caId, java.lang.String myRole)
caId
- Collaboration Agreement global identifier.myRole
- Conversation role.public void registerMessageListener(java.lang.String caId, java.lang.String myRole, XOCPMessageListener listener) throws XOCPApplicationSession.RegisterException
caId
- Global identifier of Collaboration Agreement for which this factory can create listener.myRole
- Conversation role.listener
- Message listener.public XOCPMessageListener unregisterMessageListener(java.lang.String caId, java.lang.String myRole) throws XOCPApplicationSession.RegisterException
caId
- Collaboration Agreement global identifier.myRole
- Conversation role.public boolean hasMessageErrorListener()
public void registerMessageErrorListener(XOCPMessageErrorListener listener) throws XOCPApplicationSession.RegisterException
handler
- Message error handler.public XOCPMessageErrorListener unregisterMessageErrorListener() throws XOCPApplicationSession.RegisterException
public void shutDown() throws XOCPApplicationSession.ShutDownException, B2BException
|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |