BrokerClientInfo (webMethods Broker Administration Programming Interfaces)

java.lang.Object
- COM.activesw.api.client.BrokerClientInfo

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

Field Summary

Fields
Modifier and Type	Field and Description
`short[]`	`access_label` The client's access label.
`boolean`	`ack_volatile` Whether or not volatile events must be explicitly acknowledged.
`java.lang.String`	`admin_id` Client id of the admin client holding the queue lock
`java.lang.String`	`app_name` The client application name.
`java.lang.String`	`authenticator_name` The client's owner's authenticator name.
`boolean`	`can_share_state` Whether or not the client can share state.
`java.lang.String`	`client_group` The client group.
`java.lang.String`	`client_id` The client ID.
`java.lang.String`	`client_lifecycle` The client's lifecycle.
`boolean`	`client_queue_locked` Client queue locked status
`java.lang.String`	`client_storage` The client's storage.
`boolean`	`forced_reconnect` Whether or not the forced reconnect feature set.
`long`	`high_pub_seqn` The highest publish sequence number used by the client.
`BrokerDate`	`lock_created` Time when the lock was acquired
`boolean`	`priority_ordering` The client's priority_ordering.
`static java.lang.String`	`REDELIVERY_COUNT_AUTOMATIC`
`static java.lang.String`	`REDELIVERY_COUNT_MANUAL`
`java.lang.String`	`redelivery_count_mode` The redelivery count mode for client.
`int`	`session_id` Session id of the admin client holding the queue lock
`BrokerClientSession[]`	`sessions` Information about any currently connected sessions.
`java.lang.String`	`shared_event_ordering` The ordering mode applied to shared state client.
`int`	`state_share_limit` The maximum number of shared state connections.
`java.lang.String`	`user_name` The client's owner's user name.

Constructor Summary

Constructors
Constructor and Description
`BrokerClientInfo()` Create an empty client info.
`BrokerClientInfo(java.lang.String new_client_id, java.lang.String new_client_group, java.lang.String new_app_name, boolean new_can_share_state, java.lang.String new_shared_event_ordering, int new_state_share_limit, long new_high_pub_seqn)` Create an entry with values set.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`toCompleteString()` Returns a string with the client info in a form suitable for human viewing.
`java.lang.String`	`toString()` Returns a string with the client info in a form suitable for human viewing.
`java.lang.String`	`toString(boolean show_transient_info)` Returns a string with the client info in a form suitable for human viewing.
`java.lang.String`	`toString(int indent_level)` Returns a string with the client info in a form suitable for human viewing.
`java.lang.String`	`toString(int indent_level, boolean show_transient_info)` Returns a string with the client info in a form suitable for human viewing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - REDELIVERY_COUNT_AUTOMATIC
```
public static final java.lang.String REDELIVERY_COUNT_AUTOMATIC
```
    See Also:
    
    Constant Field Values
  - REDELIVERY_COUNT_MANUAL
```
public static final java.lang.String REDELIVERY_COUNT_MANUAL
```
    See Also:
    
    Constant Field Values
  - client_id
```
public java.lang.String client_id
```
    The client ID.
  - client_group
```
public java.lang.String client_group
```
    The client group.
  - app_name
```
public java.lang.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 java.lang.String shared_event_ordering
```
    The ordering mode applied to shared state client. Valid values are BrokerConnectionDescriptor.SHARED_ORDER_*.
  - redelivery_count_mode
```
public java.lang.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 java.lang.String client_storage
```
    The client's storage. If unset, defaults to client group's setting.
  - client_lifecycle
```
public java.lang.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 java.lang.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 java.lang.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 java.lang.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 Detail
  - BrokerClientInfo
```
public BrokerClientInfo()
```
    Create an empty client info.
  - BrokerClientInfo
```
public BrokerClientInfo(java.lang.String new_client_id,
                        java.lang.String new_client_group,
                        java.lang.String new_app_name,
                        boolean new_can_share_state,
                        java.lang.String new_shared_event_ordering,
                        int new_state_share_limit,
                        long new_high_pub_seqn)
```
    Create an entry with values set.
- Method Detail
  - toString
```
public java.lang.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 java.lang.Object
  - toString
```
public java.lang.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 java.lang.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 java.lang.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 java.lang.String toCompleteString()
```
    Returns a string with the client info in a form suitable for human viewing. This string includes all the session information.

Copyright © 2002-2006 webMethods, Inc. Copyright © 2007-2021 Software AG Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.

Class BrokerClientInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REDELIVERY_COUNT_AUTOMATIC

REDELIVERY_COUNT_MANUAL

client_id

client_group

app_name

can_share_state

state_share_limit

shared_event_ordering

redelivery_count_mode

priority_ordering

forced_reconnect

ack_volatile

client_storage

client_lifecycle

high_pub_seqn

user_name

authenticator_name

access_label

client_queue_locked

admin_id

session_id

lock_created

sessions

Constructor Detail

BrokerClientInfo

BrokerClientInfo

Method Detail

toString

toString

toString

toString

toCompleteString