Package net.sf.basedb.opengrid

Class OpenGridCluster

java.lang.Object

net.sf.basedb.opengrid.AbstractHost<OpenGridSession>

net.sf.basedb.opengrid.OpenGridCluster

public class OpenGridCluster
extends AbstractHost<OpenGridSession>

Represents a single Open Grid Scheduler cluster together with login information for accessing it via SSH. Use the connect(int) method to create a session for interacting with the cluster. This class is thread-safe, but the OpenGridSession need synchronization if used with multiple threads. Typically, instances of this class are created and managed by the OpenGridService. It is possible to create ad-hoc, unmanaged instances, but this is not recommended.

Since:

1.0

Author:

nicklas

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenGridCluster.Info	Holds information about the Open Grid cluster together with a timestamp for caching purposes.

Field Summary

Fields

Modifier and Type	Field	Description
private ClusterConfig	config
private String	id
private OpenGridCluster.Info	info

Constructor Summary

Constructors

Constructor	Description
OpenGridCluster(ConnectionInfo ci, ClusterConfig config)	Creates a new Open Grid Cluster instance.

Method Summary

Modifier and Type	Method	Description
org.json.simple.JSONObject	asJSONObject(JSONOptions options)	Get the configuration information for this cluster as a JSON object.
OpenGridSession	connect(int timeout)	Connect to the cluster.
OpenGridCluster.Info	getClusterInfo()	Get information about the Open Grid cluster.
ClusterConfig	getConfig()	Get configuration settings for this cluster.
String	getId()	Get the ID of this cluster.
String	getTmpFolder(String jobName, boolean debug)	Get the tmp folder for a job with the given name.
String	getWorkFolder(String jobName)	Get the work folder for a job with the given name.

Methods inherited from class net.sf.basedb.opengrid.AbstractHost

getConnectionInfo, internalConnect, toString

Methods inherited from class java.lang.Object

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

Field Details

id

private final String id

config

private final ClusterConfig config

info

private OpenGridCluster.Info info

Constructor Details

OpenGridCluster

public OpenGridCluster(ConnectionInfo ci,
ClusterConfig config)

Creates a new Open Grid Cluster instance. Note that the configurations will be locked as a result of calling this method.

Parameters:

ci - Connection information to access the cluster

config - Other configuration settings

Method Details

getId

public String getId()

Get the ID of this cluster. The ID is composed of the username, address and port from the connection information. The ID need to be unique among registered clusters.

getConfig

public ClusterConfig getConfig()

Get configuration settings for this cluster.

getWorkFolder

public String getWorkFolder(String jobName)

Get the work folder for a job with the given name.

getTmpFolder

public String getTmpFolder(String jobName,
boolean debug)

Get the tmp folder for a job with the given name.

getClusterInfo

public OpenGridCluster.Info getClusterInfo()

Get information about the Open Grid cluster. This is a shortcut for connecting to the cluster and exucuting a few commands on it: OpenGridSession.getHostInfo(), OpenGridSession.getOpenGridInfo() and OpenGridSession.getTimeAdjustment(). In addition, the information is cached for up to 1 hour.

connect

public OpenGridSession connect(int timeout)

Connect to the cluster. The returned session can be used to send commands or transfer files to/from the cluster. Do not forget to AbstractSession.close() the session after use.

Specified by:

connect in class AbstractHost<OpenGridSession>

Parameters:

timeout - Timeout in seconds for the connection to be established

asJSONObject

public org.json.simple.JSONObject asJSONObject(JSONOptions options)

Get the configuration information for this cluster as a JSON object. The following attributes are set: id: getId() config: getConfig().ClusterConfig.asJSONObject(JSONOptions) connection: AbstractHost.getConnectionInfo().ConnectionInfo.asJSONObject(JSONOptions) Note that a new JSON object is created each time this method is called. Clients should cache this information if they need to re-used it. More information about the cluster is also available by calling getClusterInfo().