net.kuujo.vertigo.cluster.impl

Class LocalClusterManager

java.lang.Object

net.kuujo.vertigo.cluster.impl.LocalClusterManager

All Implemented Interfaces:

ClusterManager

public class LocalClusterManager
extends Object

Local cluster manager implementation.

The local cluster manager is backed by LocalCluster which is simply an interface to the Vert.x Container and SharedData. Thus, deployments and coordination via the LocalClusterManager is is inherently done within a single Vert.x instance.

Author:

Jordan Halterman

Field Summary

Fields

Modifier and Type	Field and Description
protected Cluster	cluster
protected org.vertx.java.platform.Container	container
protected org.vertx.java.core.eventbus.EventBus	eventBus
protected org.vertx.java.core.Vertx	vertx

Constructor Summary

Constructors

Constructor and Description
LocalClusterManager(org.vertx.java.platform.Verticle verticle)
LocalClusterManager(org.vertx.java.core.Vertx vertx, org.vertx.java.platform.Container container)

Method Summary

Methods

Modifier and Type	Method and Description
ClusterManager	deployNetwork(NetworkConfig network) Deploys a network to the cluster.
ClusterManager	deployNetwork(NetworkConfig network, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler) Deploys a network to the cluster.
static LocalClusterManager	factory(String address, org.vertx.java.core.Vertx vertx, org.vertx.java.platform.Container container)
ClusterManager	getNetwork(String name, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> resultHandler) Gets a network reference for a deployed network.
ClusterManager	isRunning(String name, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> resultHandler) Checks whether a network is running in the cluster.
ClusterScope	scope() Returns the cluster manager scope.
ClusterManager	undeployNetwork(NetworkConfig network) Undeploys a network from the cluster.
ClusterManager	undeployNetwork(NetworkConfig network, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Undeploys a network from the cluster.
ClusterManager	undeployNetwork(String name) Undeploys a complete network from the cluster.
ClusterManager	undeployNetwork(String name, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Undeploys a complete network from the cluster.

Methods inherited from class java.lang.Object

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

Field Detail

vertx

protected final org.vertx.java.core.Vertx vertx

container

protected final org.vertx.java.platform.Container container

eventBus

protected final org.vertx.java.core.eventbus.EventBus eventBus

cluster

protected final Cluster cluster

Constructor Detail

LocalClusterManager

public LocalClusterManager(org.vertx.java.platform.Verticle verticle)

LocalClusterManager

public LocalClusterManager(org.vertx.java.core.Vertx vertx,
                   org.vertx.java.platform.Container container)

Method Detail

factory

public static LocalClusterManager factory(String address,
                          org.vertx.java.core.Vertx vertx,
                          org.vertx.java.platform.Container container)

scope

public ClusterScope scope()

Description copied from interface: ClusterManager

Returns the cluster manager scope.

Returns:

The cluster manager scope.

getNetwork

public ClusterManager getNetwork(String name,
                        org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> resultHandler)

Description copied from interface: ClusterManager

Gets a network reference for a deployed network.

If the network is running in the cluster then an ActiveNetwork instance will be returned to the asynchronous handler. The ActiveNetwork can be used to arbitrarily and asynchronously alter the structure of the running network.

Specified by:

getNetwork in interface ClusterManager

Parameters:

name - The name of the network to get.

resultHandler - An asynchronous handler to be called with the result. If the network exists then an ActiveNetwork instance which references the running network will be provided, otherwise, the result will be null

Returns:

The cluster manager.

isRunning

public ClusterManager isRunning(String name,
                       org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> resultHandler)

Description copied from interface: ClusterManager

Checks whether a network is running in the cluster.

In order to check whether a network is running, the cluster manager attempts to load the network's configuration from the internal Vertigo coordination cluster. If the configuration exists then the cluster manager then checks to see if the network is actually running.

Specified by:

isRunning in interface ClusterManager

Parameters:

name - The name of the network to check.

resultHandler - An asynchronous handler to be called with the result.

Returns:

The cluster manager.

deployNetwork

public ClusterManager deployNetwork(NetworkConfig network)

Description copied from interface: ClusterManager

Deploys a network to the cluster.

If the given network configuration's name matches the name of a network that is already running in the cluster then the given configuration will be merged with the running network's configuration. This allows networks to be dynamically updated with partial configurations. If the configuration matches the already running configuration then no changes will occur, so it's not necessary to check whether a network is already running if the configuration has not been altered.

Specified by:

deployNetwork in interface ClusterManager

Parameters:

network - The configuration of the network to deploy.

Returns:

The cluster manager.

deployNetwork

public ClusterManager deployNetwork(NetworkConfig network,
                           org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler)

Description copied from interface: ClusterManager

Deploys a network to the cluster.

If the given network configuration's name matches the name of a network that is already running in the cluster then the given configuration will be merged with the running network's configuration. This allows networks to be dynamically updated with partial configurations. If the configuration matches the already running configuration then no changes will occur, so it's not necessary to check whether a network is already running if the configuration has not been altered.

Specified by:

deployNetwork in interface ClusterManager

Parameters:

network - The configuration of the network to deploy.

doneHandler - An asynchronous handler to be called once the deployment is complete. The handler will be called with an ActiveNetwork instance that references the running network. The ActiveNetwork can be used to arbitrarily and asynchronously update the live network configuration.

Returns:

The cluster manager.

undeployNetwork

public ClusterManager undeployNetwork(String name)

Description copied from interface: ClusterManager

Undeploys a complete network from the cluster.

This method does not require a network configuration for undeployment. Vertigo will load the configuration from the fault-tolerant data store and undeploy components internally. This allows networks to be undeployed without the network configuration.

Specified by:

undeployNetwork in interface ClusterManager

Parameters:

name - The name of the network to undeploy.

Returns:

The cluster manager.

undeployNetwork

public ClusterManager undeployNetwork(String name,
                             org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Description copied from interface: ClusterManager

Undeploys a complete network from the cluster.

This method does not require a network configuration for undeployment. Vertigo will load the configuration from the fault-tolerant data store and undeploy components internally. This allows networks to be undeployed without the network configuration.

Specified by:

undeployNetwork in interface ClusterManager

Parameters:

name - The name of the network to undeploy.

doneHandler - An asynchronous handler to be called once the network is undeployed.

Returns:

The cluster manager.

undeployNetwork

public ClusterManager undeployNetwork(NetworkConfig network)

Description copied from interface: ClusterManager

Undeploys a network from the cluster.

This method supports both partial and complete undeployment of networks. When undeploying networks by specifying a NetworkConfig, the network configuration should contain all components and connections that are being undeployed. If the configuration's components and connections match all deployed components and connections then the entire network will be undeployed.

Specified by:

undeployNetwork in interface ClusterManager

Parameters:

network - The network configuration to undeploy.

Returns:

The cluster manager.

undeployNetwork

public ClusterManager undeployNetwork(NetworkConfig network,
                             org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Description copied from interface: ClusterManager

Undeploys a network from the cluster.

This method supports both partial and complete undeployment of networks. When undeploying networks by specifying a NetworkConfig, the network configuration should contain all components and connections that are being undeployed. If the configuration's components and connections match all deployed components and connections then the entire network will be undeployed.

Specified by:

undeployNetwork in interface ClusterManager

Parameters:

network - The network configuration to undeploy.

doneHandler - An asynchronous handler to be called once the network is undeployed.

Returns:

The cluster manager.