HOW TO UPGRADE LIGHTSTREAMER ============================ First of all, please see CHANGELOG.HTML to know all the differences from the previous versions of the Lightstreamer Server components. ------------------------------------ Upgrading from 7.2.2 to This Version ------------------------------------ If you have an existing installation of Lightstreamer 7.2.2, then this new release brings various improvements and a few bug fixes in the Server and related SDKs (ARI, JMX, TLCP) and the MPN Module. Moreover, these improvements involve new deployed third-party libraries and changes in many others. So, we suggest you to do a fresh install of Lightstreamer 7.3.0, then: - CONFIGURATION: The configuration files under the "conf" folder (e.g. lightstreamer_conf.xml, lightstreamer_log_conf.xml) can be copied in the new installation unchanged. If you are leveraging the MPN Module, the MPN related configuration files under the "conf/mpn" folder can also be copied in the new installation unchanged. If you modified the launch scripts under "bin" (e.g. LS.sh, LS.bat), you can copy them in the new installation unchanged; just ensure that your modifications are not affected by changes on third-party libraries. Also consider that if you run the Server with a license of "file" type, a license upgrade may be needed. - ADAPTERS: The Server upgrade to 7.3.0 implies the upgrade of the SDK for Java In-Process Adapters from version 7.2.0 or above to 7.4.0, which brings significant interface changes. However, the Server includes a specific support for Adapter binaries based on SDK versions since 7.0.0, with only a few corner cases not covered. So, you can deploy your existing in-process Adapter binaries unchanged, but first check the SDK changelog to ensure that no corner case applies. The Server upgrade to 7.3.0 also involves changes in the embedded Adapter Remoting Infrastructure, which has moved from ARI Protocol version 1.8.3 to 1.9.0. However, backward compatibility since protocol version 1.8.0 is provided. So, you can deploy your existing Remote Adapter binaries unchanged. Note that some Remote Adapter SDKs have changed recently. On the download page you can find the current versions of the SDKs. In order to upgrade the adapters, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. - CLIENTS: The Server upgrade to 7.3.0 implies the upgrade of client protocol from TLCP version 2.3.0 to 2.4.0. Anyway, the Server is always compatible with all client libraries available at the time of release and with all previous client libraries, so your existing clients should work with no issues. Some of the client SDKs may have changed recently. On the download page you can find the current versions of the SDKs. In order to upgrade the clients, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. The Server upgrade to 7.3.0 also implies the upgrade of the SDK for JMX Extensions from version 5.6.0 to 5.7.0, with only a few changes and extensions, but see the CHANGELOG of the JMX SDK, that you can find on the download page, to learn about any possible compatibility issues. - MPN MODULE DATABASE (where available): If leveraging the MPN module, you can deploy your existing database unchanged on the new installation. ------------------------------------ Upgrading from 7.2.0 to This Version ------------------------------------ If you have an existing installation of Lightstreamer 7.2.0, then this new release brings various improvements and a few bug fixes in the Server and related SDKs (ARI, JMX, TLCP) and the MPN Module. Moreover, these improvements involve new deployed third-party libraries and changes in many others. So, we suggest you to do a fresh install of Lightstreamer 7.3.0, then: - CONFIGURATION: The configuration files under the "conf" folder (e.g. lightstreamer_conf.xml, lightstreamer_log_conf.xml) can be copied in the new installation unchanged. However, for lightstreamer_log_conf.xml, to take advantage of new configuration opportunities, we suggest converting it through the online Configuration File Upgrade Tool, available at: https://service.lightstreamer.com/ConfigUpgrade As for the configuration files under the "conf/mpn" folder, you can copy them unchanged in the new installation, but for hibernate.cfg.xml. For this file, you should stick to the new factory version, and if you customized it, then you should take note of the changes you performed and apply them to the new factory file; but first see the Server CHANGELOG for details. On the other hand, if you changed the launch scripts under "bin" (e.g. LS.sh, LS.bat), check on the Server CHANGELOG if you can copy them unchanged or should rather take note of any changes you performed and apply them to the new factory files. Also consider that if you run the Server with a license of "file" type, a license upgrade may be needed. - ADAPTERS: The Server upgrade to 7.3.0 implies the upgrade of the SDK for Java In-Process Adapters from version 7.2.0 or above to 7.4.0, which brings significant interface changes. However, the Server includes a specific support for Adapter binaries based on SDK versions since 7.0.0, with only a few corner cases not covered. So, you can deploy your existing in-process Adapter binaries unchanged, but first check the SDK changelog to ensure that no corner case applies. The Server upgrade to 7.3.0 also involves changes in the embedded Adapter Remoting Infrastructure, which has moved from ARI Protocol version 1.8.3 to 1.9.0. However, backward compatibility since protocol version 1.8.0 is provided. So, you can deploy your existing Remote Adapter binaries unchanged. Note that all the Remote Adapter SDKs have changed recently. On the download page you can find the current versions of the SDKs. In order to upgrade the adapters, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. - CLIENTS: The Server upgrade to 7.3.0 implies the upgrade of client protocol from TLCP version 2.3.0 to 2.4.0. Anyway, the Server is always compatible with all client libraries available at the time of release and with all previous client libraries, so your existing clients should work with no issues. Some of the client SDKs may have changed recently. On the download page you can find the current versions of the SDKs. In order to upgrade the clients, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. The Server upgrade to 7.3.0 also implies the upgrade of the SDK for JMX Extensions from version 5.6.0 to 5.7.0, with only a few changes and extensions, but see the CHANGELOG of the JMX SDK, that you can find on the download page, to learn about any possible compatibility issues. - MPN MODULE DATABASE (where available): If leveraging the MPN module, you can deploy your existing database unchanged on the new installation. --------------------------------------------- Upgrading from 7.1.2 or 7.1.3 to This Version --------------------------------------------- If you have an existing installation of Lightstreamer 7.1.2 or 7.1.3, then this new release brings various improvements and a few bug fixes in the Server and related SDKs (ARI, JMX, TLCP) and the MPN Module. In particular, the Adapter Remoting Infrastructure is now fully embedded in the Server and it is no longer versioned separately. Hence the Remote Adapter SDKs now must express their compatibility with respect to the Server version directly. However, the Server improvements also involve new deployed third-party libraries and changes in many others. So, we suggest you to do a fresh install of Lightstreamer 7.3.0, then: - CONFIGURATION: The configuration files under the "conf" folder (e.g. lightstreamer_conf.xml, lightstreamer_log_conf.xml) can be copied in the new installation unchanged, but for a few corner cases. To prevent these cases and to take advantage of new configuration opportunities, we suggest you to rather take note of any changes you performed and apply them to the new factory files. For lightstreamer_conf.xml and lightstreamer_log_conf.xml, you can also use the online Configuration File Upgrade Tool, available at: https://service.lightstreamer.com/ConfigUpgrade As for the configuration files under the "conf/mpn" folder, you can copy them unchanged in the new installation, but for hibernate.cfg.xml. For this file, you should stick to the new factory version, and if you customized it, then you should take note of the changes you performed and apply them to the new factory file; but first see the Server CHANGELOG for details. Moreover, if you had to customize the "Device.hbm.xml" file, then you should, similarly, take note of the changes you performed and apply them to the new factory file. On the other hand, if you have changed the launch scripts under "bin" (e.g. LS.sh, LS.bat), take note of any changes you performed and apply them to the new factory files. Also consider that if you run the Server with a license of "file" type, a license upgrade may be needed. - ADAPTERS: The Server upgrade to 7.3.0 implies the upgrade of the SDK for Java In-Process Adapters from version 7.2.0 or above to 7.4.0, which brings significant interface changes. However, the Server includes a specific support for Adapter binaries based on SDK versions since 7.0.0, with only a few corner cases not covered. So, you can deploy your existing in-process Adapter binaries unchanged, but first check the SDK changelog to ensure that no corner case applies. The Server upgrade to 7.3.0 also involves changes in the embedded Adapter Remoting Infrastructure, which has moved from ARI Protocol version 1.8.2 to 1.9.0. However, backward compatibility since protocol version 1.8.0 is provided. So, you can deploy your existing Remote Adapter binaries unchanged. However, if you use Remote Adapters, your adapters.xml files should be revised according with the Server CHANGELOG. To simplify the operation, we suggest you using the online Configuration File Upgrade Tool; it is available at: https://service.lightstreamer.com/ConfigUpgrade Note that all the Remote Adapter SDKs have changed recently. On the download page you can find the current versions of the SDKs. In order to upgrade the adapters, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. - CLIENTS: The Server upgrade to 7.3.0 implies the upgrade of client protocol from TLCP version 2.2.0 to 2.4.0. Anyway, the Server is always compatible with all client libraries available at the time of release and with all previous client libraries, so your existing clients should work with no issues. Some of the client SDKs may have changed recently. On the download page you can find the current versions of the SDKs. In order to upgrade the clients, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. The Server upgrade to 7.3.0 also implies the upgrade of the SDK for JMX Extensions from version 5.5.6 to 5.7.0, with only a few changes and extensions, but see the CHANGELOG of the JMX SDK, that you can find on the download page, to learn about any possible compatibility issues. - MPN MODULE DATABASE (where available): If leveraging the MPN module, you can deploy your existing database unchanged on the new installation. --------------------------------------------------- Upgrading from 7.1.1 build 20200527 to This Version --------------------------------------------------- If you have an existing installation of Lightstreamer 7.1.1 build 20200527, then this new release brings various improvements and a few bug fixes in the Server and related SDKs (ARI, JMX, TLCP) and the MPN Module. In particular, the Adapter Remoting Infrastructure is now fully embedded in the Server and it is no longer versioned separately. Hence the Remote Adapter SDKs now must express their compatibility with respect to the Server version directly. More significantly, the new release no longer includes the resources of the various SDKs in the distribution package. Now Client and Adapter SDKs evolve independently and their resources, including the CHANGELOG, can only be reached directly from the download page. Moreover, the Server improvements also involve new deployed third-party libraries and changes in many others. So, we suggest you to do a fresh install of Lightstreamer 7.3.0, then: - CONFIGURATION: The configuration files under the "conf" folder (e.g. lightstreamer_conf.xml, lightstreamer_log_conf.xml) can be copied in the new installation unchanged, but for a few corner cases. To prevent these cases and to take advantage of new configuration opportunities, we suggest you to rather take note of any changes you performed and apply them to the new factory files. For lightstreamer_conf.xml and lightstreamer_log_conf.xml, you can also use the online Configuration File Upgrade Tool, available at: https://service.lightstreamer.com/ConfigUpgrade As for the configuration files under the "conf/mpn" folder, you can copy them unchanged in the new installation, but for hibernate.cfg.xml. For this file, you should stick to the new factory version, and if you customized it, then you should take note of the changes you performed and apply them to the new factory file; but first see the Server CHANGELOG for details. Moreover, if you had to customize the "Device.hbm.xml" file, then you should, similarly, take note of the changes you performed and apply them to the new factory file. On the other hand, if you have changed the launch scripts under "bin" (e.g. LS.sh, LS.bat), take note of any changes you performed and apply them to the new factory files. Also consider that if you run the Server with a license of "file" type, a license upgrade may be needed. - ADAPTERS: The Server upgrade to 7.3.0 implies the upgrade of the SDK for Java In-Process Adapters from version 7.2.0 or above to 7.4.0, which brings significant interface changes. However, the Server includes a specific support for Adapter binaries based on SDK versions since 7.0.0, with only a few corner cases not covered. So, you can deploy your existing in-process Adapter binaries unchanged, but first check the SDK changelog to ensure that no corner case applies. The Server upgrade to 7.3.0 also involves changes in the embedded Adapter Remoting Infrastructure, which has moved from ARI Protocol version 1.8.2 to 1.9.0. However, backward compatibility since protocol version 1.8.0 is provided. So, you can deploy your existing Remote Adapter binaries unchanged. However, if you use Remote Adapters, your adapters.xml files should be revised according with the Server CHANGELOG. To simplify the operation, we suggest you using the online Configuration File Upgrade Tool; it is available at: https://service.lightstreamer.com/ConfigUpgrade Note that all the Remote Adapter SDKs have changed recently. On the download page you can find the current versions of the SDKs. In order to upgrade the adapters, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. - CLIENTS: The Server upgrade to 7.3.0 implies the upgrade of client protocol from TLCP version 2.2.0 to 2.4.0. Anyway, the Server is always compatible with all client libraries available at the time of release and with all previous client libraries, so your existing clients should work with no issues. Some of the client SDKs may have changed recently. On the download page you can find the current versions of the SDKs. In order to upgrade the clients, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. The Server upgrade to 7.3.0 also implies the upgrade of the SDK for JMX Extensions from version 5.5.6 to 5.7.0, with only a few changes and extensions, but see the CHANGELOG of the JMX SDK, that you can find on the download page, to learn about any possible compatibility issues. - MPN MODULE DATABASE (where available): If leveraging the MPN module, you can deploy your existing database unchanged on the new installation. --------------------------------------------------- Upgrading from 7.1.0 build 20200124 to This Version --------------------------------------------------- If you have an existing installation of Lightstreamer 7.1.0 build 20200124, then this new release brings various improvements and a few bug fixes in the Server and related SDKs (ARI, JMX, TLCP) and the MPN Module. In particular, the Adapter Remoting Infrastructure is now fully embedded in the Server and it is no longer versioned separately. Hence the Remote Adapter SDKs now must express their compatibility with respect to the Server version directly. More significantly, the new release no longer includes the resources of the various SDKs in the distribution package. Now Client and Adapter SDKs evolve independently and their resources, including the CHANGELOG, can only be reached directly from the download page. Moreover, the Server improvements also involve new deployed third-party libraries and changes in many others. So, we suggest you to do a fresh install of Lightstreamer 7.3.0, then: - CONFIGURATION: The configuration files under the "conf" folder (e.g. lightstreamer_conf.xml, lightstreamer_log_conf.xml) can be copied in the new installation unchanged, but for a few corner cases. To prevent these cases and to take advantage of new configuration opportunities, we suggest you to rather take note of any changes you performed and apply them to the new factory files. For lightstreamer_conf.xml and lightstreamer_log_conf.xml, you can also use the online Configuration File Upgrade Tool, available at: https://service.lightstreamer.com/ConfigUpgrade As for the configuration files under the "conf/mpn" folder, you can copy them unchanged in the new installation, but for hibernate.cfg.xml. For this file, you should stick to the new factory version, and if you customized it, then you should take note of the changes you performed and apply them to the new factory file; but first see the Server CHANGELOG for details. Moreover, if you had to customize the "Device.hbm.xml" file, then you should, similarly, take note of the changes you performed and apply them to the new factory file. On the other hand, if you have changed the launch scripts under "bin" (e.g. LS.sh, LS.bat), take note of any changes you performed and apply them to the new factory files. Also consider that if you run the Server with a license of "file" type, a license upgrade may be needed. - ADAPTERS: The Server upgrade to 7.3.0 implies the upgrade of the SDK for Java In-Process Adapters from version 7.2.0 or above to 7.4.0, which brings significant interface changes. However, the Server includes a specific support for Adapter binaries based on SDK versions since 7.0.0, with only a few corner cases not covered. So, you can deploy your existing in-process Adapter binaries unchanged, but first check the SDK changelog to ensure that no corner case applies. The Server upgrade to 7.3.0 also involves changes in the embedded Adapter Remoting Infrastructure, which has moved from ARI Protocol version 1.8.2 to 1.9.0. However, backward compatibility since protocol version 1.8.0 is provided. So, you can deploy your existing Remote Adapter binaries unchanged. However, if you use Remote Adapters, your adapters.xml files should be revised according with the Server CHANGELOG. To simplify the operation, we suggest you using the online Configuration File Upgrade Tool; it is available at: https://service.lightstreamer.com/ConfigUpgrade Note that all the Remote Adapter SDKs have changed recently. On the download page you can find the current versions of the SDKs. In order to upgrade the adapters, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. - CLIENTS: The Server upgrade to 7.3.0 implies the upgrade of client protocol from TLCP version 2.1.0 to 2.4.0. Anyway, the Server is always compatible with all client libraries available at the time of release and with all previous client libraries, so your existing clients should work with no issues. Some of the client SDKs may have changed recently. On the download page you can find the current versions of the SDKs. In order to upgrade the clients, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. The Server upgrade to 7.3.0 also implies the upgrade of the SDK for JMX Extensions from version 5.5.4 to 5.7.0, with only a few changes and extensions, but see the CHANGELOG of the JMX SDK, that you can find on the download page, to learn about any possible compatibility issues. - MPN MODULE DATABASE (where available): If leveraging the MPN module, you can deploy your existing database unchanged on the new installation. --------------------------------------------------- Upgrading from 7.0.3 build 20190107 to This Version Upgrading from 7.0.2 build 20181003 to This Version Upgrading from 7.0.1 build 20180614 to This Version Upgrading from 7.0.0 build 20180228 to This Version --------------------------------------------------- If you have an existing installation of Lightstreamer 7.0.0 build 20180228 through 7.0.3 build 20190107, then this new release brings various improvements and bug fixes in the Server and related SDKs (ARI, JMX, TLCP). In particular, the Adapter Remoting Infrastructure is now fully embedded in the Server and it is no longer versioned separately. Hence the Remote Adapter SDKs now must express their compatibility with respect to the Server version directly. More significantly, the new release no longer includes the resources of the various SDKs in the distribution package. Now Client and Adapter SDKs evolve independently and their resources, including the CHANGELOG, can only be reached directly from the download page. The release also brings an upgrade of the Server's MPN Module implementation. Moreover, the Server improvements also involve new deployed third-party libraries and changes in many others. So, we suggest you to do a fresh install of Lightstreamer 7.3.0, then: - CONFIGURATION: The configuration files under the "conf" folder (e.g. lightstreamer_conf.xml, lightstreamer_log_conf.xml) can be copied in the new installation unchanged, but for a few corner cases. To prevent these cases and to take advantage of new configuration opportunities, we suggest you to rather take note of any changes you performed and apply them to the new factory files. For lightstreamer_conf.xml and lightstreamer_log_conf.xml, a better option is to use the online Configuration File Upgrade Tool, available at: https://service.lightstreamer.com/ConfigUpgrade If you are leveraging the MPN Module, the MPN related configuration files under the "conf/mpn" folder should be ported manually according with the Server CHANGELOG. If you are leveraging the possibility to define custom extensions to the logging subsystem, the deployment of such extensions may need to be modified according with the Server CHANGELOG. On the other hand, if you have changed the launch scripts under "bin" (e.g. LS.sh, LS.bat), take note of any changes you performed and apply them to the new factory files. Also consider that if you run the Server with a license of "file" type, a license upgrade may be needed. - ADAPTERS: The Server upgrade to 7.3.0 implies the upgrade of the SDK for Java In-Process Adapters from version 7.0.0 or above to 7.4.0, which brings significant interface changes. However, the Server includes a specific support for Adapter binaries based on SDK versions since 7.0.0, with only a few corner cases not covered. So, you should be able to deploy your existing in-process Adapter binaries unchanged, but first check for possible corner cases in the CHANGELOG of the Java In-Process Adapter SDK. The Server upgrade to 7.3.0 also involves changes in the embedded Adapter Remoting Infrastructure, which has moved from ARI Protocol version 1.8.0 to 1.9.0. However, backward compatibility since protocol version 1.8.0 is provided, with only a few corner cases not covered. So, you should be able to deploy your existing Remote Adapter binaries unchanged, but first check for possible corner cases in the Server CHANGELOG, with regard to the Adapter Remoting Infrastructure. However, if you use Remote Adapters, your adapters.xml files should also be revised according with the Server CHANGELOG. To simplify the operation, we suggest you using the online Configuration File Upgrade Tool; it is available at: https://service.lightstreamer.com/ConfigUpgrade Note that the Remote Adapter SDKs have changed significantly. On the download page you can find the currently available SDKs and their versions. In order to upgrade the In-Process and Remote Adapters to newer SDK versions, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. - CLIENTS: The Server upgrade to 7.3.0 implies the upgrade of client protocol from TLCP version 2.0.0 to 2.4.0. Anyway, the Server is always compatible with all client libraries available at the time of release and with all previous client libraries, so your existing clients should work with no issues. The only exception regards Android clients leveraging the MPN support; see paragraph "Special Considerations on the GCM to FCM Transition" in the General Concepts document for clarifications. Note that the Client SDKs have changed significantly. On the download page you can find the currently available SDKs and their versions. In order to upgrade the Clients to newer SDK versions, read carefully through the CHANGELOG of the involved SDKs to learn about any possible compatibility issues. In particular, if you run the Server with a license of "file" type, a license upgrade may be needed. The Server upgrade to 7.3.0 also implies the upgrade of the SDK for JMX Extensions from version 5.4.x to 5.7.0, with various changes and extensions; see the CHANGELOG of the JMX SDK, that you can find on the download page, to learn about any possible compatibility issues. - MPN MODULE DATABASE (where available): If leveraging the MPN module, and the GCM service in particular, then the database contents should be migrated when ported to the new Server. To achieve that, please contact Lightstreamer support for instructions. ----------------------------------------------------------------- Upgrading from all Previous Versions (before 7.0) to This Version ----------------------------------------------------------------- Port your installation to version 7.0.0 first, by downloading the 7.0.0 package and following the provided upgrade instructions. Then you can proceed by referring to the instructions for 7.0.0 above.