Cluster (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- edu.utexas.clm.archipelago.Cluster

```
public class Cluster
extends Object
```
Author:

Larry Lindsey

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Cluster.ClusterState

Nested Classes
Modifier and Type	Class and Description
`static class`	`Cluster.ClusterState`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptingNodes()`
`static boolean`	`activeCluster()`
`void`	`addBottler(Bottler bottler)`
`void`	`addStateListener(ClusterStateListener listener)`
`static boolean`	`configureCluster(Cluster cluster, String execRootRemote, String fileRootRemote, String execRoot, String fileRoot, String userName)`
`int`	`countReadyNodes()`
`void`	`deRegisterUI(ArchipelagoUI ui)`
`boolean`	`equals(Object o)`
`List<Bottler>`	`getBottlers()`
`static Cluster`	`getCluster()`
`static Cluster`	`getClusterWithUI()`
`String`	`getLocalHostName()`
`int`	`getMaxThreads()`
`ClusterNode`	`getNode(long id)`
`NodeCoordinator`	`getNodeCoordinator()`
`ArrayList<NodeParameters>`	`getNodeParameters()` Compiles a list of NodeManager.NodeParameters corresponding to the current state of this Cluster.
`Set<ClusterNode>`	`getNodes()`
`static NodeShell`	`getNodeShell(String description)`
`NodeParametersFactory`	`getParametersFactory()`
`int`	`getQueuedJobCount()`
`int`	`getRunningJobCount()`
`ExecutorService`	`getService(float fractionThreads)`
`ExecutorService`	`getService(int nThreads)`
`Cluster.ClusterState`	`getState()`
`protected void`	`haltFinished()`
`boolean`	`hasNode(ClusterNode node)`
`boolean`	`hasNode(long id)`
`boolean`	`init()`
`static boolean`	`initializedCluster()`
`static boolean`	`isClusterService(ExecutorService es)`
`boolean`	`isReady()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`void`	`jobFinished()`
`void`	`nodeStarted()`
`void`	`nodeStopped(ClusterNode node, int nRunningNodes)`
`int`	`numRegisteredUIs()`
`static Collection<NodeShell>`	`registeredShells()`
`static void`	`registerNodeShell(NodeShell shell)`
`void`	`registerUI(ArchipelagoUI ui)`
`ArrayList<Callable<?>>`	`remainingCallables()`
`ArrayList<Runnable>`	`remainingRunnables()`
`void`	`removeStateListener(ClusterStateListener listener)`
`void`	`setLocalHostName(String host)`
`void`	`shutdown()`
`List<Runnable>`	`shutdownNow()`
`void`	`start()` Starts the Cluster if it has not yet been started
`void`	`startNode(ClusterNode node)`
`void`	`startNode(NodeParameters params)`
`static String`	`stateString(Cluster.ClusterState s)`
`protected void`	`terminateFinished()`
`String`	`toString()`
`void`	`triggerListeners()`
`void`	`waitForAllNodes(long timeout)`
`void`	`waitUntilReady()`
`void`	`waitUntilReady(long timeout)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getCluster
```
public static Cluster getCluster()
```

getClusterWithUI

public static Cluster getClusterWithUI()

activeCluster
```
public static boolean activeCluster()
```

initializedCluster

public static boolean initializedCluster()

stateString

public static String stateString(Cluster.ClusterState s)

registerNodeShell

public static void registerNodeShell(NodeShell shell)

getNodeShell

public static NodeShell getNodeShell(String description)

registeredShells

public static Collection<NodeShell> registeredShells()

configureCluster

public static boolean configureCluster(Cluster cluster,
                                       String execRootRemote,
                                       String fileRootRemote,
                                       String execRoot,
                                       String fileRoot,
                                       String userName)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

getState

public Cluster.ClusterState getState()

init
```
public boolean init()
```

setLocalHostName

public void setLocalHostName(String host)

getNode
```
public ClusterNode getNode(long id)
```

startNode

public void startNode(ClusterNode node)

startNode

public void startNode(NodeParameters params)

hasNode
```
public boolean hasNode(long id)
```

hasNode

public boolean hasNode(ClusterNode node)

addStateListener

public void addStateListener(ClusterStateListener listener)

removeStateListener

public void removeStateListener(ClusterStateListener listener)

triggerListeners
```
public void triggerListeners()
```

acceptingNodes
```
public boolean acceptingNodes()
```

waitForAllNodes

public void waitForAllNodes(long timeout)
                     throws InterruptedException,
                            TimeoutException

Throws:: InterruptedException; TimeoutException

waitUntilReady
```
public void waitUntilReady()
```

waitUntilReady

public void waitUntilReady(long timeout)

countReadyNodes
```
public int countReadyNodes()
```

isReady
```
public boolean isReady()
```

jobFinished
```
public void jobFinished()
```

getNodes
```
public Set<ClusterNode> getNodes()
```

getNodeParameters
```
public ArrayList<NodeParameters> getNodeParameters()
```
Compiles a list of NodeManager.NodeParameters corresponding to the current state of this Cluster. This List will include parameters for all ClusterNodes that are currently running or that have been added, but not yet started. It will not included stopped or cancelled nodes.

Returns:

a list of NodeManager.NodeParameters corresponding to the current state of this Cluster.

getNodeCoordinator

public NodeCoordinator getNodeCoordinator()

getParametersFactory

public NodeParametersFactory getParametersFactory()

addBottler

public void addBottler(Bottler bottler)

getBottlers
```
public List<Bottler> getBottlers()
```

start
```
public void start()
```
Starts the Cluster if it has not yet been started

getRunningJobCount
```
public int getRunningJobCount()
```

getQueuedJobCount
```
public int getQueuedJobCount()
```

haltFinished
```
protected void haltFinished()
```

terminateFinished
```
protected void terminateFinished()
```

remainingCallables

public ArrayList<Callable<?>> remainingCallables()

remainingRunnables

public ArrayList<Runnable> remainingRunnables()

nodeStopped

public void nodeStopped(ClusterNode node,
                        int nRunningNodes)

nodeStarted
```
public void nodeStarted()
```

isShutdown
```
public boolean isShutdown()
```

isTerminated
```
public boolean isTerminated()
```

shutdownNow
```
public List<Runnable> shutdownNow()
```

shutdown
```
public void shutdown()
```

getMaxThreads
```
public int getMaxThreads()
```

getService

public ExecutorService getService(int nThreads)

getService

public ExecutorService getService(float fractionThreads)

getLocalHostName
```
public String getLocalHostName()
```

registerUI

public void registerUI(ArchipelagoUI ui)

deRegisterUI

public void deRegisterUI(ArchipelagoUI ui)

numRegisteredUIs
```
public int numRegisteredUIs()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

isClusterService

public static boolean isClusterService(ExecutorService es)

Class Cluster

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCluster

getClusterWithUI

activeCluster

initializedCluster

stateString

registerNodeShell

getNodeShell

registeredShells

configureCluster

equals

getState

init

setLocalHostName

getNode

startNode

startNode

hasNode

hasNode

addStateListener

removeStateListener

triggerListeners

acceptingNodes

waitForAllNodes

waitUntilReady

waitUntilReady

countReadyNodes

isReady

jobFinished

getNodes

getNodeParameters

getNodeCoordinator

getParametersFactory

addBottler

getBottlers

start

getRunningJobCount

getQueuedJobCount

haltFinished

terminateFinished

remainingCallables

remainingRunnables

nodeStopped

nodeStarted

isShutdown

isTerminated

shutdownNow

shutdown

getMaxThreads

getService

getService

getLocalHostName

registerUI

deRegisterUI

numRegisteredUIs

toString

isClusterService