public interface WSRMSequenceManager
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| Modifier and Type | Method and Description |
|---|---|
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 |
waitForAllMessagesToBeAcked(java.lang.Object clientInstance,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri) |
boolean |
waitForAllMessagesToBeAcked(java.lang.Object clientInstance,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri,
long waitTime) |
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.
|
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 sequencejava.lang.NullPointerException - if the sequenceProperties object is null, or the target EPR is nullWSRMNotEnabledExceptionWSRMSequenceAlreadyExistsExceptionvoid 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 uriWSRMNotEnabledExceptionWSRMSequenceUnknownExceptionWSRMSequenceTerminatedExceptionWSRMSequenceClosedExceptionvoid 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 urlWSRMNotEnabledExceptionWSRMSequenceUnknownExceptionWSRMSequenceClosedExceptionWSRMSequenceTerminatedExceptionvoid 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 urlWSRMNotEnabledExceptionWSRMSequenceTerminatedExceptionWSRMSequenceUnknownExceptionboolean 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 urlWSRMNotEnabledExceptionWSRMSequenceUnknownExceptionWSRMTransactionInUseExceptionboolean 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.WSRMNotEnabledExceptionWSRMSequenceUnknownExceptionWSRMTransactionInUseExceptionjava.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 - WSRMNotEnabledExceptionWSRMSequenceUnknownExceptionWSRMSequenceClosedExceptionWSRMSequenceTerminatedExceptionlong 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 - WSRMNotEnabledExceptionWSRMSequenceUnknownExceptionWSRMSequenceClosedExceptionWSRMSequenceTerminatedExceptionboolean waitForAllMessagesToBeAcked(java.lang.Object clientInstance,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri,
long waitTime)
throws WSRMNotEnabledException,
WSRMSequenceUnknownException,
WSRMSequenceTerminatedException,
WSRMSequenceClosedException,
WSRMTransactionInUseException
boolean waitForAllMessagesToBeAcked(java.lang.Object clientInstance,
javax.xml.namespace.QName portQName,
java.lang.String endPointUri)
throws WSRMNotEnabledException,
WSRMSequenceUnknownException,
WSRMSequenceTerminatedException,
WSRMSequenceClosedException,
WSRMTransactionInUseException