Package org.pipservices3.messaging.queues

Class MessagingCapabilities

java.lang.Object
org.pipservices3.messaging.queues.MessagingCapabilities
public class MessagingCapabilities
extends Object
Data object that contains supported capabilities of a message queue. If certain capability is not supported a queue will throw NotImplemented exception.

  • Constructor Summary

    Constructors
    Constructor Description
    MessagingCapabilities​(boolean messageCount, boolean send, boolean receive, boolean peek, boolean peekBatch, boolean renewLock, boolean abandon, boolean deadLetter, boolean clear)
    Creates a new instance of the capabilities object.

  • Method Summary

    Modifier and Type Method Description
    boolean canAbandon()
    Informs if the queue is able to abandon messages.
    boolean canClear()
    Informs if the queue can be cleared.
    boolean canDeadLetter()
    Informs if the queue is able to send messages to dead letter queue.
    boolean canMessageCount()
    Informs if the queue is able to read number of messages.
    boolean canPeek()
    Informs if the queue is able to peek messages.
    boolean canPeekBatch()
    Informs if the queue is able to peek multiple messages in one batch.
    boolean canReceive()
    Informs if the queue is able to receive messages.
    boolean canRenewLock()
    Informs if the queue is able to renew message lock.
    boolean canSend()
    Informs if the queue is able to send messages.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • MessagingCapabilities

      public MessagingCapabilities​(boolean messageCount, boolean send, boolean receive, boolean peek, boolean peekBatch, boolean renewLock, boolean abandon, boolean deadLetter, boolean clear)
      Creates a new instance of the capabilities object.
      Parameters:
      messageCount - true if queue supports reading message count.
      send - true if queue is able to send messages.
      receive - true if queue is able to receive messages.
      peek - true if queue is able to peek messages.
      peekBatch - true if queue is able to peek multiple messages in one batch.
      renewLock - true if queue is able to renew message lock.
      abandon - true if queue is able to abandon messages.
      deadLetter - true if queue is able to send messages to dead letter queue.
      clear - true if queue can be cleared.

  • Method Details

    • canMessageCount

      public boolean canMessageCount()
      Informs if the queue is able to read number of messages.
      Returns:
      true if queue supports reading message count.

    • canSend

      public boolean canSend()
      Informs if the queue is able to send messages.
      Returns:
      true if queue is able to send messages.

    • canReceive

      public boolean canReceive()
      Informs if the queue is able to receive messages.
      Returns:
      true if queue is able to receive messages.

    • canPeek

      public boolean canPeek()
      Informs if the queue is able to peek messages.
      Returns:
      true if queue is able to peek messages.

    • canPeekBatch

      public boolean canPeekBatch()
      Informs if the queue is able to peek multiple messages in one batch.
      Returns:
      true if queue is able to peek multiple messages in one batch.

    • canRenewLock

      public boolean canRenewLock()
      Informs if the queue is able to renew message lock.
      Returns:
      true if queue is able to renew message lock.

    • canAbandon

      public boolean canAbandon()
      Informs if the queue is able to abandon messages.
      Returns:
      true if queue is able to abandon.

    • canDeadLetter

      public boolean canDeadLetter()
      Informs if the queue is able to send messages to dead letter queue.
      Returns:
      true if queue is able to send messages to dead letter queue.

    • canClear

      public boolean canClear()
      Informs if the queue can be cleared.
      Returns:
      true if queue can be cleared.