com.scaleout.client

Class GridConnection

java.lang.Object

com.scaleout.client.GridConnection

public abstract class GridConnection
extends java.lang.Object

Represents connection(s) to one or more servers in a ScaleOut in-memory data grid.

A GridConnection instance is thread-safe, long-lived, and maintains a pool of TCP connections to a ScaleOut in-memory data grid. Multiple Cache instances should use the same GridConnection instance if they are connecting to the same ScaleOut in-memory data grid.

Multiple GridConnection's can be used for a single client to connect to many ScaleOut in-memory data grids.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_connectionString The connection string.
protected com.scaleout.client.messaging.GridMessagingService	_messagingService The messaging service.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridConnection() Protected, hidden constructor.
protected	GridConnection(java.lang.String connectionString) private, hidden constructor.

Method Summary

Modifier and Type	Method and Description
static GridConnection	connect(java.lang.String connectionString) Connects to a ScaleOut in-memory data grid, returning a GridConnection instance that can be used with a CacheBuilder to create a Cache and access objects in the ScaleOut in-memory data grid.
static GridConnection	connect(java.lang.String connectionString, BootstrapGatewayProvider bootstrapGatewayProvider) Connects to a ScaleOut in-memory data grid, returning a GridConnection instance that can be used with a CacheBuilder to create a Cache and access objects in the ScaleOut in-memory data grid.
abstract java.util.List<java.net.InetSocketAddress>	getActiveGateways()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_connectionString

protected java.lang.String _connectionString

The connection string.

_messagingService

protected com.scaleout.client.messaging.GridMessagingService _messagingService

The messaging service.

Constructor Detail

GridConnection

protected GridConnection()

Protected, hidden constructor.

GridConnection

protected GridConnection(java.lang.String connectionString)

private, hidden constructor.

Parameters:

connectionString - the connection string.

Method Detail

connect

public static GridConnection connect(java.lang.String connectionString)
                              throws GridConnectException

Connects to a ScaleOut in-memory data grid, returning a GridConnection instance that can be used with a CacheBuilder to create a Cache and access objects in the ScaleOut in-memory data grid.

Parameters:

connectionString - String containing parameters for connecting to ScaleOut host(s).

Returns:

a GridConnection instance

Throws:

GridConnectException - if an error occurs when connecting to a host, invalid parameters in the connection string, or there are no ScaleOut hosts available.

connect

public static GridConnection connect(java.lang.String connectionString,
                                     BootstrapGatewayProvider bootstrapGatewayProvider)
                              throws GridConnectException

Connects to a ScaleOut in-memory data grid, returning a GridConnection instance that can be used with a CacheBuilder to create a Cache and access objects in the ScaleOut in-memory data grid.

Parameters:

connectionString - String containing parameters for connecting to ScaleOut host(s).

bootstrapGatewayProvider - an implementation of the BootstrapGatewayProvider. EC2 and GCP providers available.

Returns:

a GridConnection instance

Throws:

GridConnectException - if an error occurs when connecting to a host, invalid parameters in the connection string, or there are no ScaleOut hosts available.

getActiveGateways

public abstract java.util.List<java.net.InetSocketAddress> getActiveGateways()