Summary: How to upgrade GigaSpaces from version 5.2 to 6.0. Overview | Migrating to Open Spaces | Service Grid Changes | External Data Source (CacheLoader\CacheStore) | Large Scale Deployment Recommendations | Event Session - Registering for Notifications | GigaSpaces-Service Grid Consolidation | Setting Communication Protocol Using Exporters | Configuration and Environment Changes | Jini Modifications | Spring Support | Partition ID | SQLQuery Changes | READ_COMMITED Modifier | .NET Changes | Changes to GigaSpaces Examples | API Chanages

Overview

There is no utility which upgrades from GigaSpaces version 5.2 to 6.0. It is recommended to use the GigaSpaces 6.0 distribution as-is.

In some scenarios, when there is a need to use the existing 5.2 environment, you are required to perform a set of steps in order to manually upgrade the system to version 6.0. These steps are detailed in the sections below.

GigaSpaces version 5.2 is currently supported, but will become deprecated in the future.

Mixing GigaSpaces versions

We do support:
Applications that were built using 6.0 will run without any code changes on a clean 6.0.x installation.

We do not support:
Mixing clients/servers from different GigaSpaces releases/builds - Clients of 6.0 will not run against 6.0.x servers. 6.0.x clients will not run against 6.0 servers. 6.0.x servers will not communicate well with 6.0 servers.

Mixing JDK Environments and GigaSpaces JARs

GigaSpaces running with JDK 1.5/1.6 can run with GigaSpaces 1.4 JARs, but GigaSpaces running with JDK 1.4 can't run with GigaSpaces 1.5/1.6 JARs:

If you have GigaSpaces running with JDK 1.4 and another installation of GigaSpaces running with JDK 1.5/1.6, use the GigaSpaces JAR files from the earliest version – copy the JSpaces.jar and JSpaces-ui.jar files from the <GigaSpaces Root>\lib directory of your GigaSpaces 1.4 installation to the <GigaSpaces Root>\lib directory of your GigaSpaces 1.5/1.6 installation.

GigaSpaces .NET does not support JDK 1.4.

GigaSpaces components (space, cluster of spaces, Processing Unit, GSM, GSC, LUS, Mahalo, GUI, CLI) can run only with the same GigaSpaces JARs (i.e., the same version and same build number).

Migrating to Open Spaces

See the Migrating to Open Spaces section.

Service Grid Changes

Deployment Descriptor Change

When migrating a GigaSpaces 5.2 application using the Service Grid Deployment Descriptor, update the SLA component to version 6.*:

Change:

<ServiceLevelAgreements>
    <SystemRequirements>
      <Utilization High=".9" ID="System" />
      <Utilization High=".9" ID="CPU" />
      <Utilization High=".9" ID="Memory" />
      <SystemComponent Name="GigaSpacesSupport">
        <Attribute Name="Version" Value="6.*" />
      </SystemComponent>
    </SystemRequirements>
</ServiceLevelAgreements>

to:

<ServiceLevelAgreements>
    <SystemRequirements>
      <Utilization High=".9" ID="System" />
      <Utilization High=".9" ID="CPU" />
      <Utilization High=".9" ID="Memory" />
      <SystemComponent Name="GigaSpacesSupport">
        <Attribute Name="Version" Value="5*" />
      </SystemComponent>
    </SystemRequirements>
</ServiceLevelAgreements>

Moving from Service Grid to Open Spaces

• Deployment Descriptor – Moved to pu.xml
• New Simplified SLA Definition Using pu.xml
• IWorker and Service Beans (Deprecated) – Moved to POJO services Within the Processing Unit

External Data Source (CacheLoader\CacheStore)

We recommend that you use the External Data Source interface in GigaSpaces XAP 6.0. However, performing read-through and write-through as in version 5.2 is also supported in version 6.0 (deprecated). For more details, see the version 5.2 documentation.

To use the External Data Source interface, define the following in your persistent space schema:

<space-config>
    <persistent>
        <enabled>true</enabled>
        <StorageAdapterClass>com.j_spaces.sadapter
         .datasource.DataAdapter</StorageAdapterClass>
    </persistent>
</space-config>

or add the following properties to your <GigaSpaces Root>\config\gs.properties file:

space-config.persistent.enabled=true
space-config.persistent.StorageAdapterClass=com.j_spaces.sadapter.datasource.DataAdapter

Change	5.2 Usage	6.0 Usage
New External Data Source replaces CacheLoader/CacheStore	CacheLoader/CacheStore were used, both for Map API and JavaSpaces API.	Map API - still uses CacheLoader/CacheStore. JavaSpaces API - uses new External Data Source interface.
CacheLifeCycleManager replacement	CacheLifeCycleManager was used.	Replaced by the ManagedDataSource - the init() method doesn't return any properties like the CacheLifeCycleManager, these properties are defined in the configuration, and are accessible to the CacheManager.
CacheLoader replacement	CacheLoader was used.	Replaced by the DataProvider. Currently read() is called only for queries with a UID, imposed by the transaction locking. There is no loadAll() method, since it is not needed by the space (the space always prefers the iterator).
CacheStore replacement	CacheStore was used.	Replaced by the DataPersister. This interface provides basic persistency of single objects. The objects passed to this interface are user defined objects.
CacheBulk replacement	CacheBulk was used.	Replaced by the BulkDataPersister. This interface provides bulk support - used by the mirror and transactions. If you were using the Mirror Service in version 5.2, and would like to use the enhanced mirror data replication in 6.0, you need to re-implement this interface.
BulkEntry replacement	BulkEntry was used.	Replaced by BulkItem. If you were using the Mirror Service in version 5.2, and would like to use the enhanced mirror data replication in 6.0, you need to re-implement this interface.
CacheIteratorFactory replacemement	CacheIteratorFactory was used.	Replaced by SQLDataProvider. This interface provides quering abilities for the data source. The query object is the SQLQuery object - replaces the CacheQuery object.
CacheIterator replacement	CacheIterator	Replaced by DataIterator - an extension of the java.util.Iterator adds a close() method that allows you to free any resources referenced by the iterator.
Configuration modification	Configuration was defined in the persistent space schema.	Data source configuration is defined in a new <external-data-source> block.
<CacheLoaderClass>, <entity-class>, <username>, <password> – deprecated	Used for CacheLoader/CacheStore configuration. For the elements' description, see the version 5.2 documentation.	These tags are relevant only if you are performing read-through and write-through as in version 5.2 (see the tip above). These have been removed from the schemas as of GigaSpaces 6.0.1.

Large Scale Deployment Recommendations

Click here for instructions and best practices when tuning large-scale deployments.

Event Session – Registering for Notifications

Registering for notifications as in version 5.2 (NotifyDelegator, NotifyDelegatorMultiplexer, MulticastNotifyDelegator) is deprecated in GigaSpaces 6.0. These interfaces are backwards compatible and can still be used in version 6.0.

However, we recommend that you use the new Session Based API.

To do this, the following changes should be taken into consideration:

GigaSpaces-Service Grid Consolidation

The Service Grid and GigaSpaces have been integrated into one coherent product. This includes several critical changes:

One config Directory

file://$
[com.gigaspaces.grid.home]

$[com.gigaspaces.system.codeserver]

http://
file://

One CLI and One bin Directory

One Logging Infrastructure

One examples Directory

One lib Directory

Environment Changes

Class-Path: .. jini/jsk-platform.jar jini/jsk-lib.jar
jini/start.jar rio/webster.jar rio/boot.jar

Class-Path: .. jini/jsk-platform.jar jini/jsk-lib.jar
jini/start.jar ServiceGrid/gs-lib.jar
ServiceGrid/gs-boot.jar

%EXT_JARS%;%JSHOMEDIR%;%JSHOMEDIR%/lib/JSpaces.jar
;%JSHOMEDIR%/lib/jini/jsk-platform.jar
;%JSHOMEDIR%/lib/jini/jsk-lib.jar
;%JSHOMEDIR%/lib/jini/start.jar
;%JSHOMEDIR%/lib/rio/webster.jar
;%JSHOMEDIR%/lib/rio/boot.jar
;%JSHOMEDIR%/lib/common/backport-util-concurrent.jar 

set GS_JARS=%EXT_JARS%;%JSHOMEDIR%
;%JSHOMEDIR%/lib/JSpaces.jar
;%JSHOMEDIR%/lib/jini/jsk-platform.jar
;%JSHOMEDIR%/lib/jini/jsk-lib.jar
;%JSHOMEDIR%/lib/jini/mahalo.jar
;%JSHOMEDIR%/lib/jini/reggie.jar
;%JSHOMEDIR%/lib/jini/start.jar
;%JSHOMEDIR%/lib/common/backport-util-concurrent.jar
;%JSHOMEDIR%/lib/ServiceGrid/gs-lib.jar
;%JSHOMEDIR%/lib/ServiceGrid/gs-boot.jar

set GS_JINI_START_CLASSPATH=%EXT_JARS%;
%JSHOMEDIR%;%JSHOMEDIR%/lib/jini/start.jar;
%JSHOMEDIR%/lib/ServiceGrid/gs-lib.jar

One UI

Setting Communication Protocol Using Exporters

• In GigaSpaces 6.0 and onwards, all product layers and components use the same, ultra-fast multiplex-based communication protocol. This change boosts performance, and decreases threads and stability of large scale clusters dramatically. It enables better troubleshooting and tuning using a single common configuration.

A partial list of components which use the GenericExporter protocol includes: Jini services (Mahalo, Reggie), Open Spaces, the Service Grid GSM/GSC, GUI, CLI, space/cluster.

Configuration and Environment Changes

Change	5.2 Usage	6.0 Usage
Removal of JSpaces-dl.jar	JSpaces-dl.jar was used.	JSpaces.jar is used instead - all references to JSpaces-dl.jar need to point to JSpaces.jar.
JSpaces-ui.jar addition	All GigaSpaces Management Center (previously named GigaSpaces Browser) related classes and resources (tools and isqlviewer packages) were part of the JSpaces.jar.	All GigaSpaces Management Center (previously named GigaSpaces Browser) related classes and resources (tools and isqlviewer packages) have been moved into the new JSpaces-ui.jar which is located under <GigaSpaces Root>\lib\ui.
Removal of GigaSpaces root\lib\spring\spring-modules-javaspaces.jar and GigaSpaces root\lib\spring\spring-modules-javaspaces-src.zip	Used for the SpringModule-GigaSpaces implementation.	Replaced with Open Spaces – GigaSpaces' new open-source, Spring-based project.
Defining HTTP codebase using -Djava.rmi .server.codebase	When defining your codebase using -Djava.rmi.server.codebase in the command line, the JSpaces-dl.jar/JSpaces.jar, reggie-dl.jar (if reggie was used), and jsk-dl.jar libraries were added by default.	No jar files are added, meaning you must add all of the relevant jar files yourself. For the required jar files when using GigaSpaces, refer to the Setting Classpath section.
Defining HTTP codebase port number	The HTTP codebase port number was defined dynamically.	It is possible to define the HTTP codebase port number yourself. If you are externally defining the codebase using -Djava.rmi.server.codebase, you must define a port. If you are using an embedded Webster, make sure the port number you specify is the same port number defined in your container schema: <embedded-services> <!-- Starts a Webster HTTP Server embedded in the container VM Default value: true --> <httpd> ... <!-- The host port the server socket HTTPD (Webster) is using is bound to. Default value: port 9813 but if that is busy it generates an anonymous port--> <explicit-binding-port>${com.gs. embedded-services.httpd.port} </explicit-binding-port> <httpd>
Space URL validation XSD	The resource loader tried to load the Space URL validation XSD from the JSpaces.jar, and if it was not found, for example when running in the IDE, the system broke because of this validation error.	The resource loader tries to load the Space URL validation XSD from the JSpaces.jar, and if it was not found, for example when running in the IDE, the system uses the Locator.derivePath() which recursively scans all directories under the home directory to load the file. In any event, the system should not break because of this validation error but throw a warning.
LoadBalanceImpl has been moved to a different package	com.j_spaces.core.cluster - cluster schema: <load-bal-policy> <load-bal-impl-class>com.j_spaces. core.cluster. LoadBalanceImpl </load-bal-impl-class> </load-bal-policy>	com.gigaspaces.cluster.loadbalance – this effects the <load-bal-impl> tag in all cluster schemas: <load-bal-policy> <load-bal-impl-class>com. gigaspaces.cluster. loadbalance.LoadBalanceImpl </load-bal-impl-class> </load-bal-policy>
New \config\services\advanced-space.config file		This file contains GigaSpaces custom space configuration definitions for advertisement facilities. Specifically, it is used to set the space's JoinManager leasing. Modifying this file is recommended only for advanced users. See the note below.

Unregistering Spaces "Disappear" from LUS

This occurs when a large amount of memory is consumed in the process, causing extensive JVM GC spikes. This causes high CPU usage and distracts the LeaseRenewManager (a long GC/CPU clock causes the LeaseRenewManager to miss the default 4 seconds, or a lease renew attempt which causes a space service un-registering event to be fired). If the LUS fires an event to unregister a space, the UI spaces tree node represents it using a special icon. A special logging in the UI is printed as well.

The current solution to avoid spaces unregistering is to add resources (memory, CPU) or spaces, or to tune the LeaseRenewal maxLeaseDuration and roundTripTime. These two values can be configured using the new <GigaSpaces Root>\config\services\advanced-space.config file:

//Default value for net.jini.lease.LeaseRenewalManager.roundTripTime default value 4 seconds
roundTripTime=4000;
//Default value for net.jini.lookup.JoinManager.maxLeaseDuration default value 8 seconds.
maxLeaseDuration=8000;

It is recommended to increase these values to 40000/80000 respectively in case a large cluster is used. Note that this causes a delay when the space recognizes failover, since the active election infrastructure is based on space un-registration.

Jini Modifications

All jar files under <GigaSpaces Root>\lib\jini have been replaced. Make sure you copy all the jar files.

Spring Support

In GigaSpaces 6.0 and onwards, it is recommended to use Open Spaces with GigaSpaces instead of Spring Modules.

If you still have a need for Spring Modules, extract this zip file into your <GigaSpaces Root> directory.

Partition ID

SQLQuery Changes

RegExQuery regExQuery = new RegExQuery(MyEntry.class.getName(),
new String[] { "name" }, new String[] { "a*b.*});

// Create SQLQuery with 'rlike' that return all the objects
that have a name that starts with a or c
SQLQuery rquery = new SQLQuery(MyEntry.class.getName(),
"name rlike '(a|c).*'");

// Get all results that match the query
Entry[] result = space.readMultiple
(rquery,null,Integer.MAX_VALUE);

READ_COMMITED Modifier

.NET Changes

See the .NET changes list.

Changes to GigaSpaces Examples

Some GigaSpaces examples (JavaSpaces, Data Grid, JMS, and persistency examples) have been removed, as they are not supported anymore. OpenSpaces, benchmark examples, and tutorials remain under the <GigaSpaces Root>\examples folder which includes the following:

• Advanced folder – contains GigaSpaces Benchmark example. (See the example documentation.)
• openspaces folder – contains GigaSpaces Open Spaces examples. (See Open Spaces Examples.)
• Tutorials folder – contains GigaSpaces tutorials. (See the Quick Start Guide.)

.NET and C++ examples exist under the <GigaSpaces Root>\dotnet\examples and <GigaSpaces Root>\cpp\examples folders (unzip the zip file and open the examples folder).

For GigaSpaces example documentation, refer to the Examples Portal.

API Chanages

com.j_spaces.core.IJSpaceContainer Methods Deprecation

SpaceFinder Changes

When performing lookup using the ServiceFinder, you can look only for started spaces by changing the following code:

new ServiceFinder(IJSpace.class, new Entry[] { SpaceName })

to:

Import com.j_spaces.lookup.entry.State;
State state = new State("started");
new ServiceFinder(IJSpace.class, new Entry[] { SpaceName,state })

Space Proxy Changes