public interface WsrmClient
Modifier and Type | Method | Description |
---|---|---|
void |
closeSequence() |
Closes a sequence, as defined by the WS-RM 1.1 spec.
|
void |
dispose() |
Release any resource held by this client.
|
java.util.SortedSet<MessageRange> |
getAckRanges() |
Gets a set of MessageRange objects indicating which requests have been
acknowledged by the RM destination for this client.
|
java.lang.String |
getId() |
Get the ID for this client instance.
|
SourceMessageInfo |
getMessageInfo(long msgNum) |
Get information describing a reliable message sent from this stub, given
that message's message number.
|
long |
getMostRecentMessageNumber() |
Gets the most recently assigned message number for a reliable message that
was sent from this stub.
|
java.lang.String |
getSequenceId() |
Get the sequence ID being managed on this client.
|
SequenceState |
getSequenceState() |
Get the state of the sequence being managed on this client.
|
void |
requestAcknowledgement() |
Send an acknowledgement request to the RM destination.
|
void |
reset() |
Clear all RequestContext properties, related to WS-RM, that should not be
retained for a new sequence being used by this client.
|
void |
sendWsrm10EmptyLastMessage() |
Deprecated.
|
void |
setFinalMessage() |
Indicates that the next message sent on this stub is to be considered the
final message that will be sent on the stub.
|
void |
setSequenceId(java.lang.String seqId) |
Set the sequence ID on a newly created client instance in order to
reconnect it to an existing sequence after the client VM has restarted.
|
void |
terminateSequence() |
Forcibly terminate a sequence.
|
void dispose()
void reset()
java.lang.String getId()
ClientIdentityFeature
java.lang.String getSequenceId()
void setSequenceId(java.lang.String seqId)
SequenceState getSequenceState()
void requestAcknowledgement() throws WsrmException
UnknownSourceSequenceException
- if this method is called before
the sequence ID has been established for this stub (getSequenceId
returns non-null), or after the
sequence for this stub has been terminated.WsrmException
- if any other error occurs sending the message.java.util.SortedSet<MessageRange> getAckRanges() throws UnknownSourceSequenceException
UnknownSourceSequenceException
- if this method is called before
the sequence ID has been established for this stub (getSequenceId
returns non-null), or after the
sequence for this stub has been terminated.long getMostRecentMessageNumber()
SourceMessageInfo getMessageInfo(long msgNum) throws UnknownSourceSequenceException
UnknownSourceSequenceException
- if this method is called before
the sequence ID has been established for this stub (getSequenceId
returns non-null), or after the
sequence for this stub has been terminated.void setFinalMessage()
void closeSequence() throws WsrmException
UnknownSourceSequenceException
- if this method is called before
the sequence ID has been established for this stub (getSequenceId
returns non-null), or after the
sequence for this stub has been terminated.WsrmException
- if any other error occurs sending the message.void sendWsrm10EmptyLastMessage() throws WsrmException
WsrmException
void terminateSequence() throws WsrmException
UnknownSourceSequenceException
- if this method is called before
the sequence ID has been established for this stub (getSequenceId
returns non-null), or after the
sequence for this stub has been terminated.WsrmException
- if any other error occurs sending the message.