com.oracle.webservices.oracle_internal_api.rm
Class InboundAccepted

java.lang.Object
  extended by com.oracle.webservices.api.message.BasePropertySet
      extended by com.oracle.webservices.oracle_internal_api.rm.InboundAccepted
All Implemented Interfaces:
PropertySet
Direct Known Subclasses:
InboundAcceptedImpl

public abstract class InboundAccepted
extends BasePropertySet

InboundAccepted is created by the RMD.

It is passed as a PropertySet to com.oracle.webservices.api.disi.ProviderRequest#request.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.oracle.webservices.api.message.BasePropertySet
BasePropertySet.Accessor, BasePropertySet.PropertyMap, BasePropertySet.PropertyMapEntry
 
Nested classes/interfaces inherited from interface com.oracle.webservices.api.message.PropertySet
PropertySet.Property
 
Field Summary
static String ACCEPTED_PROPERTY
          Key for accepted property
static String RM_MESSAGE_NUMBER_PROPERTY
          Key for inbound RM message number
static String RM_SEQUENCE_ID_PROPERTY
          Key for inbound RM sequence id
 
Constructor Summary
InboundAccepted()
           
 
Method Summary
abstract  Boolean getAccepted()
           
protected  BasePropertySet.PropertyMap getPropertyMap()
          Map representing the Fields and Methods annotated with PropertySet.Property.
abstract  long getRMMessageNumber()
           
abstract  String getRMSequenceId()
           
abstract  void setAccepted(Boolean accept)
          When the user determines that the message has been delivered to them then they call #setAccepted(true).
 
Methods inherited from class com.oracle.webservices.api.message.BasePropertySet
asMap, containsKey, createEntrySet, createMapView, createView, get, mapAllowsAdditionalProperties, parse, put, remove, supports
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACCEPTED_PROPERTY

public static final String ACCEPTED_PROPERTY
Key for accepted property

See Also:
getAccepted(), setAccepted(java.lang.Boolean), Constant Field Values

RM_SEQUENCE_ID_PROPERTY

public static final String RM_SEQUENCE_ID_PROPERTY
Key for inbound RM sequence id

See Also:
getRMSequenceId(), Constant Field Values

RM_MESSAGE_NUMBER_PROPERTY

public static final String RM_MESSAGE_NUMBER_PROPERTY
Key for inbound RM message number

See Also:
getRMMessageNumber(), Constant Field Values
Constructor Detail

InboundAccepted

public InboundAccepted()
Method Detail

getAccepted

public abstract Boolean getAccepted()
Returns:
the value set via setAccepted(java.lang.Boolean) or null if setAccepted(java.lang.Boolean) has not been called or if the call to setAccepted(java.lang.Boolean) resulted in InboundAcceptedAcceptFailed being thrown.
See Also:
ACCEPTED_PROPERTY, setAccepted(java.lang.Boolean)

setAccepted

public abstract void setAccepted(Boolean accept)
                          throws InboundAcceptedAcceptFailed

When the user determines that the message has been delivered to them then they call #setAccepted(true).

The RMD will not acknowledge the message to the RMS until #setAccepted(true) is called.

If the user calls #setAccepted(false) then the RMD will not acknowledge the delivery of this particular request. Note: if the RMS sends a retry, that is considered a new request and the delivery/acceptance process starts anew.

If the user calls #setAccepted(false) and an atomic transaction is being used to handle the message, then that transaction will be rolled back.

Throws:
{@link - InboundAcceptedAcceptFailed} If the user calls #accepted(true) but the RMD is not able to internally record the message as delivered (e.g., an atomic transaction fails to commit) then this exception is thrown.
InboundAcceptedAcceptFailed
See Also:
ACCEPTED_PROPERTY, getAccepted()

getRMSequenceId

public abstract String getRMSequenceId()
Returns:
The RM sequence id associated with the message. Note: it may be null if RM is not enabled.
See Also:
RM_SEQUENCE_ID_PROPERTY

getRMMessageNumber

public abstract long getRMMessageNumber()
Returns:
The RM message number associated with the message. Note: it may be -1 if RM is not enabled.
See Also:
RM_MESSAGE_NUMBER_PROPERTY

getPropertyMap

protected BasePropertySet.PropertyMap getPropertyMap()
Description copied from class: BasePropertySet
Map representing the Fields and Methods annotated with PropertySet.Property. Model of PropertySet class.

At the end of the derivation chain this method just needs to be implemented as:

 private static final PropertyMap model;
 static {
   model = parse(MyDerivedClass.class);
 }
 protected PropertyMap getPropertyMap() {
   return model;
 }
 

Specified by:
getPropertyMap in class BasePropertySet


Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.