SDK for JMX Extensions CHANGELOG
5.6.0
Compatible with Lightstreamer Server since 7.2.0.
May not be compatible with custom managers for the previous version; see compatibility notes below.
Released on 15 Jul 2021

Extended various MBeans to better take into account the specific characteristics of the AUTHENTICATION and MSG thread pools related to any configured Proxy Metadata Adapter, which send their tasks asynchronously.

  • Added the IsAsync property in the ThreadPoolMBean to identify these pools.
  • Added the PendingAsyncTasks and MaxAsyncTasks properties in the ThreadPoolMBean to report information specific for these pools.
  • Revised and clarified in the documentation the way in which the existing statistics take these pools into account. This also involved slight modifications for a few statistics, namely IsCpuBound, Queue and CurrQueueWaitMillis in the ThreadPoolMBean. COMPATIBILITY NOTE: Existing managers relying of the above properties should be revised.
  • Added the IsProxyMetadata property in the AdapterSetMBean and the IsProxy property in the DataAdapterMBean for completeness of information.

Added twin operations for all properties that can return extremely long lists, by adding the "Protected" suffix to the names. These operations allow for the indication of a limit on the number of elements returned. This involves various MBeans. These new operations are also the only way to request the lists when the new <disable_long_list_properties> Server configuration setting is leveraged.

Extended the PushNotificationsMBean by adding operations to deactivate and replace the current MPN Module (respectively, deactivateCurrentModule and replaceCurrentModule). Also added the IsModuleActive property.

Extended the PushNotificationsMBean by adding the getMPNDeviceFromSubscription operation, which can be useful for diagnostics.

Improved the ServerSocketMBean, by adding the lookup from the configured name.

Removed the possibility to search the DataAdapterMBean of Data Adapters with name "DEFAULT" by the "name" attribute carrying the Adapter Set name. It was left only for backward compatibility with extremely old managers. COMPATIBILITY NOTE: Existing managers using this feature now have to use the AdapterSetName + DataAdapterName attributes.

Fixed a bug which could have caused some MBeans to be omitted for lack of a valid name. This would have been caused by particular names assigned, for instance, to Adapter Sets or Data Adapters. Now the MBeans would be created, but with a modified name, as it would be warned in the Server startup log.

Clarified in the documentation of the PushNotificationsMBean that only devices with active subscriptions are reported.

5.5.6 build 1983
Compatible with Lightstreamer Server since 7.1.1.
Compatible with custom managers for the previous version.
Released on 21 Sep 2020

Fixed the documentation of the EditionDetailsMBean. The name to be specified to find the MBean is "Edition", not "EditionDetails".

5.5.5 build 1971
Compatible with Lightstreamer Server since 7.1.1.
Compatible with custom managers for the previous version.
Released on 27 May 2020

Added statistics to distinguish when a session is currently operated on WebSocket or HTTP. In the SessionMBean, added the IsOnWS and IsOnHTTP properties. In the ResourceMBean, added the "CurrentWSSessions", "MaxWSSessions", "CurrentHTTPSessions", and "maxHTTPSessions" properties.

Added the getCurrClientVersions operation to the ResourceMBean, to provide statistics on the various types of clients currently connected; see the ResourceMBean docs for details.

Improved the general description of the MBeans in the docs and the MBeanInfo.

5.5.4 build 1947
Compatible with Lightstreamer Server since 7.1.
May not be compatible with custom managers for the previous version; see compatibility notes below.
Released on 24 Jan 2020

Introduced the ServerSocketMBean, with one instance for each server socket configured through the <http_server> and <https_server> blocks. It reports server socket attributes and various activity statistics, similar to those reported by the ResourceMBean, restricted to the related server socket.

Added the CumulRealTimeEvents property to the SessionMBean, with usage similar to CumulLostEvents and CumulFilteredEvents.

Added operations getNewSessionCloseCauses and getCumulSessionCloseCauses to the ResourceMBean, to report statistics on the reasons why the various sessions are closed.
Likewise, added operations getNewConnecionCloseCauses and getCumulConnecionCloseCauses to the ResourceMBean, to report statistics on the reasons why the various connections are closed.

Revised the "MaxThreads" property of the ThreadPoolMBean, to report 0 when the pool is unlimited, rather than a large value. COMPATIBILITY NOTE: Custom managers evaluating the "MaxThreads" property should take this convention into account.

Improved the various counts of filtered events to include some corner cases.

Added properties "CumulAcceptPauseMillis" and "NewAcceptPauseMillis" in the ServerMBean, to report pauses enforced in the accept loops, that can be related with some "max_queue" settings.

Added the "drainSessions" operation in the ServerMBean, useful to force migration of sessions to other instances in a cluster with a controlled rate.
Added a boolean argument to the "block" operation in the ServerMBean to support migration of sessions to other instances in a cluster. COMPATIBILITY NOTE: Existing custom managers that invoke the "block" operation should be updated to pass false or null.

Added property CurrentPrestartedAverageWaitMillis, to supplement CurrentPrestartedSessions, in the ResourceMBean.

5.4.4 build 1885.6
Compatible with Lightstreamer Server since 7.0.
Compatible with custom managers for the previous version.
Released on 7 Jan 2019

Extended the EditionDetailsMBean to support the newly introduced .NET Standard SDK.

5.4.3 build 1870
Compatible with Lightstreamer Server since 7.0.
Compatible with custom managers for the previous version.
Released on 14 Jun 2018

Added missing documentation notes in the provided inline "MBeanInfo" descriptions, to align with the static docs.
Improved the "see" references in the "MBeanInfo" descriptions (but they still lean on the javadoc-style naming convention adopted for the static docs).

5.4.2 build 1859
Compatible with Lightstreamer Server since 7.0.
Compatible with custom managers for the previous version.
Released on 28 Feb 2018

Fixed the MaxVersionsAllowed property of the EditionDetailsMBean in case of DEMO license.

Added information about the new watchOS SDK to the EditionDetailsMBean.

Aligned the documentation to comply with current licensing policies.

5.4.1 build 1851
Compatible with Lightstreamer Server since 7.0 b2.
May not be compatible with custom managers for the previous version; see compatibility notes below.
Released on 20 Dec 2017

Added a DataAdapterMBean for the new internal Data Adapter introduced for the MPN Module (when enabled). Note that, even though the Data Adapter is automatically added to all Adapter Sets, it is a single one and its MBean requires a special query for the access; see the DataAdapterMBean docs for details. On the other hand, it is not reported in any AdapterSetMBean.

Added the SampledStatisticsEnabled read-only property to the SessionMBean's, to reflect the new "sampled_statistics_only" Server configuration keyword available. If configured, some properties of the SessionMBean's can now issue null values (see the docs for details).

Extended the ThreadPoolMBean's to report statistics on CPU usage and blocked state for the threads. Since these statistics need enablement at JVM level, suitable enabling methods have also been added both in the ThreadPoolMBean's and, at global level, in the LoadMBean. See the docs for details.

Changed the names used in the PushNotificationsMBean to identify the MPN platforms, according to the changes in the SDK for In-Process Adapters. COMPATIBILITY NOTE: Custom managers invoking the getCurrentMPNDevice or getMPNDevicePlatformType operation should be aligned.

Added a new MBean, EditionDetailsMBean, to recap license characteristics.
The getLSEdition and getLSLicenseType methods in the ServerMBean will also reflect the new concepts.
Added getEditionConfigFile and getEditionConfigAsProperties in the ServerMBean to reflect the new configuration deployment, as lightstreamer_version_conf.xml has been replaced by lightstreamer_edition_conf.xml. The previous getVersionConfigFile and getVersionConfigAsProperties methods now refer to the new file, but have been deprecated.

5.3.2 build 1814
Compatible with Lightstreamer Server since 6.1.
Compatible with custom managers for the previous version.
Released on 23 Jan 2017

Fixed a bug which caused the extension on the ResourceMBean introduced in build 1803 (that is, the handling of multiple subrequests) to become ineffective.
Clarified the documentation of the ResourceMBean with respect to the abovementioned extension.

5.3.1 build 1803
Compatible with Lightstreamer Server since 6.0.3.
Compatible with custom managers for the previous version.
Released on 5 Sep 2016

Introduced the computation of the ThreadPoolMBean's AvgExecTimeMillis property also for the TLS-SSL HANDSHAKE pool. Previously, the property was not computed (as for all cpu-bound pool) and its value was always null.

Modified the statistics on Control Requests (hence, on all Requests as well) in the ResourceMBean, so that, when a single Request from the Client comprises multiple subrequests, the count will report all subrequests rather that the aggregated one.

5.3 build 1794
Compatible with Lightstreamer Server since 6.0.1.
Compatible with custom managers for the previous version.
Released on 10 May 2016

Revised the javadocs overview.
Revised javadoc formatting style.

5.3 build 1775
Compatible with Lightstreamer Server since 6.0.1.
May not be compatible with custom managers for the previous version; see compatibility notes below.
Released on 16 Jul 2015

Modified the SessionMBean, by removing the recently added ClientBuild property and extending the ClientVersion property to report the full version signature. COMPATIBILITY NOTE: Custom managers relying on the ClientBuild attribute, or on ClientVersion to report only a version number, should be revised.

5.2.1 build 1741
Compatible with Lightstreamer Server since 6.0.
Compatible with custom managers for the previous version.
Released on 13 Feb 2015

Extended the SessionMBean with more information on the Client SDK type, if available (see getClientBuild).

5.2 build 1735
Compatible with Lightstreamer Server since 6.0.
May not be compatible with custom managers for the previous version; see compatibility notes below.
Released on 21 Jan 2015

Introduced the support for the new Push Notification Service. This includes the new PushNotificationsMBean and extensions in the DataAdapterMBean, AdapterSetMBean, ServerMBean, and LoadMBean, to report the served devices and the new thread pools.

Introduced the ThreadPoolMBean's, one for each of the thread pools used internally by Lightstreamer Server. See the ThreadPoolMBean class documentation for details.
Extended the LoadMBean to provide a list of the names of all active thread pools (see getThreadPools). Note that the pool naming has changed in Server version 6.0.

Introduced a fake MBean of type "Session" and no SessionId associated, which is added when the creation of the SessionMBean's is disabled; it acts as a reminder that the feature can be enabled. COMPATIBILITY NOTE: Custom managers should recognize and ignore the new MBean; it does not expose the properties of a normal SessionMBean. Added a "destroySession" operation in the ResourceMBean; this overcomes the unavailability of this functionality when SessionMBeans are disabled.

Introduced the "clearSnapshot" operations on the DataAdapterMBean's, for clearing the state of an item bypassing the Data Adapter (or, in DISTINCT mode, for notifying compatible clients that the update history should be discarded). See the documentation for details and usage clarifications.

Extended the ResourceMBean and the DataAdapterMBean's with new statistics on the overall number of item subscriptions performed by the clients (see get*ItemSubscriptions).

Extended the SessionMBean with information on the Client SDK type, if available (see getClientType and getClientVersion).

Extended the life of the SessionMBean until the termination of the notifySessionClose invocation; hence, from within this callback, the Metadata Adapter can access the MBean and get the final value of cumulative statistics.
Added, for completeness, the IsClosed property (which is true in that case).

Fixed the getSessionListForItem method in the DataAdapterMBean's to return an empty list instead of null upon items not subscribed to.

Clarified the docs about the inclusion of "prestarted" sessions.

Fixed wrong links in the docs.

4.4 build 1622
Compatible with Lightstreamer Server since 5.1.
Compatible with custom managers for the previous version.
Released on 20 Dec 2012

Extended the StreamMBean and the SessionMBean, with new properties carrying statistics on the elaboration of Client Messages, sent through the SendMessage requests. See the documentation for details.

4.3 build 1576
Compatible with Lightstreamer Server since 5.0.
May not be compatible with custom managers for the previous version; see compatibility notes below.
Released on 3 Aug 2012

Revised the reporting of bandwidth limits in the Session and StreamMBean's.
Fixed an inconsistency in the SessionMBean; the AllocatedMaxBandwidthKbps property getter now returns the server-side bandwidth limit for the Session, according with the setter behavior; before, it used to return the limit currently enforced on the session, which is now returned by the new read-only property AllocatedBandwidthKbps. COMPATIBILITY NOTE: Custom managers that use the AllocatedMaxBandwidthKbps getter may need to be changed. Clarified when the special 0 value is possible in bandwidth limit values.
Introduced a 3-decimal approximation for the reported bandwidth limit values. COMPATIBILITY NOTE: Custom managers that rely on the reported bandwidth limits for internal computations may need to be revised.

Changed the count of the overall number of connected sockets in the ResourceMBean to include sockets currently involved in the initial TLS/SSL handshake.
Extended the ResourceMBean by introducing the count of sockets currently performing a TLS/SSL initial handshake and the count of failed handshakes.

Extended the ResourceMBean with new properties to report the connections used for WebSocket interaction. The current and maximum number of such connections and the cumulative number of upgrades from HTTP/HTTPS are reported. See the documentation for details.

Extended the LoadMBean to report the current queue on the newly introduced thread pools; see "getQueueStageHandshake".
Removed from the LoadMBean the previously deprecated "getQueueStageIOPush" and "getQueueStageHTTPSAccept" methods. COMPATIBILITY NOTE: Custom managers that still request these properties may may need to be revised.

Revised the various session count statistics in the ResourceMBean: prestarted sessions are no longer included; see CLIENTS.SESSIONS in paragraph 4.2.1 of the General Concepts document for details.
Extended the ResourceMBean to provide the count of current prestarted sessions.
Extended the SessionMBean to indicate when a session is in prestarted state.

Removed the deprecated getSubscribedItemList and getSubscribedItems methods from the SessionMBean. COMPATIBILITY NOTE: Any custom managers still using those methods may have to be changed.

Added the getVersionConfigFile and getVersionConfigAsProperties methods in the ServerMBean to make it available the contents of the newly introduced version configuration file.

Changed the names returned by getLSLicenseType in the ServerMBean, according to the new licensing policy.

Fixed the comment on the "CumulControlRequest" property of the SessionMBean on the html adaptor.

Refined the periodic statistics carried by the getAveragePoolQueueWait property of the LoadMBean.

Fixed the included Version.txt file, which was not reporting the latest build number.

Regenerated the API documentation with the newest JDK default template.
Specified the version number in the javadocs.

4.0 build 1513.1.3
Compatible with Lightstreamer Server since 4.0.
Compatible with custom managers for the previous version.
Released on 20 Jul 2011
4.0 build 1513.1.1
Compatible with Lightstreamer Server since 4.0.
Compatible with custom managers for the previous version.
Released on 8 Jul 2011
4.0 build 1513
Compatible with Lightstreamer Server since 4.0.
Released on 7 Jun 2011

Introduction of Lightstreamer "Duomo" release (Server 4.0).