Package org.apache.cxf.ws.rm.manager

Class SequenceTerminationPolicyType

java.lang.Object
org.apache.cxf.ws.rm.manager.SequenceTerminationPolicyType
public class SequenceTerminationPolicyType extends Object

Java class for SequenceTerminationPolicyType complex type

.

The following schema fragment specifies the expected content contained within this class.


 <complexType name="SequenceTerminationPolicyType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="maxLength" type="{http://www.w3.org/2001/XMLSchema}long" default="0" />
       <attribute name="maxRanges" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
       <attribute name="maxUnacknowledged" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
       <attribute name="terminateOnShutdown" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • maxLength

      protected Long maxLength
      The maximum length of a sequence. A value of 0 means the sequence length is unbound.

    • maxRanges

      protected Integer maxRanges
      The maximum number of acknowledgment ranges tolerated in sequence acknowledgment. When this value is exceeded the sequence will be terminated. A value of 0 means sequence termination does not depend on the number of acknowledgment ranges.

    • maxUnacknowledged

      protected Integer maxUnacknowledged
      The maximum number of unacknowledged messages that can accrue within per sequence before the sequence is terminated. A value of 0 means sequence termination does not depend on the number of unacknowledgment messages.

    • terminateOnShutdown

      protected Boolean terminateOnShutdown
      Specifies if sequences should be terminated when the bus is shutdown. If set to true, and no last message had been sent for a sequence, an out of band LastMessage or CloseSequence will be issued (in response to which a sequence acknowledgment will be sent). If a last message had already been sent, an acknowledgment is requested instead. If, after processing these acknowledgement, all messages have been acknowledged, an attempt is then made to terminate these sequences.

  • Constructor Details

    • SequenceTerminationPolicyType

      public SequenceTerminationPolicyType()

  • Method Details

    • setMaxLength

      public void setMaxLength(long value)
      Sets the value of the maxLength property.

    • unsetMaxLength

      public void unsetMaxLength()

    • isSetMaxLength

      public boolean isSetMaxLength()

    • getMaxLength

      public long getMaxLength()
      The maximum length of a sequence. A value of 0 means the sequence length is unbound.

    • setMaxRanges

      public void setMaxRanges(int value)
      Sets the value of the maxRanges property.

    • unsetMaxRanges

      public void unsetMaxRanges()

    • isSetMaxRanges

      public boolean isSetMaxRanges()

    • getMaxRanges

      public int getMaxRanges()
      The maximum number of acknowledgment ranges tolerated in sequence acknowledgment. When this value is exceeded the sequence will be terminated. A value of 0 means sequence termination does not depend on the number of acknowledgment ranges.

    • setMaxUnacknowledged

      public void setMaxUnacknowledged(int value)
      Sets the value of the maxUnacknowledged property.

    • unsetMaxUnacknowledged

      public void unsetMaxUnacknowledged()

    • isSetMaxUnacknowledged

      public boolean isSetMaxUnacknowledged()

    • getMaxUnacknowledged

      public int getMaxUnacknowledged()
      The maximum number of unacknowledged messages that can accrue within per sequence before the sequence is terminated. A value of 0 means sequence termination does not depend on the number of unacknowledgment messages.

    • setTerminateOnShutdown

      public void setTerminateOnShutdown(boolean value)
      Sets the value of the terminateOnShutdown property.

    • unsetTerminateOnShutdown

      public void unsetTerminateOnShutdown()

    • isSetTerminateOnShutdown

      public boolean isSetTerminateOnShutdown()

    • isTerminateOnShutdown

      public boolean isTerminateOnShutdown()
      Specifies if sequences should be terminated when the bus is shutdown. If set to true, and no last message had been sent for a sequence, an out of band LastMessage or CloseSequence will be issued (in response to which a sequence acknowledgment will be sent). If a last message had already been sent, an acknowledgment is requested instead. If, after processing these acknowledgement, all messages have been acknowledged, an attempt is then made to terminate these sequences.