com.opencloud.slee.resources.mm7
Interface ResponseEvent

All Known Subinterfaces:
CancelResponseEvent, DeliverResponseEvent, DeliveryReportResponseEvent, ExtendedCancelResponseEvent, ExtendedReplaceResponseEvent, ReadReplyReportResponseEvent, ReplaceResponseEvent, SubmitResponseEvent

public interface ResponseEvent

Superinterface for all events fired in response to a SBB-initiated request. Subinterfaces specialize this interface to provide type-specific getXXXActivity() and getXXXResponse() methods.

In general, there are three possible response scenarios:

  1. Success response: no SOAP fault is present, getResponse() returns the success response, and the subinterface's getXXXResponse() returns the (typecast) success response.
  2. MM7-level failure: a SOAP fault is present, getResponse() returns a subinterface of ErrorResponse corresponding to the MM7 error response carried in the SOAP fault, and the subinterface's getXXXResponse() returns null.
  3. SOAP-level fault (without a MM7 error response): a SOAP fault is present, getResponse() returns null, and the subinterface's getXXXResponse() returns null.

HTTP-level errors and unparseable response are translated into appropriate SOAP-level failures.


Method Summary
 MM7Activity getActivity()
          Get the underlying activity for this event.
 Response getResponse()
          Get the MM7 message provided in the response.
 SOAPFault getSOAPFault()
          Get the SOAP-level fault information, if any.
 

Method Detail

getActivity

MM7Activity getActivity()
Get the underlying activity for this event.

Returns:
the activity object

getSOAPFault

SOAPFault getSOAPFault()
Get the SOAP-level fault information, if any.

Returns:
a SOAPFault object, or null if no SOAP fault was received.

getResponse

Response getResponse()
Get the MM7 message provided in the response. This will either be a subclass of ErrorResponse, or an implementation of the appropriate Response subclass corresponding to the request that was made.

Returns:
the response, or null if a SOAP-level fault with no MM7 error response was received.