com.lightstreamer.jmx

Interface ServerMBean

public interface ServerMBean

One ServerMBean instance exists in the system. It is created at startup by Lightstreamer Server and lasts until the shutdown of the Server.

ServerMBean name:
"com.lightstreamer:type=Server"

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	block() Stop accepting new Requests for opening new Sessions, but keep serving currently active Sessions and accept any Requests related to these Sessions.
java.lang.Boolean	disableHostname(java.lang.String hostname) Ban a specified host or domain name.
java.lang.Boolean	disableIP(java.lang.String ip) Ban a specified IP address.
java.lang.Boolean	enableHostname(java.lang.String hostname) Remove the ban associated to the specified host or domain name.
java.lang.Boolean	enableIP(java.lang.String ip) Remove the ban associated to the specified IP address.
java.util.Map	getConfigAsProperties(java.lang.String filter)
java.lang.String	getConfigFile(java.lang.String placeholder)
java.util.List	getDisabledHostnamesList()
java.util.List	getDisabledIPsList()
java.lang.Long	getFreeMemory()
java.lang.String	getJavaVersion()
java.util.Date	getLastRefreshTime()
java.lang.String	getLocalHostIP()
java.lang.String	getLocalHostname()
java.lang.String	getLSClientId()
java.lang.String	getLSEdition()
java.lang.String	getLSLicenseType()
java.lang.String	getLSVersion()
java.lang.Integer	getMaxMPNDevices()
java.lang.Integer	getMaxSessions()
java.lang.Integer	getSamplingPeriodMillis()
java.util.Date	getStartupTime()
java.lang.String	getStatus()
java.lang.Long	getTotalMemory()
java.lang.Long	getUptimeMillis()
java.util.Map	getVersionConfigAsProperties(java.lang.String filter)
java.lang.String	getVersionConfigFile(java.lang.String placeholder)
void	setMaxMPNDevices(java.lang.Integer devices)
void	setMaxSessions(java.lang.Integer sessions)
void	shutdown() Terminate the Server operations and exit JVM.
java.lang.Boolean	start() Start accepting new Connections and Requests of any type.
java.lang.Boolean	stop() Close all Connections, of any type, and stop accepting Connections of any type from any client.

Method Detail

getTotalMemory

java.lang.Long getTotalMemory()

Returns:

The total memory (expressed in Bytes) allocated for the heap.

getFreeMemory

java.lang.Long getFreeMemory()

Returns:

The free memory (expressed in Bytes) in the heap.

getJavaVersion

java.lang.String getJavaVersion()

Returns:

The version of the Java virtual machine.

getUptimeMillis

java.lang.Long getUptimeMillis()

Returns:

The time (expressed in milliseconds) passed since Lightstreamer Server has been started up.

getStartupTime

java.util.Date getStartupTime()

Returns:

The timestamp of Lightstreamer Server startup.

getLSVersion

java.lang.String getLSVersion()

Returns:

The version of Lightstreamer Server.

getLSEdition

java.lang.String getLSEdition()

Returns:

The edition in which Lightstreamer Server is running.

getLSLicenseType

java.lang.String getLSLicenseType()

Returns:

The license type used to run Lightstreamer Server: "LICENSE_SERVER", "LICENSE_FILE" or "DEMO".

getLSClientId

java.lang.String getLSClientId()

Returns:

The client id of the license used to run Lightstreamer Server. For a DEMO license type, "-" is returned.

getLocalHostIP

java.lang.String getLocalHostIP()

Returns:

The local IP address of the host running Lightstreamer Server.

getLocalHostname

java.lang.String getLocalHostname()

Returns:

The local hostname of the host running Lightstreamer Server.

getStatus

java.lang.String getStatus()

Returns:

The status of the server: "Initializing", "Running", "Stopped", "Blocked".

shutdown

void shutdown()

Terminate the Server operations and exit JVM.

stop

java.lang.Boolean stop()

Close all Connections, of any type, and stop accepting Connections of any type from any client. This will cause all the currently active Sessions to terminate, with no cause notification to the clients. Incoming Connection attempts will be accepted and logged, then immediately closed. The process stays alive.
WARNING If you stop the Server from JMX Tree, you will not be able to start it again from JMX Tree itself, but from a JMX client, like JConsole.

Returns:

True if operation succeeded. False if operation failed.

block

java.lang.Boolean block()

Stop accepting new Requests for opening new Sessions, but keep serving currently active Sessions and accept any Requests related to these Sessions.

Returns:

True if operation succeeded. False if operation failed.

start

java.lang.Boolean start()

Start accepting new Connections and Requests of any type. Called to switch from "Stopped" and "Blocked" mode to "Running" mode.

Returns:

True if operation succeeded. False if operation failed.

disableIP

java.lang.Boolean disableIP(java.lang.String ip)

Ban a specified IP address. Close all Connections, of any type, and stop accepting Connections of any type from clients connected from this IP address. This will cause the Sessions related with those clients to terminate, with no cause notification to the clients. Incoming Connection attempts from the banned IP will be accepted and logged, then immediately closed.

Parameters:

ip - an IP address.

Returns:

True if operation succeeded. False if operation failed.

enableIP

java.lang.Boolean enableIP(java.lang.String ip)

Remove the ban associated to the specified IP address.

Parameters:

ip - an IP address.

Returns:

True if operation succeeded. False if operation failed.

getDisabledIPsList

java.util.List getDisabledIPsList()

Returns:

The list of all banned IP addresses. Expressed as an ArrayList of Strings, where each String contains an IP address.

disableHostname

java.lang.Boolean disableHostname(java.lang.String hostname)

Ban a specified host or domain name. Close all Connections, of any type, and stop accepting Connections of any type from clients connected from this host or domain. This will cause the Sessions related with those clients to terminate, with no cause notification to the clients. Incoming Connection attempts from the banned host/domain will be accepted and logged, then immediately closed.

Parameters:

hostname - a host or domain name.

Returns:

True if operation succeeded. False if operation failed.

enableHostname

java.lang.Boolean enableHostname(java.lang.String hostname)

Remove the ban associated to the specified host or domain name.

Parameters:

hostname - a host or domain name.

Returns:

True if operation succeeded. False if operation failed.

getDisabledHostnamesList

java.util.List getDisabledHostnamesList()

Returns:

The list of all banned host or domain names. Expressed as an ArrayList of Strings, where each String contains a host/domain name.

getMaxSessions

java.lang.Integer getMaxSessions()

Returns:

The maximum allowed number of concurrent Sessions (Clients). a 0 value indicates an unlimited number of Sessions. As long as sessions are in "prestarted" state, they don't concur to the overall count; sessions that are in "prestarted" state while the limit is exceeded are kept, but they may get closed upon the first attempt to use them.
This setting corresponds to the <max_sessions> configuration setting.
Note that further restrictions may be posed by license terms.

setMaxSessions

void setMaxSessions(java.lang.Integer sessions)

Parameters:

sessions - The maximum allowed number of concurrent Sessions (Clients). 0 is used to indicate an unlimited number of Sessions. This setting overrides the <max_sessions> configuration setting. Setting a limit which is lower than the current number of active sessions does not affect these sessions in any way.

See Also:

getMaxSessions()

getMaxMPNDevices

java.lang.Integer getMaxMPNDevices()

Returns:

The maximum allowed number of concurrent MPN Devices served by the Push Notification service in this Server instance. A 0 value indicates an unlimited number of MPN Devices. This setting corresponds to the <max_mpn_devices> configuration setting.
It is null if the internal MPN Module is not enabled. Note that further restrictions may be posed by license terms.

See Also:

PushNotificationsMBean.getCurrentMPNDevices()

setMaxMPNDevices

void setMaxMPNDevices(java.lang.Integer devices)

Parameters:

devices - The maximum allowed number of concurrent MPN Devices being served by the Push Notification service in this Server instance. 0 is used to indicate an unlimited number of MPN Devices. This setting overrides the <max_mpn_devices> configuration setting. Setting a limit which is lower than the number of MPN Devices currently served does not affect these Devices in any way. The setting is ignored if the internal MPN Module is not enabled.

See Also:

PushNotificationsMBean.getCurrentMPNDevices()

getSamplingPeriodMillis

java.lang.Integer getSamplingPeriodMillis()

Returns:

The duration of the sampling period (used for statistical attributes for all the MBeans of Lightstreamer).

getLastRefreshTime

java.util.Date getLastRefreshTime()

Returns:

The time of the last refresh of sampled attributes (used for statistical attributes for all the MBeans of Lightstreamer).

getConfigFile

java.lang.String getConfigFile(java.lang.String placeholder)

Parameters:

placeholder - Dummy argument that turns the property into an operation and prevents JMX clients from computing the result in a non-interacting way. It can be left null.

Returns:

The contents of the Server XML configuration file, as read at Server startup.

getVersionConfigFile

java.lang.String getVersionConfigFile(java.lang.String placeholder)

Parameters:

placeholder - Dummy argument that turns the property into an operation and prevents JMX clients from computing the result in a non-interacting way. It can be left null.

Returns:

The contents of the Server XML version configuration file, as read at Server startup.

getConfigAsProperties

java.util.Map getConfigAsProperties(java.lang.String filter)

Parameters:

filter - A text to be used as a filter for property names, or null if no filtering is needed.

Returns:

The contents of the Server XML configuration file, as actually used by the Server for its own configuration needs; in particular, only nonempty elements are reported, as empty elements are ignored by the Server. If a filtering text is supplied, then a proper subset is returned. The return value is a key-value Map alphabetically ordered. Note that the key values follow an internal naming convention, by which:

• subelements are represented as dot-separated compound names;
• attributes are represented within parenthesis;
• multiple instances of the same elements are distinguished through a trailing progressive.

getVersionConfigAsProperties

java.util.Map getVersionConfigAsProperties(java.lang.String filter)

Parameters:

filter - A text to be used as a filter for property names, or null if no filtering is needed.

Returns:

The contents of the Server XML version configuration file, as actually used by the Server for its own configuration needs; in particular, only nonempty elements are reported, as empty elements are ignored by the Server. If a filtering text is supplied, then a proper subset is returned. The return value is a key-value Map alphabetically ordered. Note that the key values follow an internal naming convention, by which:

• subelements are represented as dot-separated compound names;
• attributes are represented within parenthesis;
• multiple instances of the same elements are distinguished through a trailing progressive.