Class InboundAccepted

    • Constructor Detail

      • InboundAccepted

        public InboundAccepted()
    • Method Detail

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