com.opencloud.slee.resources.mm7
Interface RSProvider

All Superinterfaces:

MM7Provider

public interface RSProvider
extends MM7Provider

Provides the SBB interface for a MM7 RA acting as a MMS Relay Server. 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 VASP.

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

DeliverActivity	sendDeliverRequest(java.net.URL vaspURL, MM7Address sender, DeliverRequestParameters parameters) Create a new DeliverActivity and send a new Deliver Request to the peer VASP.
DeliverActivity	sendDeliverRequest(java.net.URL vaspURL, java.lang.String rsID, MM7Address sender, DeliverRequestParameters parameters) Create a new DeliverActivity and send a new Deliver Request to the peer VASP.
DeliveryReportActivity	sendDeliveryReportRequest(java.net.URL vaspURL, java.lang.String messageID, MM7Address recipient, MM7Address sender, java.util.Date timestamp, DeliveryReportRequest.MMDeliveryStatus mmStatus, DeliveryReportRequestParameters parameters) Create a new DeliveryReportActivity and send a new Delivery Report Request to the peer VASP.
DeliveryReportActivity	sendDeliveryReportRequest(java.net.URL vaspURL, java.lang.String rsID, java.lang.String messageID, MM7Address recipient, MM7Address sender, java.util.Date timestamp, DeliveryReportRequest.MMDeliveryStatus mmStatus, DeliveryReportRequestParameters parameters) Create a new DeliveryReportActivity and send a new Delivery Report Request to the peer VASP.
ReadReplyReportActivity	sendReadReplyReportRequest(java.net.URL vaspURL, java.lang.String messageID, MM7Address recipient, MM7Address sender, java.util.Date timestamp, ReadReplyReportRequest.MMReadStatus mmStatus, ReadReplyReportRequestParameters parameters) Create a new ReadReplyReportActivity and send a new Read Reply Report Request to the peer VASP.
ReadReplyReportActivity	sendReadReplyReportRequest(java.net.URL vaspURL, java.lang.String rsID, java.lang.String messageID, MM7Address recipient, MM7Address sender, java.util.Date timestamp, ReadReplyReportRequest.MMReadStatus mmStatus, ReadReplyReportRequestParameters parameters) Create a new ReadReplyReportActivity and send a new Read Reply Report Request to the peer VASP.

Method Detail

sendDeliverRequest

DeliverActivity sendDeliverRequest(java.net.URL vaspURL,
                                   MM7Address sender,
                                   DeliverRequestParameters parameters)
                                   throws java.io.IOException,
                                          ValidationException,
                                          javax.slee.SLEEException

Create a new DeliverActivity and send a new Deliver Request to the peer VASP. If no exception is thrown, a response will eventually appear as a DeliverResponseEvent on the newly created activity.

Parameters:

vaspURL - the URL of the peer VASP, eg. http://host:port/path.

sender - the address of the sender of the message described by this DeliverRequest.

parameters - parameters of the DeliverRequest to send

Returns:

the DeliverActivity 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 vaspURL 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.

sendDeliverRequest

DeliverActivity sendDeliverRequest(java.net.URL vaspURL,
                                   java.lang.String rsID,
                                   MM7Address sender,
                                   DeliverRequestParameters parameters)
                                   throws java.io.IOException,
                                          ValidationException,
                                          javax.slee.SLEEException

Create a new DeliverActivity and send a new Deliver Request to the peer VASP. If no exception is thrown, a response will eventually appear as a DeliverResponseEvent on the newly created activity.

Parameters:

vaspURL - the URL of the peer VASP, eg. http://host:port/path.

rsID - the Relay Server ID to use for this request; if null, the RA's default will be used

sender - the address of the sender of the message described by this DeliverRequest.

parameters - parameters of the DeliverRequest to send

Returns:

the DeliverActivity 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 vaspURL 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.

sendDeliveryReportRequest

DeliveryReportActivity sendDeliveryReportRequest(java.net.URL vaspURL,
                                                 java.lang.String messageID,
                                                 MM7Address recipient,
                                                 MM7Address sender,
                                                 java.util.Date timestamp,
                                                 DeliveryReportRequest.MMDeliveryStatus mmStatus,
                                                 DeliveryReportRequestParameters parameters)
                                                 throws java.io.IOException,
                                                        ValidationException,
                                                        javax.slee.SLEEException

Create a new DeliveryReportActivity and send a new Delivery Report Request to the peer VASP. If no exception is thrown, a response will eventually appear as a DeliveryReportResponseEvent on the newly created activity.

Parameters:

vaspURL - the URL of the peer VASP, eg. http://host:port/path.

messageID - the ID of the message this Delivery Report refers to

recipient - the recipient of the message

sender - the sender of the message

timestamp - the time of delivery of the message

mmStatus - the delivery status code of the message

parameters - parameters of the DeliverReportRequest to send

Returns:

the DeliveryReportActivity 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 vaspURL 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.

sendDeliveryReportRequest

DeliveryReportActivity sendDeliveryReportRequest(java.net.URL vaspURL,
                                                 java.lang.String rsID,
                                                 java.lang.String messageID,
                                                 MM7Address recipient,
                                                 MM7Address sender,
                                                 java.util.Date timestamp,
                                                 DeliveryReportRequest.MMDeliveryStatus mmStatus,
                                                 DeliveryReportRequestParameters parameters)
                                                 throws java.io.IOException,
                                                        ValidationException,
                                                        javax.slee.SLEEException

Create a new DeliveryReportActivity and send a new Delivery Report Request to the peer VASP. If no exception is thrown, a response will eventually appear as a DeliveryReportResponseEvent on the newly created activity.

Parameters:

vaspURL - the URL of the peer VASP, eg. http://host:port/path.

rsID - the Relay Server ID to use for this request; if null, the RA's default will be used

messageID - the ID of the message this Delivery Report refers to

recipient - the recipient of the message

sender - the sender of the message

timestamp - the time of delivery of the message

mmStatus - the delivery status code of the message

parameters - parameters of the DeliverReportRequest to send

Returns:

the DeliveryReportActivity 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 vaspURL 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.

sendReadReplyReportRequest

ReadReplyReportActivity sendReadReplyReportRequest(java.net.URL vaspURL,
                                                   java.lang.String messageID,
                                                   MM7Address recipient,
                                                   MM7Address sender,
                                                   java.util.Date timestamp,
                                                   ReadReplyReportRequest.MMReadStatus mmStatus,
                                                   ReadReplyReportRequestParameters parameters)
                                                   throws java.io.IOException,
                                                          ValidationException,
                                                          javax.slee.SLEEException

Create a new ReadReplyReportActivity and send a new Read Reply Report Request to the peer VASP. If no exception is thrown, a response will eventually appear as a ReadReplyReportResponseEvent (say that five times fast!) on the newly created activity.

Parameters:

vaspURL - the URL of the peer VASP, eg. http://host:port/path.

messageID - the ID of the message this Read Reply Report refers to

recipient - the recipient of the message

sender - the sender of the message

timestamp - the time of delivery of the message

mmStatus - the delivery status code of the message

parameters - parameters of the DeliverReportRequest to send

Returns:

the ReadReplyReportActivity 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 vaspURL 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.

sendReadReplyReportRequest

ReadReplyReportActivity sendReadReplyReportRequest(java.net.URL vaspURL,
                                                   java.lang.String rsID,
                                                   java.lang.String messageID,
                                                   MM7Address recipient,
                                                   MM7Address sender,
                                                   java.util.Date timestamp,
                                                   ReadReplyReportRequest.MMReadStatus mmStatus,
                                                   ReadReplyReportRequestParameters parameters)
                                                   throws java.io.IOException,
                                                          ValidationException,
                                                          javax.slee.SLEEException

Create a new ReadReplyReportActivity and send a new Read Reply Report Request to the peer VASP. If no exception is thrown, a response will eventually appear as a ReadReplyReportResponseEvent (say that five times fast!) on the newly created activity.

Parameters:

vaspURL - the URL of the peer VASP, eg. http://host:port/path.

rsID - the Relay Server ID to use for this request; if null, the RA's default will be used

messageID - the ID of the message this Read Reply Report refers to

recipient - the recipient of the message

sender - the sender of the message

timestamp - the time of delivery of the message

mmStatus - the delivery status code of the message

parameters - parameters of the DeliverReportRequest to send

Returns:

the ReadReplyReportActivity 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 vaspURL 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.