Interface SequenceData
public interface SequenceData
-
Method Summary
Modifier and TypeMethodDescriptionvoidbooleanlonglonglongProvides information on the last activity time of this sequence data instance.longIn contrast togetUnackedMessageNumbers(), this method returns allways a non-emptyListin which first item represents a current last message number value (see alsogetLastMessageNumber().getState()longincrementAndGetLastMessageNumber(boolean received) Increments last message number on the sequence and returns new last message number value.booleanisFailedOver(long messageNumber) voidmarkAsAcknowledged(long messageNumber) Removes the providedmessageNumberfrom the collection of unacked message numbers and and marks stored message with givenmessageNumber(if any) as eligible for removal from the underlying message storage.voidregisterReceivedUnackedMessageNumber(long messageNumber) Registers the message number as unacknowledged.retrieveMessage(String correlationId) voidsetAckRequestedFlag(boolean newValue) voidsetLastAcknowledgementRequestTime(long newTime) voidsetState(Sequence.State newState)
-
Method Details
-
getSequenceId
String getSequenceId() -
getExpirationTime
long getExpirationTime() -
getBoundSecurityTokenReferenceId
String getBoundSecurityTokenReferenceId() -
getLastMessageNumber
long getLastMessageNumber() -
getAckRequestedFlag
boolean getAckRequestedFlag() -
setAckRequestedFlag
void setAckRequestedFlag(boolean newValue) -
getLastAcknowledgementRequestTime
long getLastAcknowledgementRequestTime() -
setLastAcknowledgementRequestTime
void setLastAcknowledgementRequestTime(long newTime) -
getLastActivityTime
long getLastActivityTime()Provides information on the last activity time of this sequence data instance. Following is the list of operations invocation of which causes an update of last activity time:attachMessageToUnackedMessageNumber(ApplicationMessage)incrementAndGetLastMessageNumber(boolean)markAsAcknowledged(long)registerReceivedUnackedMessageNumber(long)retrieveMessage(java.lang.String)setAckRequestedFlag(boolean)setLastAcknowledgementRequestTime(long)setState(com.sun.xml.ws.rx.rm.runtime.sequence.Sequence.State)
- Returns:
- last activity time of the sequence
-
getState
Sequence.State getState() -
setState
-
incrementAndGetLastMessageNumber
long incrementAndGetLastMessageNumber(boolean received) Increments last message number on the sequence and returns new last message number value. Method automatically marks the newly created message number as unacknowledged.- Parameters:
received- this flag specifies whether the message with such number should be marked as received on the sequence.- Returns:
- new value of the last message number
-
registerReceivedUnackedMessageNumber
void registerReceivedUnackedMessageNumber(long messageNumber) throws DuplicateMessageRegistrationException Registers the message number as unacknowledged.If the value of
messageNumberparameter is greater that the actual last mesasge number, the last message number value is increased to the value ofmessageNumberparameter. All message numbers lying between the original and new value of last message number are automatically marked as unacknowldeged and not received.- Parameters:
messageNumber- unacknowledged message number to register- Throws:
DuplicateMessageRegistrationException- in case such registration already exists
-
markAsAcknowledged
void markAsAcknowledged(long messageNumber) Removes the providedmessageNumberfrom the collection of unacked message numbers and and marks stored message with givenmessageNumber(if any) as eligible for removal from the underlying message storage. This method does nothing if there's no such unacknowledged message number found -
isFailedOver
boolean isFailedOver(long messageNumber) -
attachMessageToUnackedMessageNumber
-
retrieveMessage
-
getUnackedMessageNumbers
-
getLastMessageNumberWithUnackedMessageNumbers
In contrast togetUnackedMessageNumbers(), this method returns allways a non-emptyListin which first item represents a current last message number value (see alsogetLastMessageNumber(). The items following the first item represent the collection of unacked message numbers (see alsogetUnackedMessageNumbers()).This special method was introduced in order to allow for an atomic retrieval of both values.
- Returns:
Listwhere first item represents the last message number and all subsequent values represent unacknowledged message numbers.
-