org.apache.ode.axis2

## Class MessageExchangeContextImpl

- java.lang.Object
- - org.apache.ode.axis2.MessageExchangeContextImpl

- All Implemented Interfaces:
    MessageExchangeContext

      public class MessageExchangeContextImpl
      extends java.lang.Object
      implements MessageExchangeContext

  Implementation of the ODE `MessageExchangeContext` interface. This class is used by the ODE engine to make invocation of external services using Axis.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `MessageExchangeContextImpl(ODEServer server)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `invokePartner(PartnerRoleMessageExchange partnerRoleMessageExchange)` Invoke a partner.
    `void` | `onAsyncReply(MyRoleMessageExchange myRoleMessageExchange)` Method used to asynchronously deliver to the integration layer the BPEL engine's response to an invocation that could not complete synchronously.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### MessageExchangeContextImpl

          public MessageExchangeContextImpl(ODEServer server)

  - ### Method Detail

    - #### invokePartner

          public void invokePartner(PartnerRoleMessageExchange partnerRoleMessageExchange)
                             throws ContextException

      Description copied from interface: `MessageExchangeContext`

      Invoke a partner. This method is invoked by the BPEL engine when an `<invoke>` construct is encountered. The BPEL engine will only invoke this method from a transactional context. This method MUST NOT block for extended periods (as it is called from within a transaction): to this end, actual invocation may be deferred or a synchronous operation may be decomposed into two asynchronous "legs". The integration layer must provide a response to the message exchange via the `PartnerRoleMessageExchange.reply(Message)`, `PartnerRoleMessageExchange.replyOneWayOk()`, `PartnerRoleMessageExchange#replyWithFailure(FailureType, String, Element)` `PartnerRoleMessageExchange.replyWithFault(javax.xml.namespace.QName, Message)`, or `PartnerRoleMessageExchange.replyAsync()` methods.

      Invocation of reliable, unreliable, and transactional transports should be treated differently. A brief description of how each of these scenarios could be handled follows.

      Reliable transports are transports such as JMS or WS-RM. For these transports, the request should be enrolled in the current transaction. This necessarily implies that the request is deferred until the transaction is committed. It follows that for reliable request-response invocations the response to the invocation will necessarily be processed in a separate transaction.

      Unreliable transports are transports such as HTTP. For these transports, where the operation is not idempotent it is typically required that "at most once" semantics are achieved. To this end the invocation could be noted and deferred until after the transaction is committed.

      Transactional transports are those transports that support transaction propagation. For these transports, the invocation can be processed immediately and the response provided to the engine via the `PartnerRoleMessageExchange.reply(Message)` method.

      Specified by:
        `invokePartner` in interface `MessageExchangeContext`
      Parameters:
        `partnerRoleMessageExchange` - engine-provided partner role message exchange representation, this object is valid only for the duration of the transaction from which the `MessageExchangeContext.invokePartner(PartnerRoleMessageExchange)` method is invoked
      Throws:
        `ContextException` - if the port does not support the operation

    - #### onAsyncReply

          public void onAsyncReply(MyRoleMessageExchange myRoleMessageExchange)
                            throws BpelEngineException

      Description copied from interface: `MessageExchangeContext`
      Method used to asynchronously deliver to the integration layer the BPEL engine's response to an invocation that could not complete synchronously.
      Specified by:
        `onAsyncReply` in interface `MessageExchangeContext`
      Throws:
        `BpelEngineException`
      See Also:
        `MyRoleMessageExchange.invoke(Message)`