com.oracle.webservices.api.rm

Annotation Type ReliableMessaging

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @WebServiceFeatureAnnotation(id="com.oracle.webservices.api.rm.ReliableMessagingFeature",
                             bean=ReliableMessagingFeature.class)
public @interface ReliableMessaging

Configure WS-ReliableMessaging.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	acknowledgementInterval Applies to: WLS RM, Metro RM.
ReliableMessagingVersion	destinationAllowedVersions Applies to: WLS RM, Metro RM, JRF RM.
boolean	destinationNonBuffered Applies to: WLS RM.
boolean	enabled Enable this feature.
String	inactivityTimeout Applies to: WLS RM, Metro RM, JRF RM.
long	maxRetryCount Applies to: WLS RM, Metro RM.
boolean	optional Applies to: WLS RM.
String	sequenceExpiration Applies to WLS RM.
boolean	sequenceInOrder Applies to WLS RM, Metro RM, JRF RM.
SequenceQOS	sequenceQOS Applies to WLS RM, Metro RM, JRF RM.
boolean	sequenceSTR Applies to WLS RM, Metro RM.
boolean	sequenceTransportSecurity Applies to WLS RM, Metro RM.
BackoffAlgorithmType	sourceBackoffAlgorithm Applies to: WLS RM, Metro RM.
String	sourceBaseRetransmissionInterval Applies to WLS RM, Metro RM, JRF RM.
ReliableMessagingVersion	sourceVersion Applies to WLS RM, Metro RM, JRF RM.

Element Detail

acknowledgementInterval

public abstract String acknowledgementInterval

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.

Default:

"P0DT0.2S"

destinationAllowedVersions

public abstract ReliableMessagingVersion destinationAllowedVersions

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).

Default:

com.oracle.webservices.api.rm.ReliableMessagingVersion.DEFAULT

destinationNonBuffered

public abstract boolean destinationNonBuffered

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.

Default:

false

enabled

public abstract boolean enabled

Enable this feature. Defaults to true.

Default:

true

inactivityTimeout

public abstract String inactivityTimeout

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.

Default:

"P0DT600S"

maxRetryCount

public abstract long maxRetryCount

Applies to: WLS RM, Metro RM.

Default:

-1L

optional

public abstract boolean optional

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.

Default:

false

sequenceExpiration

public abstract String sequenceExpiration

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.

Default:

"P1D"

sequenceInOrder

public abstract boolean sequenceInOrder

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

Default:

false

sequenceQOS

public abstract SequenceQOS sequenceQOS

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

Default:

com.oracle.webservices.api.rm.SequenceQOS.EXACTLY_ONCE

sequenceSTR

public abstract boolean sequenceSTR

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.

Default:

false

sequenceTransportSecurity

public abstract boolean sequenceTransportSecurity

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.

Default:

false

sourceBackoffAlgorithm

public abstract BackoffAlgorithmType sourceBackoffAlgorithm

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.

Default:

com.oracle.webservices.api.BackoffAlgorithmType.NONE

sourceBaseRetransmissionInterval

public abstract String sourceBaseRetransmissionInterval

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.

Default:

"P0DT3S"

sourceVersion

public abstract ReliableMessagingVersion sourceVersion

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.

Default:

com.oracle.webservices.api.rm.ReliableMessagingVersion.WS_RM_1_2