Package com.oracle.webservices.oracle_internal_api.rm

Class InboundAccepted

java.lang.Object
com.oracle.webservices.api.message.BasePropertySet
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.

  • Field Details

  • Constructor Details

    • InboundAccepted

      protected InboundAccepted()
      Default constructor.

  • Method Details

    • 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:

    • 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:
      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.
      See Also:

    • 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:

    • 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:

    • 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;
 }
      or if the implementation is in different Java module. 
       private static final PropertyMap model;
 static {
   model = parse(MyDerivedClass.class, MethodHandles.lookup());
 }
 protected PropertyMap getPropertyMap() {
   return model;
 }
      Specified by:
      getPropertyMap in class BasePropertySet
      Returns:
      the map of strongly-typed known properties keyed by property names