weblogic.wsee.reliability2.sequence

Class SourceSequence

java.lang.Object

weblogic.wsee.reliability2.sequence.Sequence<SourceMessageInfo,DestinationOfferSequence,DestinationSequence,DestinationSequenceManager>

weblogic.wsee.reliability2.sequence.SourceSequence

All Implemented Interfaces:

com.oracle.state.ext.expiry.Expirable, com.oracle.state.ext.expiry.TimeStamped, java.io.Serializable, weblogic.wsee.persistence.SettableIdStorable, weblogic.wsee.persistence.Storable

Direct Known Subclasses:

SourceOfferSequence

public class SourceSequence
extends Sequence<SourceMessageInfo,DestinationOfferSequence,DestinationSequence,DestinationSequenceManager>
implements java.io.Serializable

Represents a sequence from the RM source perspective

See Also:

Serialized Form

Excluded in public API Reference.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SourceSequence.Gap

Nested classes/interfaces inherited from class weblogic.wsee.reliability2.sequence.Sequence

Sequence.AddResult, Sequence.NotAddedReason

Field Summary

Fields

Modifier and Type	Field and Description
private com.sun.xml.ws.api.addressing.WSEndpointReference	_acksToEpr Endpoint reference describing where this sequence expects the Acks it receives to be delivered.
private javax.xml.datatype.Duration	_baseRetransmissionInterval The starting time interval to wait between retries for sending a request on this sequence.
private boolean	_complete Indicates that we've identified a 'final' message in the sequence, and have sent that message, and received an ack for it and all prior messages.
private weblogic.wsee.jaxws.spi.ClientInstanceIdentity	_creatingClientInstanceId Identity of the client instance that caused the creation of this sequence.
private java.lang.String	_destinationId Id as known on the RM destination side after getting a CreateSequenceResponse
private com.sun.xml.ws.api.addressing.WSEndpointReference	_endpointEpr Endpoint reference describing where lifecycle, ack request, and fault messages related to the Sequence are to be sent.
private boolean	_exponentialBackoffEnabled Flag to enable backing off the retry frequence (increasing the interval) between retries for sending a request on this sequence.
private weblogic.wsee.jaxws.persistence.PersistentRequestContext	_firstRequestContext A snapshot of a RequestContext (map of properties) captured at the point where this sequence was created.
private long	_lastAllocatedMessageNum The message number for the most recent message to be sent on this source seq.
private java.lang.String	_offerSequenceId The offer sequence (if any) that we should be getting responses on.
private weblogic.wsee.reliability2.store.SenderDispatchFactory.Key	_senderDispatchKey Key needed to obtain a Dispatch instance for sending messages on this sequence via client-side-retry (SAF).
private static java.util.logging.Logger	LOGGER
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
SourceSequence(java.lang.String sourceId, java.lang.String logicalStoreName, WsrmConstants.RMVersion rmVersion, com.sun.xml.ws.api.addressing.AddressingVersion addrVersion, com.sun.xml.ws.api.SOAPVersion soapVersion, SecurityInfo securityInfo, WsrmSecurityContext securityCtx, boolean nonBuffered, weblogic.wsee.jaxws.persistence.PersistentRequestContext firstRequestContext)

Method Summary

Modifier and Type	Method and Description
SourceMessageInfo	copyMessageInfo(SourceMessageInfo info)
com.sun.xml.ws.api.addressing.WSEndpointReference	getAcksToEpr()
javax.xml.datatype.Duration	getBaseRetransmissionInterval()
weblogic.wsee.jaxws.spi.ClientInstanceIdentity	getCreatingClientInstanceId()
java.lang.String	getDestinationId()
com.sun.xml.ws.api.addressing.WSEndpointReference	getEndpointEpr()
weblogic.wsee.jaxws.persistence.PersistentRequestContext	getFirstRequestContext()
long	getNextMessageNum() Increments and gets (post-increment) the last allocated message num for this sequence.
java.lang.String	getOfferSequenceId() Called by Sequence to manage offer.
com.sun.xml.ws.api.addressing.WSEndpointReference	getPeerEpr() The peer endpoint reference.
com.sun.xml.ws.api.addressing.WSEndpointReference	getPiggybackEpr() Find the EPR that represents the endpoint to which piggyback headers should be sent for the given sequence (this means different things for different subclasses).
com.sun.xml.ws.api.addressing.WSEndpointReference	getPublicEpr() The public endpoint reference for this sequence.
com.sun.xml.ws.api.addressing.WSEndpointReference	getRmFaultEpr() Find the EPR that represents the endpoint at which WS-RM faults will be received.
weblogic.wsee.reliability2.store.SenderDispatchFactory.Key	getSenderDispatchKey()
java.lang.String	getSourceId()
java.lang.String	getWireId() The ID this sequence will be known by in protocol messages and headers on the wire between source and destination.
private void	initTransients() Make sure we have sane values for all our transient fields.
protected void	internalSetOfferSequenceId(java.lang.String offerSeqId) Called by Sequence to manage offer.
boolean	isAllRequestsAckedAndReplied() Note: pls call the metod only under iscomplete = true.
boolean	isComplete()
boolean	isExponentialBackoffEnabled()
boolean	markMessageAckd(SourceMessageInfo info, boolean ack)
private void	readObject(java.io.ObjectInputStream in)
void	setAcksToEpr(com.sun.xml.ws.api.addressing.WSEndpointReference acksToEpr) Should be called only during initialization of the sequence, and not thereafter.
void	setBaseRetransmissionInterval(javax.xml.datatype.Duration baseRetransmissionInterval) Should be called during initialization of the sequence, and not thereafter
private void	setComplete(boolean complete)
void	setCreatingClientInstanceId(weblogic.wsee.jaxws.spi.ClientInstanceIdentity creatingClientInstanceId) Should be called during initialization of the sequence, and not thereafter
void	setDestinationId(java.lang.String destinationId) Should be called during initialization of the sequence, and not thereafter
void	setEndpointEpr(com.sun.xml.ws.api.addressing.WSEndpointReference endpointEpr) Should be called during initialization of the sequence, and not thereafter
void	setExponentialBackoffEnabled(boolean exponentialBackoffEnabled) Should be called during initialization of the sequence, and not thereafter
void	setSenderDispatchKey(weblogic.wsee.reliability2.store.SenderDispatchFactory.Key senderDispatchKey)
boolean	syncUpWithAcks() Makes the sequence state consistent with its internal set of ack'd ranges, and makes any changes necessary to the state of the sequence to reflect them.
boolean	syncUpWithAcks(java.util.SortedSet<MessageRange> ranges) Makes the sequence state consistent with an incoming set of ack'd ranges, and makes any changes necessary to the state of the sequence to reflect them.
boolean	syncUpWithAcks(java.util.SortedSet<MessageRange> ranges, java.util.List<SourceSequence.Gap> gaps) Makes the sequence state consistent with an incoming set of ack'd ranges, and makes any changes necessary to the state of the sequence to reflect them, returning any gaps found in the acks received so far.
private void	writeObject(java.io.ObjectOutputStream out)

Methods inherited from class weblogic.wsee.reliability2.sequence.Sequence

addFinalAckToMessage, addPiggybackAckHeader, addPiggybackHeader, addPiggybackHeaders, addRequest, addRequestInternal, createPiggybackAckHeader, createPiggybackAckRequestHeader, dump, equals, flagPiggybackAck, flagPiggybackAckRequest, getAckRanges, getAddressingVersion, getAndClearPiggybackHeaders, getCreateSequenceMsgId, getCreationTime, getDeliveryAssurance, getExpires, getFinalMessageNum, getId, getIdleTimeout, getIncompleteSequenceBehavior, getLastActivityTime, getLastUpdatedTime, getLogicalStoreName, getMaxMessageNum, getObjectId, getOffer, getPhysicalStoreName, getPreviousState, getRequest, getRequestByMessageId, getRequests, getRmVersion, getSecurityContext, getSecurityInfo, getSoapVersion, getState, getSubject, getTimestamp, getUnackdCount, hasExplicitExpiration, hasFinalMessageNum, hashCode, hasPiggybackHeaders, isBuffered, isChanged, isExpired, isNonBuffered, isUsingSsl, markChanged, putBackUnusedPiggybackHeaders, setAddressingVersion, setCreateSequenceMsgId, setDeliveryAssurance, setExpires, setFinalMessageNum, setId, setIdleTimeout, setIncompleteSequenceBehavior, setLogicalStoreName, setNonBuffered, setOffer, setOfferSequenceId, setPhysicalStoreName, setSecurityContext, setSecurityInfo, setSoapVersion, setState, setSubject, setUnackedCount, setUnackedCountInternal, setUsingSsl, toString, touch

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

LOGGER

private static final java.util.logging.Logger LOGGER

_destinationId

private java.lang.String _destinationId

Id as known on the RM destination side after getting a CreateSequenceResponse

_endpointEpr

private transient com.sun.xml.ws.api.addressing.WSEndpointReference _endpointEpr

Endpoint reference describing where lifecycle, ack request, and fault messages related to the Sequence are to be sent. NOTE: We handle the serialization of this field directly.

_acksToEpr

private transient com.sun.xml.ws.api.addressing.WSEndpointReference _acksToEpr

Endpoint reference describing where this sequence expects the Acks it receives to be delivered. NOTE: We handle the serialization of this field directly.

_offerSequenceId

private java.lang.String _offerSequenceId

The offer sequence (if any) that we should be getting responses on. In 12g we allowed Sequence to manage this, but for back-compat reasons, we have to keep it local so serialization still works.

_lastAllocatedMessageNum

private long _lastAllocatedMessageNum

The message number for the most recent message to be sent on this source seq.

_complete

private boolean _complete

Indicates that we've identified a 'final' message in the sequence, and have sent that message, and received an ack for it and all prior messages.

_senderDispatchKey

private weblogic.wsee.reliability2.store.SenderDispatchFactory.Key _senderDispatchKey

Key needed to obtain a Dispatch instance for sending messages on this sequence via client-side-retry (SAF).

_creatingClientInstanceId

private weblogic.wsee.jaxws.spi.ClientInstanceIdentity _creatingClientInstanceId

Identity of the client instance that caused the creation of this sequence.

_baseRetransmissionInterval

private javax.xml.datatype.Duration _baseRetransmissionInterval

The starting time interval to wait between retries for sending a request on this sequence. The time may increase between retries if exponentialBackoffEnabled = true.

_exponentialBackoffEnabled

private boolean _exponentialBackoffEnabled

Flag to enable backing off the retry frequence (increasing the interval) between retries for sending a request on this sequence.

_firstRequestContext

private weblogic.wsee.jaxws.persistence.PersistentRequestContext _firstRequestContext

A snapshot of a RequestContext (map of properties) captured at the point where this sequence was created. These properties will be used for sending any protocol messages by setting them onto a Dispatch instance

Constructor Detail

SourceSequence

public SourceSequence(java.lang.String sourceId,
                      java.lang.String logicalStoreName,
                      WsrmConstants.RMVersion rmVersion,
                      com.sun.xml.ws.api.addressing.AddressingVersion addrVersion,
                      com.sun.xml.ws.api.SOAPVersion soapVersion,
                      SecurityInfo securityInfo,
                      WsrmSecurityContext securityCtx,
                      boolean nonBuffered,
                      weblogic.wsee.jaxws.persistence.PersistentRequestContext firstRequestContext)

Method Detail

initTransients

private void initTransients()

Make sure we have sane values for all our transient fields.

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

copyMessageInfo

public SourceMessageInfo copyMessageInfo(SourceMessageInfo info)

Specified by:

copyMessageInfo in class Sequence<SourceMessageInfo,DestinationOfferSequence,DestinationSequence,DestinationSequenceManager>

markMessageAckd

public boolean markMessageAckd(SourceMessageInfo info,
                               boolean ack)

getSourceId

public java.lang.String getSourceId()

getDestinationId

public java.lang.String getDestinationId()

getWireId

public java.lang.String getWireId()

Description copied from class: Sequence

The ID this sequence will be known by in protocol messages and headers on the wire between source and destination. Sequences can have several IDs, but only one is common/known between both this sequence and its peer on the other end of the wire.

Specified by:

getWireId in class Sequence<SourceMessageInfo,DestinationOfferSequence,DestinationSequence,DestinationSequenceManager>

getPeerEpr

public com.sun.xml.ws.api.addressing.WSEndpointReference getPeerEpr()

Description copied from class: Sequence

The peer endpoint reference. For source this is the EPR of the destination. For destination, this is the EPR of the source.

Specified by:

getPeerEpr in class Sequence<SourceMessageInfo,DestinationOfferSequence,DestinationSequence,DestinationSequenceManager>

getPublicEpr

public com.sun.xml.ws.api.addressing.WSEndpointReference getPublicEpr()

Description copied from class: Sequence

The public endpoint reference for this sequence. This is the address to which protocol messages may be sent (including responses to protocol messages sent from this sequence).

Specified by:

getPublicEpr in class Sequence<SourceMessageInfo,DestinationOfferSequence,DestinationSequence,DestinationSequenceManager>

getEndpointEpr

public com.sun.xml.ws.api.addressing.WSEndpointReference getEndpointEpr()

getAcksToEpr

public com.sun.xml.ws.api.addressing.WSEndpointReference getAcksToEpr()

getPiggybackEpr

public com.sun.xml.ws.api.addressing.WSEndpointReference getPiggybackEpr()

Description copied from class: Sequence

Find the EPR that represents the endpoint to which piggyback headers should be sent for the given sequence (this means different things for different subclasses).

Specified by:

getPiggybackEpr in class Sequence<SourceMessageInfo,DestinationOfferSequence,DestinationSequence,DestinationSequenceManager>

Returns:

The EPR to which piggyback headers for this sequence should be sent.

getRmFaultEpr

public com.sun.xml.ws.api.addressing.WSEndpointReference getRmFaultEpr()

Description copied from class: Sequence

Find the EPR that represents the endpoint at which WS-RM faults will be received. If a WS-RM fault is received and the host endpoint has an EPR that matches this EPR, then the fault is considered to be targeted at this sequence (as opposed to its counterpart on the other end of the wire).

Specified by:

getRmFaultEpr in class Sequence<SourceMessageInfo,DestinationOfferSequence,DestinationSequence,DestinationSequenceManager>

internalSetOfferSequenceId

protected void internalSetOfferSequenceId(java.lang.String offerSeqId)

Called by Sequence to manage offer. Note, no locking here

Specified by:

internalSetOfferSequenceId in class Sequence<SourceMessageInfo,DestinationOfferSequence,DestinationSequence,DestinationSequenceManager>

getOfferSequenceId

public java.lang.String getOfferSequenceId()

Called by Sequence to manage offer. Note, no locking here

Specified by:

getOfferSequenceId in class Sequence<SourceMessageInfo,DestinationOfferSequence,DestinationSequence,DestinationSequenceManager>

getNextMessageNum

public long getNextMessageNum()

Increments and gets (post-increment) the last allocated message num for this sequence. Callers must understand they are comitting to send a message with this message num, and not call getNextMessageNum again until a message has been sent with that num.

setDestinationId

public void setDestinationId(java.lang.String destinationId)

Should be called during initialization of the sequence, and not thereafter

setEndpointEpr

public void setEndpointEpr(com.sun.xml.ws.api.addressing.WSEndpointReference endpointEpr)

Should be called during initialization of the sequence, and not thereafter

setAcksToEpr

public void setAcksToEpr(com.sun.xml.ws.api.addressing.WSEndpointReference acksToEpr)

Should be called only during initialization of the sequence, and not thereafter.

syncUpWithAcks

public boolean syncUpWithAcks()

Makes the sequence state consistent with its internal set of ack'd ranges, and makes any changes necessary to the state of the sequence to reflect them. This method is useful for making sure the sequence recheck its own state with regard to acks.

Returns:

Returns true if any state in the sequence changed and should be flushed to persistent storage.

syncUpWithAcks

public boolean syncUpWithAcks(java.util.SortedSet<MessageRange> ranges)

Makes the sequence state consistent with an incoming set of ack'd ranges, and makes any changes necessary to the state of the sequence to reflect them. Passing the sequence's current set of ack ranges is useful for making sure the sequence recheck its own state with regard to acks.

Returns:

Returns true if any state in the sequence changed and should be flushed to persistent storage.

syncUpWithAcks

public boolean syncUpWithAcks(java.util.SortedSet<MessageRange> ranges,
                              java.util.List<SourceSequence.Gap> gaps)

Makes the sequence state consistent with an incoming set of ack'd ranges, and makes any changes necessary to the state of the sequence to reflect them, returning any gaps found in the acks received so far. Passing the sequence's current set of ack ranges is useful for making sure the sequence recheck its own state with regard to acks.

Parameters:

ranges - A set of ranges you want to check (generally either from this sequence itself via getAckRanges, or from an incoming ack off the wire.

gaps - An output param that allows the caller to see any gaps we found in the supplied ack ranges.

Returns:

Returns true if any state in the sequence changed and should be flushed to persistent storage.

setComplete

private void setComplete(boolean complete)

isComplete

public boolean isComplete()

isAllRequestsAckedAndReplied

public boolean isAllRequestsAckedAndReplied()

Note: pls call the metod only under iscomplete = true. it's meaninglessful is the requests is not complete.

getFirstRequestContext

public weblogic.wsee.jaxws.persistence.PersistentRequestContext getFirstRequestContext()

getSenderDispatchKey

public weblogic.wsee.reliability2.store.SenderDispatchFactory.Key getSenderDispatchKey()

setSenderDispatchKey

public void setSenderDispatchKey(weblogic.wsee.reliability2.store.SenderDispatchFactory.Key senderDispatchKey)

getCreatingClientInstanceId

public weblogic.wsee.jaxws.spi.ClientInstanceIdentity getCreatingClientInstanceId()

setCreatingClientInstanceId

public void setCreatingClientInstanceId(weblogic.wsee.jaxws.spi.ClientInstanceIdentity creatingClientInstanceId)

Should be called during initialization of the sequence, and not thereafter

getBaseRetransmissionInterval

public javax.xml.datatype.Duration getBaseRetransmissionInterval()

setBaseRetransmissionInterval

public void setBaseRetransmissionInterval(javax.xml.datatype.Duration baseRetransmissionInterval)

Should be called during initialization of the sequence, and not thereafter

isExponentialBackoffEnabled

public boolean isExponentialBackoffEnabled()

setExponentialBackoffEnabled

public void setExponentialBackoffEnabled(boolean exponentialBackoffEnabled)

Should be called during initialization of the sequence, and not thereafter