co.paralleluniverse.galaxy

Class Grid

java.lang.Object

co.paralleluniverse.galaxy.Grid

public class Grid
extends Object

The central access point to the grid's services (the word grid describes the collection distributed of software provided in the physical node cluster).

Method Summary

Methods

Modifier and Type	Method and Description
Cluster	cluster() Returns the grid's cluster management and node lifecycle service.
static Grid	getInstance() Retrieves the named grid instance, as specified in the default configuration file.
static Grid	getInstance(String configFile, Properties properties) Retrieves the grid instance, as defined in the given configuration file.
static Grid	getInstance(String configFile, String propertiesFile) Retrieves the grid instance, as defined in the given configuration file.
void	goOnline() Makes this node a full participant in the cluster (rather than just an observer).
Messenger	messenger() Returns the grid's messaging service.
Store	store() Returns the grid's distributed data-store service.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Grid getInstance()
                        throws InterruptedException

Retrieves the named grid instance, as specified in the default configuration file.

Returns:

The grid instance.

Throws:

InterruptedException

getInstance

public static Grid getInstance(String configFile,
               String propertiesFile)
                        throws InterruptedException

Retrieves the grid instance, as defined in the given configuration file.

Parameters:

configFile - The name of the configuration file containing the grid definition.

propertiesFile - The name of the properties file containing the grid's properties. You may, of course use Spring's <context:property-placeholder location="classpath:com/foo/bar.properties"/> but this parameter is helpful when you want to use the same xml configuration with different properties for different instances.

Returns:

The grid instance.

Throws:

InterruptedException

getInstance

public static Grid getInstance(String configFile,
               Properties properties)
                        throws InterruptedException

Retrieves the grid instance, as defined in the given configuration file.

Parameters:

configFile - The name of the configuration file containing the grid definition.

properties - A Properties object containing the grid's properties to be injected into placeholders in the configuration file. This parameter is helpful when you want to use the same xml configuration with different properties for different instances.

Returns:

The grid instance.

Throws:

InterruptedException

store

public Store store()

Returns the grid's distributed data-store service.

Returns:

The grid's distributed data-store service.

messenger

public Messenger messenger()

Returns the grid's messaging service.

Returns:

The grid's messaging service.

cluster

public Cluster cluster()

Returns the grid's cluster management and node lifecycle service.

Returns:

The grid's cluster management and node lifecycle service.

goOnline

public void goOnline()
              throws InterruptedException

Makes this node a full participant in the cluster (rather than just an observer).

Throws:

InterruptedException