|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WSRMSequenceManager
The WSRMSequenceManager is used for controlling the reliable messaging sequence been a Web service
requester and Web service provider.
Most methods take an Object as one of the parameters. This object is either an instance of a JAX-WS Dispatch object,
or an instance of the Dynamic Proxy client.
The Dispatch instance is created using the jax.xml.ws.Dispatch classes and can be created in a similar way to
the following:
Service svc = Service.create((QName)serviceQName);
svc.addPort((QName)portQName, null, endPointUri);
Dispatch dispatch = svc.createDispatch(
portQName, String.class, null);
All methods will throw a WSRMNotEnabledException
if Web services - reliable messaging
has not been enabled for the application invoking the method
Method Summary | |
---|---|
void |
closeSequence(java.lang.Object clientObject,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri)
Closes the Web services reliable messaging session from this application to the end point url specified. |
void |
createNewWSRMSequence(java.lang.Object clientObject,
javax.xml.namespace.QName portQName,
WSRMSequenceProperties sequencePropeties)
Initiates a new sequence handshake between this client and the target EPR specified in the WSRMSequenceProperties instance. |
WSRMSequenceProperties |
createNewWSRMSequenceProperties()
Creates a new WSRMSequenceProperties object which can be used to set the properties for a new web services reliable messaging sequence. |
java.lang.Exception |
getLastWSRMError(java.lang.Object clientObject,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri)
Due to the asynchronous behaviour of web services reliable messaging errors may occur, such as endpoint unreachable that are not exposed to the client. |
long |
getLastWSRMErrorTimestamp(java.lang.Object clientObject,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri)
Due to the asynchronous behaviour of web services reliable messaging errors may occur, such as endpoint unreachable that are not exposed to the client. |
void |
sendAcknowledgementRequest(java.lang.Object clientObject,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri)
Sending an acknowledgement request sends the ACK requested message to the specified target endPointUri. |
void |
terminateSequence(java.lang.Object clientObject,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri)
Terminates Web services reliable messaging session from this application to the end point url specified. |
boolean |
waitUntilSequenceCompleted(java.lang.Object clientObject,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri)
Waits until all messages between this application and target endpoint url are completed before returning control to the application. |
boolean |
waitUntilSequenceCompleted(java.lang.Object clientObject,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri,
long waitTime)
Waits until all messages between this application and target endpoint url are completed before returning control to the application. |
Method Detail |
---|
WSRMSequenceProperties createNewWSRMSequenceProperties()
void createNewWSRMSequence(java.lang.Object clientObject, javax.xml.namespace.QName portQName, WSRMSequenceProperties sequencePropeties) throws WSRMNotEnabledException, WSRMSequenceAlreadyExistsException
clientObject
- The JAX-WS Dispatch instance, or the Dynamic Proxy client instance.sequencePropeties
- The properties for creating the reliable messaging sequence
java.lang.NullPointerException
- if the sequenceProperties object is null, or the target EPR is null
WSRMNotEnabledException
WSRMSequenceAlreadyExistsException
void sendAcknowledgementRequest(java.lang.Object clientObject, javax.xml.namespace.QName portQName, java.lang.String endPointUri) throws WSRMNotEnabledException, WSRMSequenceUnknownException, WSRMSequenceTerminatedException, WSRMSequenceClosedException
clientObject
- The JAX-WS Dispatch instance, or the Dynamic Proxy client instance.portQName
- endPointUri
- The target end point uri
WSRMNotEnabledException
WSRMSequenceUnknownException
WSRMSequenceTerminatedException
WSRMSequenceClosedException
void closeSequence(java.lang.Object clientObject, javax.xml.namespace.QName portQName, java.lang.String endPointUri) throws WSRMNotEnabledException, WSRMSequenceUnknownException, WSRMSequenceClosedException, WSRMSequenceTerminatedException
clientObject
- The JAX-WS Dispatch instance, or the Dynamic Proxy client instance.endPointUri
- The target endpoint url
WSRMNotEnabledException
WSRMSequenceUnknownException
WSRMSequenceClosedException
WSRMSequenceTerminatedException
void terminateSequence(java.lang.Object clientObject, javax.xml.namespace.QName portQName, java.lang.String endPointUri) throws WSRMNotEnabledException
clientObject
- The JAX-WS Dispatch instance, or the Dynamic Proxy client instance.endPointUri
- The target endpoint url
WSRMNotEnabledException
WSRMSequenceTerminatedException
WSRMSequenceUnknownException
boolean waitUntilSequenceCompleted(java.lang.Object clientObject, javax.xml.namespace.QName portQName, java.lang.String endPointUri) throws WSRMNotEnabledException, WSRMSequenceUnknownException, WSRMTransactionInUseException
clientObject
- The JAX-WS Dispatch instance, or the Dynamic Proxy client instance.endPointUri
- The target endpoint url
WSRMNotEnabledException
WSRMSequenceUnknownException
WSRMTransactionInUseException
boolean waitUntilSequenceCompleted(java.lang.Object clientObject, javax.xml.namespace.QName portQName, java.lang.String endPointUri, long waitTime) throws WSRMNotEnabledException, WSRMSequenceUnknownException, WSRMTransactionInUseException
clientObject
- The JAX-WS Dispatch instance, or the Dynamic Proxy client instance.endPointUri
- The target endpoint urlwaitTime
- The length of time to wait for the sequence to be terminated and all messages to have been processed.
A wait time of -1 means an infinite wait.
WSRMNotEnabledException
WSRMSequenceUnknownException
WSRMTransactionInUseException
java.lang.Exception getLastWSRMError(java.lang.Object clientObject, javax.xml.namespace.QName portQName, java.lang.String endPointUri) throws WSRMNotEnabledException, WSRMSequenceUnknownException, WSRMSequenceTerminatedException, WSRMSequenceClosedException
clientObject
- The JAX-WS Dispatch instance, or the Dynamic Proxy client instance.portQName
- endPointUri
-
WSRMNotEnabledException
WSRMSequenceUnknownException
WSRMSequenceClosedException
WSRMSequenceTerminatedException
long getLastWSRMErrorTimestamp(java.lang.Object clientObject, javax.xml.namespace.QName portQName, java.lang.String endPointUri) throws WSRMNotEnabledException, WSRMSequenceUnknownException, WSRMSequenceTerminatedException, WSRMSequenceClosedException
clientObject
- The JAX-WS Dispatch instance, or the Dynamic Proxy client instance.portQName
- endPointUri
-
WSRMNotEnabledException
WSRMSequenceUnknownException
WSRMSequenceClosedException
WSRMSequenceTerminatedException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |