Package COM.activesw.api.client

Class BrokerClientInfo

java.lang.Object
COM.activesw.api.client.BrokerClientInfo
public class BrokerClientInfo extends Object
This class is a data structure used to describe client information.

  • Field Details

    • REDELIVERY_COUNT_AUTOMATIC

      public static final String REDELIVERY_COUNT_AUTOMATIC
      See Also:

    • REDELIVERY_COUNT_MANUAL

      public static final String REDELIVERY_COUNT_MANUAL
      See Also:

    • client_id

      public String client_id
      The client ID.

    • client_group

      public String client_group
      The client group.

    • app_name

      public String app_name
      The client application name.

    • can_share_state

      public boolean can_share_state
      Whether or not the client can share state.

    • state_share_limit

      public int state_share_limit
      The maximum number of shared state connections. -1 means has no limit. This is always 1 if can_share_state is false.

    • shared_event_ordering

      public String shared_event_ordering
      The ordering mode applied to shared state client. Valid values are BrokerConnectionDescriptor.SHARED_ORDER_*.

    • redelivery_count_mode

      public String redelivery_count_mode
      The redelivery count mode for client. Valid values are: null (if not configured), Automatic, Manual

    • priority_ordering

      public boolean priority_ordering
      The client's priority_ordering. If unset, defaults to false.

    • forced_reconnect

      public boolean forced_reconnect
      Whether or not the forced reconnect feature set.

    • ack_volatile

      public boolean ack_volatile
      Whether or not volatile events must be explicitly acknowledged.

    • client_storage

      public String client_storage
      The client's storage. If unset, defaults to client group's setting.

    • client_lifecycle

      public String client_lifecycle
      The client's lifecycle. If unset, defaults to client group's setting.

    • high_pub_seqn

      public long high_pub_seqn
      The highest publish sequence number used by the client.

    • user_name

      public String user_name
      The client's owner's user name. This will be null if the client was not created using an authenticated connection via SSL.

    • authenticator_name

      public String authenticator_name
      The client's owner's authenticator name. This will be null if the client was not created using an authenticated connection via SSL.

    • access_label

      public short[] access_label
      The client's access label. This will be null if the client was not created using an authenticated connection via SSL.

    • client_queue_locked

      public boolean client_queue_locked
      Client queue locked status

    • admin_id

      public String admin_id
      Client id of the admin client holding the queue lock

    • session_id

      public int session_id
      Session id of the admin client holding the queue lock

    • lock_created

      public BrokerDate lock_created
      Time when the lock was acquired

    • sessions

      public BrokerClientSession[] sessions
      Information about any currently connected sessions.

  • Constructor Details

    • BrokerClientInfo

      public BrokerClientInfo()
      Create an empty client info.

    • BrokerClientInfo

      public BrokerClientInfo(String new_client_id, String new_client_group, String new_app_name, boolean new_can_share_state, String new_shared_event_ordering, int new_state_share_limit, long new_high_pub_seqn)
      Create an entry with values set.

  • Method Details

    • toString

      public String toString()
      Returns a string with the client info in a form suitable for human viewing. This string does not include session information.
      Overrides:
      toString in class Object

    • toString

      public String toString(boolean show_transient_info)
      Returns a string with the client info in a form suitable for human viewing. This string does not include session information.

    • toString

      public String toString(int indent_level)
      Returns a string with the client info in a form suitable for human viewing. This string does not include session information.

    • toString

      public String toString(int indent_level, boolean show_transient_info)
      Returns a string with the client info in a form suitable for human viewing. This string does not include session information.

    • toCompleteString

      public String toCompleteString()
      Returns a string with the client info in a form suitable for human viewing. This string includes all the session information.