Module org.glassfish.metro.wsit.api
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:
com.oracle.webservices.api.message.PropertySet
public abstract class InboundAccepted extends com.oracle.webservices.api.message.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

    com.oracle.webservices.api.message.BasePropertySet.Accessor, com.oracle.webservices.api.message.BasePropertySet.PropertyMap, com.oracle.webservices.api.message.BasePropertySet.PropertyMapEntry

    Nested classes/interfaces inherited from interface com.oracle.webservices.api.message.PropertySet

    com.oracle.webservices.api.message.PropertySet.Property

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ACCEPTED_PROPERTY
    Key for accepted property
    static final String
    RM_MESSAGE_NUMBER_PROPERTY
    Key for inbound RM message number
    static final String
    RM_SEQUENCE_ID_PROPERTY
    Key for inbound RM sequence id

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    InboundAccepted()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract Boolean
    getAccepted()
     
    protected com.oracle.webservices.api.message.BasePropertySet.PropertyMap
    getPropertyMap()
     
    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, createView, get, mapAllowsAdditionalProperties, parse, parse, put, remove, supports

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 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 com.oracle.webservices.api.message.BasePropertySet.PropertyMap getPropertyMap()
      Specified by:
      getPropertyMap in class com.oracle.webservices.api.message.BasePropertySet