|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ManagedObject @Description(value="Reliable Messaging Sequence Manager") @AMXMetadata(type="WSRMSequenceManager") public interface SequenceManager
| Field Summary | |
|---|---|
static String |
MANAGED_BEAN_NAME
|
| Method Summary | |
|---|---|
void |
bindSequences(String referenceSequenceId,
String boundSequenceId)
Binds two sequences together. |
Map<String,String> |
boundSequences()
|
Sequence |
closeSequence(String sequenceId)
Closes an existing sequence. |
long |
concurrentlyOpenedInboundSequencesCount()
|
Sequence |
createInboundSequence(String sequenceId,
String strId,
long expirationTime)
Creates a new inbound sequence object |
Sequence |
createOutboundSequence(String sequenceId,
String strId,
long expirationTime)
Creates a new outbound sequence object with a given Id. |
void |
dispose()
Tells the SequenceManager that it is going to be disposed. |
String |
generateSequenceUID()
Generates a unique identifier of a sequence |
Sequence |
getBoundSequence(String referenceSequenceId)
Retrieves a sequence previously bound to the reference sequence |
Sequence |
getInboundSequence(String sequenceId)
Retrieves an existing inbound sequence from the internal sequence storage |
Sequence |
getOutboundSequence(String sequenceId)
Retrieves an existing outbound sequence from the internal sequence storage |
Sequence |
getSequence(String sequenceId)
Retrieves an existing sequence from the internal sequence storage |
void |
invalidateCache()
Instructs the SequenceManager instance to invalidate it's local
cache. |
boolean |
isValid(String sequenceId)
Provides information on whether the sequence identifier is a valid identifier that belongs to an existing sequence registered with the sequence manager. |
boolean |
onMaintenance()
Terminates all sequences that became expired in the meantime and removes all previously terminated sequences that were terminated sooner than a pre-configured period of time. |
boolean |
persistent()
|
Map<String,Sequence> |
sequences()
|
Sequence |
terminateSequence(String sequenceId)
Terminates an existing sequence by calling the Sequence.preDestroy() method. |
String |
uniqueEndpointId()
|
| Methods inherited from interface com.sun.xml.ws.rx.util.TimeSynchronizer |
|---|
currentTimeInMillis |
| Methods inherited from interface com.sun.xml.ws.commons.MOMRegistrationAware |
|---|
isRegisteredAtMOM, setRegisteredAtMOM |
| Field Detail |
|---|
static final String MANAGED_BEAN_NAME
| Method Detail |
|---|
@ManagedAttribute @Description(value="All RM sequences") Map<String,Sequence> sequences()
@ManagedAttribute @Description(value="Collection of sequence ID pairs that form an RM session") Map<String,String> boundSequences()
@ManagedAttribute @Description(value="Unique identifier of the WS endpoint for which this particular sequence manager will be used") String uniqueEndpointId()
@ManagedAttribute @Description(value="Determines whether this implementation of SeqenceManager is persistent") boolean persistent()
@ManagedAttribute @Description(value="Number of concurrently opened (not terminated) inbound sequences (determines number of concurrent RM sessions)") long concurrentlyOpenedInboundSequencesCount()
Sequence closeSequence(String sequenceId)
throws UnknownSequenceException
sequenceId - the unique sequence identifier
UnknownSequenceException
Sequence createOutboundSequence(String sequenceId,
String strId,
long expirationTime)
throws DuplicateSequenceException
sequenceId - identifier of the new sequencestrId - security reference token identifier which this session is bound toexpirationTime - expiration time of the sequence in milliseconds; value of com.sun.xml.ws.rm.policy.Configuration#UNSPECIFIED
means that this sequence never expires.
DuplicateSequenceExcepton - in case a sequence instance with this
identifier is already registered with this sequence manager
DuplicateSequenceException
Sequence createInboundSequence(String sequenceId,
String strId,
long expirationTime)
throws DuplicateSequenceException
sequenceId - identifier of the new sequencestrId - security reference token identifier which this session is bound toexpirationTime - expiration time of the sequence in milliseconds; value of com.sun.xml.ws.rm.policy.Configuration#UNSPECIFIED
means that this sequence never expires.
DuplicateSequenceExcepton - in case a sequence instance with this
identifier is already registered with this sequence manager
DuplicateSequenceExceptionString generateSequenceUID()
Sequence getSequence(String sequenceId)
throws UnknownSequenceException
sequenceId - the unique sequence identifier
sequenceId identifier
UnknownSequenceException - in case no such sequence is registered within the sequence manager
Sequence getInboundSequence(String sequenceId)
throws UnknownSequenceException
sequenceId - the unique sequence identifier
sequenceId identifier
UnknownSequenceException - in case no such sequence is registered
within the sequence manager or in case the registered sequence was
not created as inbound.
Sequence getOutboundSequence(String sequenceId)
throws UnknownSequenceException
sequenceId - the unique sequence identifier
sequenceId identifier
UnknownSequenceException - in case no such sequence is registered
within the sequence manager or in case the registered sequence was
not created as outbound.boolean isValid(String sequenceId)
sequenceId - sequence identifier to be checked
true in case the sequence identifier is valid, false otherwise
Sequence terminateSequence(String sequenceId)
throws UnknownSequenceException
Sequence.preDestroy() method. In addition to this, the terminated
sequence is removed from the internal sequence storage
sequenceId - the unique sequence identifier
UnknownSequenceExceptio - in case no such sequence is registered within the sequence manager
UnknownSequenceException
void bindSequences(String referenceSequenceId,
String boundSequenceId)
throws UnknownSequenceException
referenceSequenceId - a reference sequence identifier to which the other sequence shall be bound.boundSequenceId - a bound sequence identifier
UnknownSequenceException - in case any of the sequence identifiers does not represent a valid sequence
Sequence getBoundSequence(String referenceSequenceId)
throws UnknownSequenceException
referenceSequenceId - a reference sequence identifier to which the other sequence has been bound.
null in case no sequence is bound to the reference sequence
UnknownSequenceExceptio - in case no such reference sequence is registered within the sequence manager
UnknownSequenceExceptionboolean onMaintenance()
SequenceMaintenanceTask
instance associated with this SequenceManager.
true if the next maintenance execution task is supposed to be scheduled,
false otherwise.void invalidateCache()
SequenceManager instance to invalidate it's local
cache. This prevents stale data being used and ensures that fresh data are
loaded from the RM HA backing stores.
void dispose()
SequenceManager that it is going to be disposed. An implementation
of this interface can use the method to do the necessary resource cleanup.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||