weblogic.management.runtime
Interface WsrmSequenceInfo

All Superinterfaces:

Serializable

public interface WsrmSequenceInfo
extends Serializable

Represents a reliable sequence for either the RM source or RM destination

NEW

static final String NEW

Initial state of a sequence. Source: From construction till CreateSequence is sent Destination: Not used, transition directly to CREATING

See Also:

Constant Field Values

CREATING

static final String CREATING

Sequence creation handshaking is in progress. Source: From CreateSequence send till CreateSequenceResponse is fully processed. Destination: During processing of CreateSequence till CreateSequenceResponse is sent.

See Also:

Constant Field Values

CREATED

static final String CREATED

Sequence handshaking is complete. Processing sequence messages. Source: After processing CreateSequenceResponse until either a LastMessage is sent, sequence is closed, or sequence is terminated. Destination: After CreateSequenceResponse is sent till the sequence receives LastMessage, CloseSequence, TerminateSequence or the sequence times out. Timeout will cause the sequence to be forcibly terminated (in RM 1.1 and beyond this will send TerminateSequence to the RM source).

See Also:

Constant Field Values

LAST_MESSAGE_PENDING

static final String LAST_MESSAGE_PENDING

Deprecated. RM 1.0 only

RM 1.0 Only. Source: Indicates a LastMessage has been sent. Destination: Indicates a LastMessage has been received and is being processed.

See Also:

Constant Field Values

LAST_MESSAGE

static final String LAST_MESSAGE

Deprecated. RM 1.0 only

RM 1.0 Only. Source: Indicates a LastMessage has been sent and ack'd. Destination: Indicates a LastMessage has been received and ack'd.

See Also:

Constant Field Values

CLOSING

static final String CLOSING

Sequence is in the process of being closed. No sequence messages can be sent or received. Source: Upon send of CloseSequence until CloseSequenceResponse is processed. Destination: Upon receipt of CloseSequence until CloseSequenceResponse is sent.

See Also:

Constant Field Values

CLOSED

static final String CLOSED

Sequence is closed. No sequence messages can be sent or received. Source: After CloseSequenceResponse is processed. Destination: After CloseSequenceResponse is sent.

See Also:

Constant Field Values

TERMINATING

static final String TERMINATING

Sequence is in the process of being terminated. No sequence messages can be sent or received. Source: After sending TerminateSequence till TerminateSequenceResponse is processed. Destination: After TerminateSequence is received until TerminateSequenceResponse is sent. Timeout will cause the sequence to be forcibly terminated (in RM 1.1 and beyond this will send TerminateSequence to the RM source). Sequence moves immediately to TERMINATED.

See Also:

Constant Field Values

TERMINATED

static final String TERMINATED

Sequence is terminated. No sequence messages can be sent or received. Source: After TerminateSequenceResponse is processed. Destination: After TerminateSequenceResponse is sent. Timeout will cause the sequence to be forcibly terminated (in RM 1.1 and beyond this will send TerminateSequence to the RM source). Sequence moves immediately to TERMINATED.

See Also:

Constant Field Values

getId

String getId()

The sequence ID for this sequence.

getLogicalStoreName

String getLogicalStoreName()

Get the name of the logical store in which this sequence is stored.

getPhysicalStoreName

String getPhysicalStoreName()

Get the name of the physical store in which this sequence is stored.

isSource

boolean isSource()

Get an indication of whether this sequence is a source sequence (used to send requests) or a destination sequence (used to receive requests).

Returns:

True if this sequence is a source sequence, false if it is a destination sequence.

getDestinationId

String getDestinationId()

If this is a source sequence (isSource()==true && isOffer() == false) and this sequence has completed the handshake process (e.g. state!=NEW && state!=CREATING) then it is known to the destination/service side by a different ID than the one given by getId(). This ID is returned in the CreateSequenceResponse sent by the destination/service and is known as the source sequence's destination ID. Note, source offer sequences don't have a destination ID because the source sends the ID with the CreateSequence, and thus both the source and destination side know the offer by the same ID.

Returns:

The ID used by the destination side to refer to this source sequence, or null if this is not a source sequence, or the sequence hasn't completed the handshake process yet.

isOffer

boolean isOffer()

Get an indication of whether this sequence is an offer sequence (meaning it was set up during sequence handshaking to carry responses for a main sequence). If true, this indicates this sequence is an offer, and not otherwise. There are both source and destination flavors of an offer sequence, so this method should be used in tandem with isSource() to get full information about the type of this sequence. A source offer sequence is used to send responses from the service-side of the wire. A destination offer sequence is used to receive responses on the client-side of the wire.

Returns:

True if this sequence is an offer sequence, false otherwise.

getMainSequenceId

String getMainSequenceId()

If this is an offer sequence (isOffer()==true) then this sequence is associated with another 'main' sequence. This method gives the sequence ID of that sequence. Note, if this is a source offer sequence (isSource()==true && isOffer()==true), the main sequence will be a destination sequence (isSource()==false). If this is a destination offer sequence (isSource()==false && isOffer()==true) then the main sequence will be a source sequence (isSource()==true).

Returns:

The sequence ID of the main sequence (if this is an offer sequence) or null otherwise.

getState

String getState()

The current state of the sequence.

getCreationTime

long getCreationTime()

The time this sequence was created.

getLastActivityTime

long getLastActivityTime()

The time of the last activity to happen on this sequence.

getMaxAge

long getMaxAge()

The time after which this sequence will expire.

getLastAckdMessageNum

long getLastAckdMessageNum()

Message number (1 .. n) of the last request to have been acknowledged on this sequence (ack received for RM source, or ack sent for RM dest)

getUnackdCount

long getUnackdCount()

Count of requests that have not been acknowledged on this sequence (ack received for RM source, or ack sent for RM dest)

getRequests

WsrmRequestInfo[] getRequests()
                              throws ManagementException

Get specific information about the requests that have been sent from this sequence, or received into this sequence.

Throws:

ManagementException