The end of life (EOL) date for this module is on 31 January, 2020.

Migration Guides

2.x to 2.3

The API code interfaces in this release are not backwards compatible, and will not run and compile on lower versions of Java. As such, there is a need to upgrade Java to version 8, and client code must be recompiled.

1.2 to 2.0

The API code interfaces in this release are backwards compatible with the 1.X releases. As such, no code needs to be rewritten to migrate to the newer release.

However the underlying wire protocol has changed, so client code must be recompiled against the newer version to work with the 2.0 Open Access Node.

  • oacluster.sh replaces the node script, which has now been removed. See /cluster/oacluster_script.
  • The names of permission setting filters has been changed to reflect there meaning. See /cluster/security/roles.
  • The status values in the Assigned Gateways self-monitoring view have been changed. See: Assigned gateways.
Old statusNew Status
ConnectingAssigned
ErrorDisconnected
ConnectedConnected
  • akka.cluster.auto-down=on has been replaced with akka.cluster.auto-down-unreachable-after=30seconds. If you wish to emulate the old behaviour, change the setting to 0seconds.
  • The utility class to obfuscate passwords has been moved from com.itrsgroup.actor.GatewayCredentials to com.itrsgroup.oanode.gateway.GatewayCredentialsObfuscator. See Obfuscated Password.

1.1 to 1.2

The API code interfaces in this release are backwards compatible with 1.1 release. As such no code needs to be rewritten to migrate to the newer release.

There is no need to recompile existing client code.

Changes in API behavior:

  • If a connection is closed before a query that was executed on that connection the query error callback will be called warning that the query has been closed unexpectedly. In order to avoid this you will need to close running queries before closing a connection.
  • It is not possible to close a running query from inside its callback. Any such call will block for 5 seconds and the error callback will be called warning that the query failed to close.
  • oacluster.sh replaces the deprecated node script. See /cluster/oacluster_script
node (deprecated)oacluster.sh
start a node in the foreground 
./node
./oacluster.sh
start 4 daemon nodes 
./node -instances 4
./oacluster.sh --start all 4
disable JMX 
./node -instances 4 -nojmx
./oacluster.sh --start all 5 --no-jmx
cluster status 
./node -status
./oacluster.sh --cluster-status 1
stop all nodes 
./node -stop
./oacluster.sh --kill all

1.0 to 1.1

The API code interfaces in this release are backwards compatible with the 1.0 release. As such no code needs to be rewritten to migrate to the newer release.

However, the underlying wire protocol has changed, so client code must be recompiled against the newer version to work with the 1.1 Open Access Node.

The node will emit log warnings if an older client is connected:

2013-11-28 11:18:09,827 WARN - VersionChecker - Rejecting incompatible client version '<unknown>' @ 192.168.10.205:50640. Expected version: 1.1.

The client would emit the following error:

 

If either of those messages appears, the client code must be recompiled against the newer version.

For the list of enhancements in version 1.1, see Release Notes.

Prototype to 1.X

See Migrating from the prototype to 1.X.