com.lightstreamer.jmx

Interface AdapterSetMBean

public interface AdapterSetMBean

Multiple AdapterSetMBean instances exist in the system, where each one is related to one configured Adapter Set. Every configured Adapter Set is bound to one AdapterSetMBean instance. Each AdapterSetMBean instance is created at startup by Lightstreamer Server and lasts until the shutdown of the Server.

The main services provided by each MBean instance are:

• Some attributes of the Adapter Set (like getDataAdapterList()).
• Information on the sessions attached to the Adapter Set (like getCurrentSessions()).
• Information on queues of pending invocations to the Set's Metadata Adapter, for diagnostic purpose (like getLocalPoolQueue()).
  However, this information is available only when the optional thread pools specific for this Adapter Set are configured.

AdapterSetMBean name pattern:
"com.lightstreamer:type=AdapterSet,AdapterSetName=<AdapterSetName>"

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getAuthenticationPoolQueue()
java.util.List<java.lang.String>	getCurrentSessionList()
java.util.List<java.lang.String>	getCurrentSessionListProtected(java.lang.Integer max)
java.lang.Integer	getCurrentSessions()
java.util.List<java.lang.String>	getDataAdapterList()
java.lang.Boolean	getIsProxyMetadata()
java.lang.Integer	getLocalPoolQueue()
java.lang.Integer	getMessagesPoolQueue()
java.lang.Integer	getMPNPoolQueue()
java.lang.Integer	getRequestsQueue()

Method Detail

getCurrentSessions

java.lang.Integer getCurrentSessions()

Returns:

The number of current client Sessions bound to this Adapter Set. The count includes "prestarted" sessions.

getCurrentSessionListProtected

java.util.List<java.lang.String> getCurrentSessionListProtected(java.lang.Integer max)

Parameters:

max - The maximum number of elements to be returned, or null if no limit is requested.

Returns:

The list of current client Sessions bound to this Adapter Set. Expressed as an ArrayList of Strings, where each String contains the sessionID of the Session. The list includes "prestarted" sessions.
Note that also the Push Notification service may consume updates produced by this Adapter Set, although an MPN Device is not bound to a single Adapter Set; the list of MPN Devices involved with this Adapter Set is not reported.
A maximum number of elements to be returned can be set, to protect the client or to get a sample. When the limit is set, the criteria for the determination of the returned elements are left unspecified.

getCurrentSessionList

java.util.List<java.lang.String> getCurrentSessionList()

Returns:

The list of current client Sessions bound to this Adapter Set. Expressed as an ArrayList of Strings, where each String contains the sessionID of the Session. The list includes "prestarted" sessions.
Note that also the Push Notification service may consume updates produced by this Adapter Set, although an MPN Device is not bound to a single Adapter Set; the list of MPN Devices involved with this Adapter Set is not reported.
The property is subject to the <disable_long_list_properties> configuration flag. If leveraged, the returned list will just contain a reminder text.

See Also:

getCurrentSessionListProtected(java.lang.Integer)

getDataAdapterList

java.util.List<java.lang.String> getDataAdapterList()

Returns:

The list of Data Adapters configured for this Adapter Set. Expressed as an ArrayList of Strings, where each String contains the configured name of the Data Adapter.

getLocalPoolQueue

java.lang.Integer getLocalPoolQueue()

Returns:

The length of the queue of the tasks waiting to be processed by the optional "SET" pool specifically assigned to this Adapter Set. If configured, this pool manages all requests by sessions bound to this Adapter Set, but for operations pertaining to more specific authentication, messages or Data Adapter related pool, if, in turn, configured (but note that, pools for authentication and messages are always defined). If a specific pool is not configured, these requests are managed by the SERVER pool; in this case, -1 is returned.

getAuthenticationPoolQueue

java.lang.Integer getAuthenticationPoolQueue()

Returns:

The length of the queue of the tasks waiting to be processed by the "AUTHENTICATION" pool specifically assigned for authentication operations on this Adapter Set. Note that this pool is always defined and it is used to invoke callbacks that are expected to behave asynchronously. For this reason, the reported queue count includes the requests currently in execution asynchronously on the Metadata Adapter.

See Also:

ThreadPoolMBean.getQueue(), ThreadPoolMBean.getPendingAsyncTasks(), getIsProxyMetadata()

getMessagesPoolQueue

java.lang.Integer getMessagesPoolQueue()

Returns:

The length of the queue of the tasks waiting to be processed by the pool specifically assigned for message management on this Adapter Set. Note that this pool is always defined and it is used to invoke callbacks that are expected to behave asynchronously. For this reason, the reported queue count includes the requests currently in execution asynchronously on the Metadata Adapter.

See Also:

ThreadPoolMBean.getQueue(), ThreadPoolMBean.getPendingAsyncTasks(), getIsProxyMetadata()

getMPNPoolQueue

java.lang.Integer getMPNPoolQueue()

Returns:

The length of the queue of the tasks waiting to be processed by the optional "MPN REQUESTS" pool specifically assigned for the handling of the client requests related with the Push Notification service that are bound to this Adapter Set, if such pool is configured. If a specific pool is not configured, these operations are managed by either the Adapter Set specific pool or the SERVER pool; in this case, -1 is returned.

getRequestsQueue

java.lang.Integer getRequestsQueue()

Returns:

The length of the queue of the tasks related with requests for this Adapter Set waiting to be processed by one of the optional Adapter-specific thread pools. This includes the SET pool, the AUTHENTICATION pool, the MSG pool, the MPN REQUESTS pool and any Data Adapter specific pool, if configured. If none of the specific pools is configured, -1 is returned.
Note that the AUTHENTICATION and MSG pools are always defined and are used to invoke callbacks that are expected to behave asynchronously. For this reason, the queue count reported for these pools includes the requests currently in asynchronous execution on the Metadata Adapter.

getIsProxyMetadata

java.lang.Boolean getIsProxyMetadata()

Returns:

true if the Metadata Adapter of this Adapter Set is configured to be a Proxy Metadata Adapter (the ready-made Metadata Adapter supplied by Lightstreamer to interface with a Remote Metadata Adapter through the ARI protocol).