cgl.narada.wsinfra.wsrm.storage
Interface WsrmSequenceInfoStorageOperations

All Known Implementing Classes:

WsrmSequenceInfoStorageOperationsImpl

public interface WsrmSequenceInfoStorageOperations

This provides operations for storing and retrieving information pertaining to Sequences. Specifically the operations provided include
(a)Storing and Retrieving SequenceInfo objects
(b) Retrieving the list of all sent, received, created, expired, terminated and active sent and received Sequences.

Method Summary

void	addDestinationSequenceIdentifierPair(String destination, String sequenceIdentifier) Stores the sequence identifier that should be used while communicating with a given destination (based on the contents of the wsa:To element).
String	getDestinationForSequenceIdentifier(String sequenceIdentifier) Retrieves the destination for a specific sequence identifier
String[]	getListOfActiveSequences(boolean source) Retrieves the list of active sent/received sequences that are currently available at this node.
String[]	getListOfAllSequences(boolean source) Retrieves the entire list of sent/received sequence identifiers registered with the underlying service.
String[]	getListOfExpiredSequences(boolean source) Retrieves the list of sent/received sequences that have expired.
String[]	getListOfServicedSequences(boolean source) Retrieves the list of sent/received sequences that have been acknowledged and were successfully terminated.
String[]	getListOfTerminatedSequences(boolean source) Retrieves the list of sent/received sequences that have terminated.
String[]	getListOfTimedOutSequences(boolean source) Retrieves the list of sent/received sequences that have timed-out.
String	getSequenceIdentifierForDestination(String destination) Retrieve the sequence identifier for a specific destination
WsrmSequenceInfo	getSequenceInfoUsingAddressingIdentifier(String addressingIdentifier) Retrieves the SequenceInfo corresponding to the specified addressingIdentifier.
WsrmSequenceInfo	getSequenceInfoUsingSequenceIdentifier(String sequenceIdentifier) Retrieves the SequenceInfo corresponding to the specified sequenceIdentifier.
WsrmSequenceInfo[]	getSequenceInfoUsingSequencePrefix(String sequencePrefix) Retrieves the SequenceInfo corresponding to the ACTIVE sequences with the specified sequenceIdentifier prefix.
boolean	hasSequenceIdForDestination(String destination) Checks to see if there is a sequenceId/destination pair corresponding to the destination in question.
boolean	isKnownSequence(String sequenceIdentifier) A method which checks whether a certain sequence (irrespective of whether it is active/terminated/expired/timed-out) is a known sequence at this node
void	removeDestinationSequenceIdentifierPair(String destination) Removes the destination/sequence identifier pair corresponding to this destination
void	storeCreatedSequence(WsrmSequenceInfo sequenceInfo) Store a SequenceInfo object.

Method Detail

addDestinationSequenceIdentifierPair

public void addDestinationSequenceIdentifierPair(String destination,
                                                 String sequenceIdentifier)
                                          throws WsrmStorageException

Stores the sequence identifier that should be used while communicating with a given destination (based on the contents of the wsa:To element). This feature allows us to send messages reliably with minimal intervention from the application.

Throws:

WsrmStorageException

getSequenceIdentifierForDestination

public String getSequenceIdentifierForDestination(String destination)
                                           throws WsrmStorageException

Retrieve the sequence identifier for a specific destination

Throws:

WsrmStorageException

getDestinationForSequenceIdentifier

public String getDestinationForSequenceIdentifier(String sequenceIdentifier)
                                           throws WsrmStorageException

Retrieves the destination for a specific sequence identifier

Throws:

WsrmStorageException

removeDestinationSequenceIdentifierPair

public void removeDestinationSequenceIdentifierPair(String destination)
                                             throws WsrmStorageException

Removes the destination/sequence identifier pair corresponding to this destination

Throws:

WsrmStorageException

hasSequenceIdForDestination

public boolean hasSequenceIdForDestination(String destination)
                                    throws WsrmStorageException

Checks to see if there is a sequenceId/destination pair corresponding to the destination in question.

Throws:

WsrmStorageException

isKnownSequence

public boolean isKnownSequence(String sequenceIdentifier)
                        throws WsrmStorageException

A method which checks whether a certain sequence (irrespective of whether it is active/terminated/expired/timed-out) is a known sequence at this node

Throws:

WsrmStorageException

storeCreatedSequence

public void storeCreatedSequence(WsrmSequenceInfo sequenceInfo)
                          throws WsrmStorageException

Store a SequenceInfo object. This method throws an exception under the following circumstances
The sequenceIdentifier in the SequenceInfo already exists.
Storage related problems

Throws:

WsrmStorageException

getSequenceInfoUsingSequenceIdentifier

public WsrmSequenceInfo getSequenceInfoUsingSequenceIdentifier(String sequenceIdentifier)
                                                        throws WsrmStorageException

Retrieves the SequenceInfo corresponding to the specified sequenceIdentifier. This method throws an exception under the following conditions.
The Sequence specified in sequenceIdentifier is an unknown one.
Storage related problems

Throws:

WsrmStorageException

getSequenceInfoUsingSequencePrefix

public WsrmSequenceInfo[] getSequenceInfoUsingSequencePrefix(String sequencePrefix)
                                                      throws WsrmStorageException

Retrieves the SequenceInfo corresponding to the ACTIVE sequences with the specified sequenceIdentifier prefix. This method throws an exception under the following conditions.
The Sequence specified in sequenceIdentifier is an unknown one.
Storage related problems

Throws:

WsrmStorageException

getSequenceInfoUsingAddressingIdentifier

public WsrmSequenceInfo getSequenceInfoUsingAddressingIdentifier(String addressingIdentifier)
                                                          throws WsrmStorageException

Retrieves the SequenceInfo corresponding to the specified addressingIdentifier. This method throws an exception under the following conditions.
The Sequence specified in addressingIdentifier is an unknown one.
Storage related problems

Throws:

WsrmStorageException

getListOfAllSequences

public String[] getListOfAllSequences(boolean source)
                               throws WsrmStorageException

Retrieves the entire list of sent/received sequence identifiers registered with the underlying service. This method throws an exception if there are storage related problems.

Throws:

WsrmStorageException

getListOfExpiredSequences

public String[] getListOfExpiredSequences(boolean source)
                                   throws WsrmStorageException

Retrieves the list of sent/received sequences that have expired. This method throws an exception if there are storage related problems.

Throws:

WsrmStorageException

getListOfTimedOutSequences

public String[] getListOfTimedOutSequences(boolean source)
                                    throws WsrmStorageException

Retrieves the list of sent/received sequences that have timed-out. This method throws an exception if there are storage related problems.

Throws:

WsrmStorageException

getListOfTerminatedSequences

public String[] getListOfTerminatedSequences(boolean source)
                                      throws WsrmStorageException

Retrieves the list of sent/received sequences that have terminated. This method throws an exception if there are storage related problems.

Throws:

WsrmStorageException

getListOfServicedSequences

public String[] getListOfServicedSequences(boolean source)
                                    throws WsrmStorageException

Retrieves the list of sent/received sequences that have been acknowledged and were successfully terminated. These sequences are ones where the sequence DID NOT EXPIRE or had an INACTIVITY_TIMEOUT. Also the LAST MESSAGE information should be present. This method throws an exception if there are storage related problems.

Throws:

WsrmStorageException

getListOfActiveSequences

public String[] getListOfActiveSequences(boolean source)
                                  throws WsrmStorageException

Retrieves the list of active sent/received sequences that are currently available at this node. This method throws an exception if there are storage related problems.

Throws:

WsrmStorageException