Record Class EsbBrokerCapabilities

java.lang.Object
java.lang.Record
com.kingsrook.qqq.esb.management.EsbBrokerCapabilities
public record EsbBrokerCapabilities(boolean browse, boolean queueInfo, boolean pauseQueue, boolean purge, boolean deleteSelected, boolean deleteOlderThan, boolean move) extends Record
The broker queue management actions (spec section 8) that a provider's broker supports - so the UI shows, and the operate processes allow, only those. - browse: list a queue's messages (plain JMS, so every broker). - queueInfo: report a queue's depth and consumer count. - pauseQueue: pause (and resume) delivery to all of a queue's consumers. - purge: remove all of a queue's messages. - deleteSelected: remove messages by JMS message id. - deleteOlderThan: remove messages older than a time. - move: move messages by JMS message id to another queue. Each EsbBrokerAdapter reports its broker's; WITHOUT_MANAGEMENT is for a provider with no management API (no managementUrl), which can only browse.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final EsbBrokerCapabilities
    WITHOUT_MANAGEMENT
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    EsbBrokerCapabilities(boolean browse, boolean queueInfo, boolean pauseQueue, boolean purge, boolean deleteSelected, boolean deleteOlderThan, boolean move)
    Creates an instance of a EsbBrokerCapabilities record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    browse()
    Returns the value of the browse record component.
    boolean
    deleteOlderThan()
    Returns the value of the deleteOlderThan record component.
    boolean
    deleteSelected()
    Returns the value of the deleteSelected record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    move()
    Returns the value of the move record component.
    boolean
    pauseQueue()
    Returns the value of the pauseQueue record component.
    boolean
    purge()
    Returns the value of the purge record component.
    boolean
    queueInfo()
    Returns the value of the queueInfo record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • EsbBrokerCapabilities

      public EsbBrokerCapabilities(boolean browse, boolean queueInfo, boolean pauseQueue, boolean purge, boolean deleteSelected, boolean deleteOlderThan, boolean move)
      Creates an instance of a EsbBrokerCapabilities record class.
      Parameters:
      browse - the value for the browse record component
      queueInfo - the value for the queueInfo record component
      pauseQueue - the value for the pauseQueue record component
      purge - the value for the purge record component
      deleteSelected - the value for the deleteSelected record component
      deleteOlderThan - the value for the deleteOlderThan record component
      move - the value for the move record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • browse

      public boolean browse()
      Returns the value of the browse record component.
      Returns:
      the value of the browse record component

    • queueInfo

      public boolean queueInfo()
      Returns the value of the queueInfo record component.
      Returns:
      the value of the queueInfo record component

    • pauseQueue

      public boolean pauseQueue()
      Returns the value of the pauseQueue record component.
      Returns:
      the value of the pauseQueue record component

    • purge

      public boolean purge()
      Returns the value of the purge record component.
      Returns:
      the value of the purge record component

    • deleteSelected

      public boolean deleteSelected()
      Returns the value of the deleteSelected record component.
      Returns:
      the value of the deleteSelected record component

    • deleteOlderThan

      public boolean deleteOlderThan()
      Returns the value of the deleteOlderThan record component.
      Returns:
      the value of the deleteOlderThan record component

    • move

      public boolean move()
      Returns the value of the move record component.
      Returns:
      the value of the move record component