com.oracle.webservices.api.rm

Class ReliableMessagingFeature

java.lang.Object

javax.xml.ws.WebServiceFeature

com.oracle.webservices.api.rm.ReliableMessagingFeature

public class ReliableMessagingFeature
extends WebServiceFeature

Configure WS-ReliableMessaging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReliableMessagingFeature.Builder Configure WS-ReliableMessaging.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ACKNOWLEDGEMENT_INTERVAL Applies to: WLS RM, Metro RM.
static String	ID

Method Summary

Modifier and Type	Method and Description
static ReliableMessagingFeature.Builder	builder()
boolean	equals(Object o)
String	getAcknowledgementInterval()
ReliableMessagingVersion	getDestinationAllowedVersions() Applies to: WLS RM, Metro RM, JRF RM.
String	getID()
String	getInactivityTimeout() Applies to: WLS RM, Metro RM, JRF RM.
long	getMaxRetryCount() Applies to: WLS RM, Metro RM.
static String	getSeedPolicyName()
String	getSequenceExpiration() Applies to WLS RM.
SequenceQOS	getSequenceQOS() Applies to WLS RM, Metro RM, JRF RM.
BackoffAlgorithmType	getSourceBackoffAlgorithm() Applies to: WLS RM, Metro RM.
String	getSourceBaseRetransmissionInterval() Applies to WLS RM, Metro RM, JRF RM.
ReliableMessagingVersion	getSourceVersion() Applies to WLS RM, Metro RM, JRF RM.
int	hashCode()
boolean	isDestinationNonBuffered() Applies to: WLS RM.
boolean	isOptional() Applies to: WLS RM.
boolean	isSequenceInOrder() Applies to WLS RM, Metro RM, JRF RM.
boolean	isSequenceSTR() Applies to WLS RM, Metro RM.
boolean	isSequenceTransportSecurity() Applies to WLS RM, Metro RM.
String	toString()

Methods inherited from class javax.xml.ws.WebServiceFeature

isEnabled

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_ACKNOWLEDGEMENT_INTERVAL

public static final String DEFAULT_ACKNOWLEDGEMENT_INTERVAL

Applies to: WLS RM, Metro RM. Since RM1.0. Value in Duration format defining the maximum time a pending ack (set after the destination accepts a message) can wait before being delivered back to the RM source (service) or before the client explicitly requests an Ack (client). Defaults to P0DT0.2S (200 milliseconds). Set at sequence creation time, and cannot be reset.

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

Method Detail

builder

public static ReliableMessagingFeature.Builder builder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getAcknowledgementInterval

public String getAcknowledgementInterval()

getDestinationAllowedVersions

public ReliableMessagingVersion getDestinationAllowedVersions()

Applies to: WLS RM, Metro RM, JRF RM. Default is to support versions 1.0, 1.1 and 1.2. When more than on version is enabled the generated WSDL will have policy alternatives for the given versions. That enables the client to pick any version they want (they must consistently use that version of the protocol for all interaction with a given sequence).

getID

public String getID()

Specified by:

getID in class WebServiceFeature

getInactivityTimeout

public String getInactivityTimeout()

Applies to: WLS RM, Metro RM, JRF RM. Since RM1.0. Value in Duration format. If during this duration, an endpoint (RM source or RM destination) has received no application or control messages, the endpoint MAY consider the RM Sequence to have been terminated due to inactivity. Defaults to P0DT600S (600 seconds). Implementations of RM source and RM destination are free to manage resources associated with the sequence as they please, but in general, there are no guarantees that the sequence will be useable by either party after the inactivity timeout expires. Set at sequence creation time, and cannot be reset.

getMaxRetryCount

public long getMaxRetryCount()

Applies to: WLS RM, Metro RM.

getSeedPolicyName

public static String getSeedPolicyName()

getSequenceExpiration

public String getSequenceExpiration()

Applies to WLS RM. Since RM1.0. Duration expression. This is the maximum lifetime of a sequence. If this limit is reached before the sequence naturally completes, it will be forcibly terminated. Defaults to P1D (1 day). Set at sequence creation time, and cannot be reset.

getSequenceQOS

public SequenceQOS getSequenceQOS()

Applies to WLS RM, Metro RM, JRF RM. Since RM1.x.

getSourceBackoffAlgorithm

public BackoffAlgorithmType getSourceBackoffAlgorithm()

Applies to: WLS RM, Metro RM. Since RM1.0. The retransmission interval will be adjusted using the given algorithm. Defaults to NONE. Valid values are NONE, EXPONENTIAL. Set at sequence creation time. Cannot be reset once sequence is created.

getSourceBaseRetransmissionInterval

public String getSourceBaseRetransmissionInterval()

Applies to WLS RM, Metro RM, JRF RM. Since RM1.0. The interval of time that must pass before a message will be retransmitted to the RM destination (in the event a prior transmission failed). Defaults to P0DT3S (3 seconds). Set at sequence creation time, and cannot be reset.

getSourceVersion

public ReliableMessagingVersion getSourceVersion()

Applies to WLS RM, Metro RM, JRF RM. When the service WSDL contains policy alternatives for multiple RM versions the client can pick the version via this attribute. If the WSDL contains multiple RM versions and this attribute is not explicitly set then either RM1.2 is used or the highest version in the WSDL if the WSDL does not contain RM1.2. If the WSDL only contains one RM version then this attribute is ignored and the version in the WSDL is used.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isDestinationNonBuffered

public boolean isDestinationNonBuffered()

Applies to: WLS RM. Flag indicating that non-buffered receipt of messages is requested. Defaults to the value of WebServiceMBean.getPersistentDestination(). Set at sequence creation time, and cannot be reset.

isOptional

public boolean isOptional()

Applies to: WLS RM. Enables a service endpoint to support reliable or non-reliable communication with different clients. Just enabling RM on a service means every message into that service must be reliable. With 'optional' a given client can choose to send requests reliably or not if isOptional=true. In other words, short-hand for WS-Policy's multiple policy alternatives. So a service can have an optional WS-RM endpoint policy and a client is then free to call the service either with or without the WS-RM protocol. The service is obligated to handle either. Another use-case: used in combination with operation-level "required" WS-RM policy. That way operations without an explicit WS-RM policy do not need to be called with the WS-RM protocol, but operations with an explicit WS-RM policy must be called via the WS-RM protocol.

isSequenceInOrder

public boolean isSequenceInOrder()

Applies to WLS RM, Metro RM, JRF RM. Since RM1.x.

isSequenceSTR

public boolean isSequenceSTR()

Applies to WLS RM, Metro RM. Since RM1.x. If true, that indicates the requirement that an RM Sequence MUST be bound to an explicit token that is referenced from a wsse:SecurityTokenReference in the CreateSequence message. See section 2.5.1 of the WS-RM 1.1 spec.

isSequenceTransportSecurity

public boolean isSequenceTransportSecurity()

Applies to WLS RM, Metro RM. Since RM1.x. Defines the requirement that an RM Sequence MUST be bound to the session(s) of the underlying transport-level protocol used to carry the CreateSequence and CreateSequenceResponse message. When present, this assertion MUST be used in conjunction with the sp:TransportBinding assertion, see section 2.5.2.

toString

public String toString()

Overrides:

toString in class Object