com.opencloud.slee.resources.mm7
Interface VASPProvider

All Superinterfaces:

MM7Provider

public interface VASPProvider
extends MM7Provider

Provides the SBB interface for a MM7 RA acting as a MMS VASP. An implementation of this object is bound into JNDI for use by SBBs. Methods on this interface allow SBBs to initiate new request transactions with a peer Relay Server.

In general, methods on this interface send requests and create a new activity that is used to deliver the corresponding response event. Delivery of events to new activities is deferred until after the current transaction commits; this makes it safe to attach a SBB to the newly created activity in the same transaction without running the chance of missing an event.

Method Summary

CancelActivity	sendCancelRequest(java.net.URL rsURL, MM7Address sender, java.lang.String cancelID, CancelRequestParameters params) Create a new CancelActivity and send a new Submit Request to the peer RS.
CancelActivity	sendCancelRequest(java.net.URL rsURL, java.lang.String vaspID, java.lang.String vasID, MM7Address sender, java.lang.String cancelID, CancelRequestParameters params) Create a new CancelActivity and send a new Submit Request to the peer RS.
ExtendedCancelActivity	sendExtendedCancelRequest(java.net.URL rsURL, MM7Address sender, java.lang.String cancelID) Create a new ExtendedCancelActivity and send a new Extended Cancel Request to the peer RS.
ExtendedCancelActivity	sendExtendedCancelRequest(java.net.URL rsURL, java.lang.String vaspID, java.lang.String vasID, MM7Address sender, java.lang.String cancelID) Create a new ExtendedCancelActivity and send a new Extended Cancel Request to the peer RS.
ExtendedReplaceActivity	sendExtendedReplaceRequest(java.net.URL rsURL, ExtendedReplaceRequestParameters params) Create a new ExtendedReplaceActivity and send a new Replace Request to the peer RS.
ExtendedReplaceActivity	sendExtendedReplaceRequest(java.net.URL rsURL, java.lang.String vaspID, java.lang.String vasID, ExtendedReplaceRequestParameters params) Create a new ExtendedReplaceActivity and send a new Replace Request to the peer RS.
ReplaceActivity	sendReplaceRequest(java.net.URL rsURL, MM7Address sender, java.lang.String messageID, ReplaceRequestParameters params) Create a new ReplaceActivity and send a new Replace Request to the peer RS.
ReplaceActivity	sendReplaceRequest(java.net.URL rsURL, java.lang.String vaspID, java.lang.String vasID, MM7Address sender, java.lang.String messageID, ReplaceRequestParameters params) Create a new ReplaceActivity and send a new Replace Request to the peer RS.
SubmitActivity	sendSubmitRequest(java.net.URL rsURL, MM7Address sender, SubmitRequestParameters params) Create a new SubmitActivity and send a new Submit Request to the peer RS.
SubmitActivity	sendSubmitRequest(java.net.URL rsURL, java.lang.String vaspID, java.lang.String vasID, MM7Address sender, SubmitRequestParameters params) Create a new SubmitActivity and send a new Submit Request to the peer RS.

Method Detail

sendSubmitRequest

SubmitActivity sendSubmitRequest(java.net.URL rsURL,
                                 MM7Address sender,
                                 SubmitRequestParameters params)
                                 throws java.io.IOException,
                                        ValidationException,
                                        javax.slee.SLEEException

Create a new SubmitActivity and send a new Submit Request to the peer RS. If no exception is thrown, a response will eventually appear as a SubmitResponseEvent on the newly created activity.

Parameters:

rsURL - the URL of the peer Relay/Server, eg. http://host:port/path.

sender - the address of the sender, or null to use the RA default

params - parameters of the SubmitRequest to send

Returns:

the SubmitActivity the response will be delivered to.

Throws:

java.io.IOException - if streaming the request to SOAP form failed (for example, attached content could not be encoded) or if rsURL is not valid (eg. unsupported protocol).

ValidationException - if a component of the request is invalid.

javax.slee.SLEEException - if the SLEE could not send the request.

sendSubmitRequest

SubmitActivity sendSubmitRequest(java.net.URL rsURL,
                                 java.lang.String vaspID,
                                 java.lang.String vasID,
                                 MM7Address sender,
                                 SubmitRequestParameters params)
                                 throws java.io.IOException,
                                        ValidationException,
                                        javax.slee.SLEEException

Create a new SubmitActivity and send a new Submit Request to the peer RS. If no exception is thrown, a response will eventually appear as a SubmitResponseEvent on the newly created activity.

Parameters:

rsURL - the URL of the peer Relay/Server, eg. http://host:port/path.

vaspID - the VASP ID of the VASP, or null to use the RA default

vasID - the VAS ID of the VASP, or null to use the RA default

sender - the address of the sender, or null to use the RA default

params - parameters of the SubmitRequest to send

Returns:

the SubmitActivity the response will be delivered to.

Throws:

java.io.IOException - if streaming the request to SOAP form failed (for example, attached content could not be encoded) or if rsURL is not valid (eg. unsupported protocol).

ValidationException - if a component of the request is invalid

javax.slee.SLEEException - if the SLEE could not send the request.

sendCancelRequest

CancelActivity sendCancelRequest(java.net.URL rsURL,
                                 MM7Address sender,
                                 java.lang.String cancelID,
                                 CancelRequestParameters params)
                                 throws java.io.IOException,
                                        ValidationException,
                                        javax.slee.SLEEException

Create a new CancelActivity and send a new Submit Request to the peer RS. If no exception is thrown, a response will eventually appear as a CancelResponseEvent on the newly created activity.

Parameters:

rsURL - the URL of the peer Relay/Server, eg. http://host:port/path.

sender - the address of the sender, or null to use the RA default

cancelID - the message ID to cancel

params - parameters of the CancelRequest to send

Returns:

the CancelActivity the response will be delivered to.

Throws:

java.io.IOException - if streaming the request to SOAP form failed (for example, attached content could not be encoded) or if rsURL is not valid (eg. unsupported protocol).

ValidationException - if a component of the request is invalid

javax.slee.SLEEException - if the SLEE could not send the request.

sendCancelRequest

CancelActivity sendCancelRequest(java.net.URL rsURL,
                                 java.lang.String vaspID,
                                 java.lang.String vasID,
                                 MM7Address sender,
                                 java.lang.String cancelID,
                                 CancelRequestParameters params)
                                 throws java.io.IOException,
                                        ValidationException,
                                        javax.slee.SLEEException

Create a new CancelActivity and send a new Submit Request to the peer RS. If no exception is thrown, a response will eventually appear as a CancelResponseEvent on the newly created activity.

Parameters:

rsURL - the URL of the peer Relay/Server, eg. http://host:port/path.

vaspID - the VASP ID of the VASP, or null to use the RA default

vasID - the VAS ID of the VASP, or null to use the RA default

sender - the address of the sender, or null to use the RA default

cancelID - the message ID to cancel

params - parameters of the CancelRequest to send

Returns:

the CancelActivity the response will be delivered to.

Throws:

java.io.IOException - if streaming the request to SOAP form failed (for example, attached content could not be encoded) or if rsURL is not valid (eg. unsupported protocol).

ValidationException - if a component of the request is invalid

javax.slee.SLEEException - if the SLEE could not send the request.

sendExtendedCancelRequest

ExtendedCancelActivity sendExtendedCancelRequest(java.net.URL rsURL,
                                                 MM7Address sender,
                                                 java.lang.String cancelID)
                                                 throws java.io.IOException,
                                                        ValidationException,
                                                        javax.slee.SLEEException

Create a new ExtendedCancelActivity and send a new Extended Cancel Request to the peer RS. If no exception is thrown, a response will eventually appear as a ExtendedCancelResponseEvent on the newly created activity.

Parameters:

rsURL - the URL of the peer Relay/Server, eg. http://host:port/path.

sender - the address of the sender, or null to use the RA default

cancelID - the message ID to cancel

Returns:

the ExtendedCancelActivity the response will be delivered to.

Throws:

java.io.IOException - if streaming the request to SOAP form failed (for example, attached content could not be encoded) or if rsURL is not valid (eg. unsupported protocol).

ValidationException - if a component of the request is invalid

javax.slee.SLEEException - if the SLEE could not send the request.

Since:

MM7 v. 6.8.0

sendExtendedCancelRequest

ExtendedCancelActivity sendExtendedCancelRequest(java.net.URL rsURL,
                                                 java.lang.String vaspID,
                                                 java.lang.String vasID,
                                                 MM7Address sender,
                                                 java.lang.String cancelID)
                                                 throws java.io.IOException,
                                                        ValidationException,
                                                        javax.slee.SLEEException

Create a new ExtendedCancelActivity and send a new Extended Cancel Request to the peer RS. If no exception is thrown, a response will eventually appear as a ExtendedCancelResponseEvent on the newly created activity.

Parameters:

rsURL - the URL of the peer Relay/Server, eg. http://host:port/path.

vaspID - the VASP ID of the VASP, or null to use the RA default

vasID - the VAS ID of the VASP, or null to use the RA default

sender - the address of the sender, or null to use the RA default

cancelID - the message ID to cancel

Returns:

the ExtendedCancelActivity the response will be delivered to.

Throws:

java.io.IOException - if streaming the request to SOAP form failed (for example, attached content could not be encoded) or if rsURL is not valid (eg. unsupported protocol).

ValidationException - if a component of the request is invalid

javax.slee.SLEEException - if the SLEE could not send the request.

Since:

MM7 v. 6.8.0

sendReplaceRequest

ReplaceActivity sendReplaceRequest(java.net.URL rsURL,
                                   MM7Address sender,
                                   java.lang.String messageID,
                                   ReplaceRequestParameters params)
                                   throws java.io.IOException,
                                          ValidationException,
                                          javax.slee.SLEEException

Create a new ReplaceActivity and send a new Replace Request to the peer RS. If no exception is thrown, a response will eventually appear as a ReplaceResponseEvent on the newly created activity.

Parameters:

rsURL - the URL of the peer Relay/Server, eg. http://host:port/path.

sender - the address of the sender, or null to use the RA default

messageID - the message ID to replace

params - parameters of the Replace Request to send

Returns:

the ReplaceActivity the response will be delivered to.

Throws:

java.io.IOException - if streaming the request to SOAP form failed (for example, attached content could not be encoded) or if rsURL is not valid (eg. unsupported protocol).

ValidationException - if a component of the request is invalid

javax.slee.SLEEException - if the SLEE could not send the request.

java.lang.Exception

sendReplaceRequest

ReplaceActivity sendReplaceRequest(java.net.URL rsURL,
                                   java.lang.String vaspID,
                                   java.lang.String vasID,
                                   MM7Address sender,
                                   java.lang.String messageID,
                                   ReplaceRequestParameters params)
                                   throws java.io.IOException,
                                          ValidationException,
                                          javax.slee.SLEEException

Create a new ReplaceActivity and send a new Replace Request to the peer RS. If no exception is thrown, a response will eventually appear as a ReplaceResponseEvent on the newly created activity.

Parameters:

rsURL - the URL of the peer Relay/Server, eg. http://host:port/path.

vaspID - the VASP ID of the VASP, or null to use the RA default

vasID - the VAS ID of the VASP, or null to use the RA default

sender - the address of the sender, or null to use the RA default

messageID - the message ID to replace

params - parameters of the Replace Request to send

Returns:

the ReplaceActivity the response will be delivered to.

Throws:

java.io.IOException - if streaming the request to SOAP form failed (for example, attached content could not be encoded) or if rsURL is not valid (eg. unsupported protocol).

ValidationException - if a component of the request is invalid

javax.slee.SLEEException - if the SLEE could not send the request.

sendExtendedReplaceRequest

ExtendedReplaceActivity sendExtendedReplaceRequest(java.net.URL rsURL,
                                                   ExtendedReplaceRequestParameters params)
                                                   throws java.io.IOException,
                                                          ValidationException,
                                                          javax.slee.SLEEException

Create a new ExtendedReplaceActivity and send a new Replace Request to the peer RS. If no exception is thrown, a response will eventually appear as a ExtendedReplaceResponseEvent on the newly created activity. Method overrides the VASPID and VASID in params with RA defaults.

Parameters:

rsURL - the URL of the peer Relay/Server, eg. http://host:port/path.

params - parameters of the Extended Replace Request to send

Returns:

the ExtendedReplaceActivity the response will be delivered to.

Throws:

java.io.IOException - if streaming the request to SOAP form failed (for example, attached content could not be encoded) or if rsURL is not valid (eg. unsupported protocol).

ValidationException - if a component of the request is invalid

javax.slee.SLEEException - if the SLEE could not send the request.

java.lang.Exception

Since:

MM7 v. 6.8.0

sendExtendedReplaceRequest

ExtendedReplaceActivity sendExtendedReplaceRequest(java.net.URL rsURL,
                                                   java.lang.String vaspID,
                                                   java.lang.String vasID,
                                                   ExtendedReplaceRequestParameters params)
                                                   throws java.io.IOException,
                                                          ValidationException,
                                                          javax.slee.SLEEException

Create a new ExtendedReplaceActivity and send a new Replace Request to the peer RS. If no exception is thrown, a response will eventually appear as a ExtendedReplaceResponseEvent on the newly created activity. Method overrides the VASPID and VASID in params with given parameters or RA defaults (when parameter is null).

Parameters:

rsURL - the URL of the peer Relay/Server, eg. http://host:port/path.

vaspID - the VASP ID of the VASP, or null to use the RA default

vasID - the VAS ID of the VASP, or null to use the RA default

params - parameters of the Extended Replace Request to send

Returns:

the ExtendedReplaceActivity the response will be delivered to.

Throws:

java.io.IOException - if streaming the request to SOAP form failed (for example, attached content could not be encoded) or if rsURL is not valid (eg. unsupported protocol).

ValidationException - if a component of the request is invalid

javax.slee.SLEEException - if the SLEE could not send the request.

Since:

MM7 v. 6.8.0