hydra

Class DistributedConnectionMgr

java.lang.Object

hydra.DistributedConnectionMgr

public class DistributedConnectionMgr
extends Object

A class used to manage the distributed connection for a VM.

Constructor Summary

Constructors

Constructor and Description
DistributedConnectionMgr()

Method Summary

Modifier and Type	Method and Description
static com.gemstone.gemfire.distributed.DistributedSystem	connect() Gets a connection to the distributed system named in the GemFirePrms.GEMFIRE_NAME_PROPERTY system property.
static com.gemstone.gemfire.distributed.DistributedSystem	connect(String cacheXmlFile) Gets a connection to the distributed system named in the GemFirePrms.GEMFIRE_NAME_PROPERTY system property.
static com.gemstone.gemfire.distributed.DistributedSystem	connect(String name, Properties props) This method was added as a workaround for testing locators running in client VM.
static void	disconnect() Disconnects this VM from the distributed system by closing its connection, if one exists.
static com.gemstone.gemfire.distributed.DistributedSystem	getConnection() Gets the current connection to the distributed system, if any.
static boolean	isConnected() Answers whether this VM is connected.

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedConnectionMgr

public DistributedConnectionMgr()

Method Detail

getConnection

public static com.gemstone.gemfire.distributed.DistributedSystem getConnection()

Gets the current connection to the distributed system, if any. Returns null if this VM is not connected.

connect

public static com.gemstone.gemfire.distributed.DistributedSystem connect(String cacheXmlFile)

Gets a connection to the distributed system named in the GemFirePrms.GEMFIRE_NAME_PROPERTY system property. This comes from ClientPrms.gemfireNames.

This method is thread-safe for clients in each VM. It is not thread-safe when combined with calls to disconnect().

Parameters:

xmlFileName - The name of a declarative xml file to use at startup, or null.

Throws:

HydraConfigException - if the system property is not set.

HydraRuntimeException - if the distributed system node is not local.

connect

public static com.gemstone.gemfire.distributed.DistributedSystem connect()

Gets a connection to the distributed system named in the GemFirePrms.GEMFIRE_NAME_PROPERTY system property. This comes from ClientPrms.gemfireNames.

This method is thread-safe for clients in each VM. It is not thread-safe when combined with calls to disconnect().

Throws:

HydraConfigException - if the system property is not set.

HydraRuntimeException - if the distributed system node is not local.

connect

public static com.gemstone.gemfire.distributed.DistributedSystem connect(String name,
                                                                         Properties props)

This method was added as a workaround for testing locators running in client VM. It sets the VM connection to the distributed system named in the input name using the input system properties. The workaround was required to prevent hydra tests from connecting to the hydra-configured gemfire system which allows one and only one locator.

This method is thread-safe for clients in each VM. It is not thread-safe when combined with calls to disconnect().

Throws:

HydraConfigException - if the system property is not set.

HydraRuntimeException - if the distributed system node is not local.

disconnect

public static void disconnect()

Disconnects this VM from the distributed system by closing its connection, if one exists.

CAUTION: If used from a VM that is running concurrent clients, it is up to the clients to handle the fallout.

isConnected

public static boolean isConnected()

Answers whether this VM is connected.