cgl.narada.wsinfra.wsrm.storage
Interface WsrmSequenceInfo

All Known Implementing Classes:
WsrmSequenceInfoImpl

public interface WsrmSequenceInfo

This interface encapsulates information pertaining to a sequence. These include,
(a) Its creation date
(b) Its Sequence Identifier and the addressing identifier
(c) The addressing identifier associated with the sequence creation request. The addressing identifier is different for different messages in a sequence. But sequence creation requests and responses, acknowledgement on the last message in a sequence, and finally the termination of a sequence all carry the same addressing identifier.


Method Summary
 String getAddressingIdentifier()
          Retrieve the addressing identifier.
 byte[] getBytes()
          Get a byte representation of the WsrmSequenceInfo
 Date getCreationDate()
          Retrieve the creation date for the sequence
 cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType getDestination()
          Returns the destination of this sequence
 long getLastMessageNumber()
          If we do have information regarding the last message of a sequence, proceed to retrieve it
 String getSequenceIdentifier()
          Retrieve the sequence identifier.
 cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType getSource()
          Returns the source of this sequence
 String getTerminationReason()
          Get the reason for termination
 long getTerminationTimestamp()
          Retrieve the termination timestamp
 long getTimeOfLastActivity()
          Retrieve the time associated with the last activity
 long getTimeoutTimestamp()
          Retrieve the timeout timestamp
 WsrmSequencePolicies getWsrmSequencePolicies()
           
 boolean hasLastMessageInfo()
          Checks to see if there is last message number in a given Sequence.
 boolean hasWsrmSequencePolicies()
          Check if there is a policy attachment
 boolean isDestination()
          Checks if this node is the destination of the sequence in question
 boolean isExpired()
          Checks to see if the sequence has expired
 boolean isSource()
          Checks if this node is the source of the sequence in question
 boolean isTerminated()
          Check to see if the sequence is terminated
 boolean isTimedOut()
          Checks to see if the sequence is timed out
 

Method Detail

getCreationDate

public Date getCreationDate()
Retrieve the creation date for the sequence


getSequenceIdentifier

public String getSequenceIdentifier()
Retrieve the sequence identifier.


getAddressingIdentifier

public String getAddressingIdentifier()
Retrieve the addressing identifier. More specifically this refers to the addressing identifier associated with the sequence creation request. The addressing identifier is different for different messages within a sequence. But sequence creation requests and responses, acknowledgement on the last message in a sequence, and finally the termination of a sequence all carry the same addressing identifier.


getSource

public cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType getSource()
Returns the source of this sequence


getDestination

public cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType getDestination()
Returns the destination of this sequence


isSource

public boolean isSource()
Checks if this node is the source of the sequence in question


isDestination

public boolean isDestination()
Checks if this node is the destination of the sequence in question


hasWsrmSequencePolicies

public boolean hasWsrmSequencePolicies()
Check if there is a policy attachment


getWsrmSequencePolicies

public WsrmSequencePolicies getWsrmSequencePolicies()

hasLastMessageInfo

public boolean hasLastMessageInfo()
Checks to see if there is last message number in a given Sequence. It should be noted that the indication of last message is available only within the last message in a sequence.


getLastMessageNumber

public long getLastMessageNumber()
If we do have information regarding the last message of a sequence, proceed to retrieve it


isExpired

public boolean isExpired()
Checks to see if the sequence has expired


isTimedOut

public boolean isTimedOut()
Checks to see if the sequence is timed out


getTimeOfLastActivity

public long getTimeOfLastActivity()
Retrieve the time associated with the last activity


getTimeoutTimestamp

public long getTimeoutTimestamp()
Retrieve the timeout timestamp


isTerminated

public boolean isTerminated()
Check to see if the sequence is terminated


getTerminationTimestamp

public long getTerminationTimestamp()
Retrieve the termination timestamp


getTerminationReason

public String getTerminationReason()
Get the reason for termination


getBytes

public byte[] getBytes()
Get a byte representation of the WsrmSequenceInfo