Just a second...

Upgrading from version 6.8 to version 6.9

Consider the following information when upgrading from Diffusion™ version 6.8 to version 6.9.

Before you upgrade

Before upgrading you must backup your current configuration and persisted data files.

The following components are not backwards compatible between 6.8 and 6.9. These should be backed-up to allow for recovery if a roll-back is required.
  • etc/Server.xml - the default Server.xml file provided with 6.9 will not work on 6.8 due to the addition of new elements.

Upgrading your applications

Server-side components

Recompile all Java™ application components that are deployed to the Diffusion server, such as authorization handlers, against the new version diffusion.jar file. This file is located in the lib directory of your new Diffusion server installation.

Some features that your Java application components might use have been removed or deprecated. Pay attention to new deprecation warnings and compilation failures that occur during recompilation and review the API changes information in the following section to see if these changes affect your applications.

Clients

You can choose not to recompile your client applications and continue to use client libraries from a previous release. If you choose to use client libraries from a previous release, ensure that the libraries are compatible with the new server. For more information, see Interoperability.

You can choose to upgrade your client applications to use the new client libraries. To do this, recompile the client applications against the client libraries located in the clients directory of your new Diffusion server installation and repackage your client application with the new library.

Your client applications may use features that have been removed or deprecated. Review the API changes information in the following section to see if these changes affect your applications.

Note that the local install method for the Python client has changed. See the Client basics page for Python for details.

API changes

Further information about removed or deprecated features is available in the release notes provided online at http://docs.diffusiondata.com/docs/6.9.1/ReleaseNotice.html

The following table lists features that have been deprecated. If your application code uses these classes or methods, consider rewriting your application code to not include these features.
Table 1. API features deprecated in version 6.9
API affected Deprecated feature Suggested alternative
C client on_handler_error callback function on the session listener none
The following table lists API classes and methods that have been removed. If your application code uses these classes or methods, consider rewriting your application code to not include these features.
Table 2. API features removed in version 6.9
API affected Removed feature Suggested alternative
Java & Android clients FilteredRequestCallback interface used in the Messaging.sendRequestToFilter method no longer extends the Stream interface. Applications should rely on the completable future returned by sendRequestToFilter to detect errors.
.Net client IFilteredRequestCallback interface used in the IMessaging.SendRequestToFilterAsync method no longer inherits from the Callbacks.IStream interface. Applications should rely on the task returned by SendRequestToFilterAsync to detect errors.
JavaScript client The onError and onClose methods of the sendRequestToFilter FilteredResponseHandler have been removed. Applications should rely on the Result returned by sendRequestToFilter to detect errors.

Upgrading your server installation

To upgrade your Diffusion server installation, complete the following steps:
  1. Use the graphical or headless installer to install the new version of Diffusion.

    For more information, see Installing the Diffusion server.

  2. Contact DiffusionData for an updated license file.
  3. You can copy most of your existing configuration files from the etc directory of your previous installation to the etc directory of your new installation.
    The following configuration items are now removed. You should remove them from your configuration files.
    • Logs.xml: Log4J2 is now the default logging implementation; default-log-directory and console-monitored-log should now be set in Server.xml.
    • The server date formatting API and configuration which were deprecated in Diffusion 6.5.0 have been removed. The date-formats section in Server.xml should be removed if present.
The following table lists configuration elements that have been removed.
Config affected Deprecated element Suggested alternative
Server.xml date-formats none
Logs.xml all elements use Server.xml for default-log-directory and console-monitored-log

Behavior changes at the Diffusion server

The previously bundled Kafka and CDC adapters have been removed from the server installation. Gateway Framework compatible alternatives are now being released separately.