weblogic.wsee.reliability2.sequence

Class DestinationSequence

java.lang.Object

weblogic.wsee.reliability2.sequence.Sequence<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

weblogic.wsee.reliability2.sequence.DestinationSequence

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:

DestinationOfferSequence

public class DestinationSequence
extends Sequence<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>
implements java.io.Serializable

Represents a sequence from the RM destination perspective.

See Also:

Serialized Form

Excluded in public API Reference.

Nested Class Summary

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 javax.xml.datatype.Duration	_ackInterval The maximum amount of time to wait before delivering a pending ack.
private com.sun.xml.ws.api.addressing.WSEndpointReference	_acksToEpr Endpoint reference describing where acks are to be sent when an RM dest receives a request.
private weblogic.wsee.reliability2.io.dispatch.Key	_dispatchKey Key needed to obtain a Dispatch instance for sending messages on this sequence via a new destination-initiated connection.
private com.sun.xml.ws.api.addressing.WSEndpointReference	_hostEpr Endpoint reference describing our host service.
private java.lang.String	_offerSequenceId Represents an offer sequence that is used to send reliable responses to requests coming in to this sequence.
private static java.util.logging.Logger	LOGGER
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
DestinationSequence(java.lang.String id, 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)
DestinationSequence(java.lang.String id, WsrmConstants.RMVersion rmVersion, com.sun.xml.ws.api.addressing.AddressingVersion addrVersion, com.sun.xml.ws.api.SOAPVersion soapVersion)

Method Summary

Modifier and Type	Method and Description
Sequence.AddResult	addRequest(DestinationMessageInfo request) Add a request to this destination sequence, taking into account the expected quality of service.
long	calculateFinalResponseMessageNum()
DestinationMessageInfo	copyMessageInfo(DestinationMessageInfo info)
(package private) void	dispose()
javax.xml.datatype.Duration	getAckInterval()
com.sun.xml.ws.api.addressing.WSEndpointReference	getAcksToEpr()
java.util.List<weblogic.wsee.reliability2.headers.WsrmHeader>	getAndClearPiggybackHeaders()
private java.util.List<weblogic.wsee.reliability2.headers.WsrmHeader>	getAndClearPiggybackHeadersLocal(boolean isFinal) It will cause deadlock if calling the getState() in getPiggybackLock().writeLock(), so make the (state == SequenceState.CLOSE as parameter, the state is got before the piggybacklock.writelock.
weblogic.wsee.reliability2.io.dispatch.Key	getDispatchKey()
com.sun.xml.ws.api.addressing.WSEndpointReference	getHostEpr()
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.
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 fields which we mark transient and then directly serialize/deserialize.
protected void	internalSetOfferSequenceId(java.lang.String offerSeqId) Called by Sequence to manage offer.
boolean	isAnonymous()
private void	readObject(java.io.ObjectInputStream in)
void	setAckInterval(javax.xml.datatype.Duration ackInterval) Should be called during initialization of the sequence, and not thereafter
void	setAcksToEpr(com.sun.xml.ws.api.addressing.WSEndpointReference acksToEpr) Should be called during initialization of the sequence, and not thereafter
void	setDispatchKey(weblogic.wsee.reliability2.io.dispatch.Key dispatchKey)
void	setHostEpr(com.sun.xml.ws.api.addressing.WSEndpointReference hostEpr) Should be called during initialization of the sequence, and not thereafter
boolean	setState(SequenceState state)
private void	writeObject(java.io.ObjectOutputStream out)

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

addFinalAckToMessage, addPiggybackAckHeader, addPiggybackHeader, addPiggybackHeaders, addRequestInternal, createPiggybackAckHeader, createPiggybackAckRequestHeader, dump, equals, flagPiggybackAck, flagPiggybackAckRequest, getAckRanges, getAddressingVersion, 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, 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

_acksToEpr

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

Endpoint reference describing where acks are to be sent when an RM dest receives a request. NOTE: We handle the serialization of this field directly.

_hostEpr

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

Endpoint reference describing our host service. NOTE: We handle the serialization of this field directly.

_offerSequenceId

private java.lang.String _offerSequenceId

Represents an offer sequence that is used to send reliable responses to requests coming in to this sequence. If this is null, it means we don't have any offer sequence related to this sequence.

_dispatchKey

private weblogic.wsee.reliability2.io.dispatch.Key _dispatchKey

Key needed to obtain a Dispatch instance for sending messages on this sequence via a new destination-initiated connection.

_ackInterval

private javax.xml.datatype.Duration _ackInterval

The maximum amount of time to wait before delivering a pending ack. Defaults to P0DT0.2S (200 milliseconds).

Constructor Detail

DestinationSequence

public DestinationSequence(java.lang.String id,
                           WsrmConstants.RMVersion rmVersion,
                           com.sun.xml.ws.api.addressing.AddressingVersion addrVersion,
                           com.sun.xml.ws.api.SOAPVersion soapVersion)

DestinationSequence

public DestinationSequence(java.lang.String id,
                           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)

Method Detail

initTransients

private void initTransients()

Make sure we have sane values for all our fields which we mark transient and then directly serialize/deserialize.

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

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<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

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<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

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<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

copyMessageInfo

public DestinationMessageInfo copyMessageInfo(DestinationMessageInfo info)

Specified by:

copyMessageInfo in class Sequence<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

getAcksToEpr

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

getHostEpr

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

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<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

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<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

internalSetOfferSequenceId

protected void internalSetOfferSequenceId(java.lang.String offerSeqId)

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

Specified by:

internalSetOfferSequenceId in class Sequence<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

getOfferSequenceId

public java.lang.String getOfferSequenceId()

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

Specified by:

getOfferSequenceId in class Sequence<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

getDispatchKey

public weblogic.wsee.reliability2.io.dispatch.Key getDispatchKey()

setDispatchKey

public void setDispatchKey(weblogic.wsee.reliability2.io.dispatch.Key dispatchKey)

setState

public boolean setState(SequenceState state)

Overrides:

setState in class Sequence<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

dispose

void dispose()

setAcksToEpr

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

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

setHostEpr

public void setHostEpr(com.sun.xml.ws.api.addressing.WSEndpointReference hostEpr)

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

getAckInterval

public javax.xml.datatype.Duration getAckInterval()

setAckInterval

public void setAckInterval(javax.xml.datatype.Duration ackInterval)

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

calculateFinalResponseMessageNum

public long calculateFinalResponseMessageNum()

addRequest

public Sequence.AddResult addRequest(DestinationMessageInfo request)

Add a request to this destination sequence, taking into account the expected quality of service.

Overrides:

addRequest in class Sequence<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

Parameters:

request - The new request to add to the sequence

Returns:

True if the request was accepted for processing, false if it was duplicate.

isAnonymous

public boolean isAnonymous()

getAndClearPiggybackHeaders

public java.util.List<weblogic.wsee.reliability2.headers.WsrmHeader> getAndClearPiggybackHeaders()

Overrides:

getAndClearPiggybackHeaders in class Sequence<DestinationMessageInfo,SourceOfferSequence,SourceSequence,SourceSequenceManager>

getAndClearPiggybackHeadersLocal

@NotNull
private java.util.List<weblogic.wsee.reliability2.headers.WsrmHeader> getAndClearPiggybackHeadersLocal(boolean isFinal)

It will cause deadlock if calling the getState() in getPiggybackLock().writeLock(), so make the (state == SequenceState.CLOSE as parameter, the state is got before the piggybacklock.writelock.

Parameters:

isFinal - True if sequence is in the CLOSED state.

Returns:

The current list of headers to piggyback