public interface SequenceData
  • Method Details

    • getSequenceId

      String getSequenceId()
    • getExpirationTime

      long getExpirationTime()
    • getBoundSecurityTokenReferenceId

      String getBoundSecurityTokenReferenceId()
    • getLastMessageNumber

      long getLastMessageNumber()
    • getAckRequestedFlag

      boolean getAckRequestedFlag()
    • setAckRequestedFlag

      void setAckRequestedFlag(boolean newValue)
    • getLastAcknowledgementRequestTime

      long getLastAcknowledgementRequestTime()
    • setLastAcknowledgementRequestTime

      void setLastAcknowledgementRequestTime(long newTime)
    • getLastActivityTime

      long getLastActivityTime()
      Returns:
      last activity time of the sequence
    • getState

      Sequence.State getState()
    • setState

      void setState(Sequence.State newState)
    • incrementAndGetLastMessageNumber

      long incrementAndGetLastMessageNumber(boolean received)
      Increments last message number on the sequence and returns new last message number value. Method automatically marks the newly created message number as unacknowledged.
      Parameters:
      received - this flag specifies whether the message with such number should be marked as received on the sequence.
      Returns:
      new value of the last message number
    • registerReceivedUnackedMessageNumber

      void registerReceivedUnackedMessageNumber(long messageNumber) throws DuplicateMessageRegistrationException
      Registers the message number as unacknowledged.

      If the value of messageNumber parameter is greater that the actual last mesasge number, the last message number value is increased to the value of messageNumber parameter. All message numbers lying between the original and new value of last message number are automatically marked as unacknowldeged and not received.

      Parameters:
      messageNumber - unacknowledged message number to register
      Throws:
      DuplicateMessageRegistrationException - in case such registration already exists
    • markAsAcknowledged

      void markAsAcknowledged(long messageNumber)
      Removes the provided messageNumber from the collection of unacked message numbers and and marks stored message with given messageNumber (if any) as eligible for removal from the underlying message storage. This method does nothing if there's no such unacknowledged message number found
    • isFailedOver

      boolean isFailedOver(long messageNumber)
    • attachMessageToUnackedMessageNumber

      void attachMessageToUnackedMessageNumber(ApplicationMessage message)
    • retrieveMessage

      ApplicationMessage retrieveMessage(String correlationId)
    • getUnackedMessageNumbers

      List<Long> getUnackedMessageNumbers()
    • getLastMessageNumberWithUnackedMessageNumbers

      List<Long> getLastMessageNumberWithUnackedMessageNumbers()
      In contrast to getUnackedMessageNumbers(), this method returns allways a non-empty List in which first item represents a current last message number value (see also getLastMessageNumber(). The items following the first item represent the collection of unacked message numbers (see also getUnackedMessageNumbers()).

      This special method was introduced in order to allow for an atomic retrieval of both values.

      Returns:
      List where first item represents the last message number and all subsequent values represent unacknowledged message numbers.