net.kuujo.vertigo.cluster

Interface ClusterManager

All Known Implementing Classes:

DefaultClusterManager

public interface ClusterManager

The cluster manager handles deployment and undeployment of complete or partial Vertigo networks and provides an interface for accessing existing networks in the Vertigo cluster.

Author:

Jordan Halterman

Method Summary

Methods

Modifier and Type	Method and Description
String	address() Returns the cluster address.
ClusterManager	deployNetwork(org.vertx.java.core.json.JsonObject network) Deploys a json network to the cluster.
ClusterManager	deployNetwork(org.vertx.java.core.json.JsonObject network, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler) Deploys a json network to the cluster.
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.
ClusterManager	deployNetwork(String name) Deploys a bare network to the cluster.
ClusterManager	deployNetwork(String name, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler) Deploys a bare network to the cluster.
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	getNetworks(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Collection<ActiveNetwork>>> resultHandler) Gets a list of networks deployed in the cluster.
ClusterManager	isDeployed(String name, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> resultHandler) Checks whether a network is deployed in the cluster.
ClusterManager	undeployNetwork(org.vertx.java.core.json.JsonObject network) Undeploys a network from json.
ClusterManager	undeployNetwork(org.vertx.java.core.json.JsonObject network, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Undeploys a network from json.
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.

Method Detail

address

String address()

Returns the cluster address.

Returns:

The cluster address.

getNetworks

ClusterManager getNetworks(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Collection<ActiveNetwork>>> resultHandler)

Gets a list of networks deployed in the cluster.

Parameters:

resultHandler - An asynchronous handler to be called with a collection of ActiveNetwork instances, each representing a network running in the cluster.

Returns:

The cluster manager.

getNetwork

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

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.

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.

isDeployed

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

Checks whether a network is deployed in the cluster.

In order to check whether a network is deployed, 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.

Parameters:

name - The name of the network to check.

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

Returns:

The cluster manager.

deployNetwork

ClusterManager deployNetwork(String name)

Deploys a bare network to the cluster.

The network will be deployed with no components and no connections. You can add components and connections to the network with an ActiveNetwork instance.

Parameters:

name - The name of the network to deploy.

Returns:

The cluster manager.

deployNetwork

ClusterManager deployNetwork(String name,
                           org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler)

Deploys a bare network to the cluster.

The network will be deployed with no components and no connections. You can add components and connections to the network with an ActiveNetwork instance.

Parameters:

name - The name of the network to deploy.

doneHandler - An asynchronous handler to be called once the network has completed deployment. The handler will be called with an ActiveNetwork instance which can be used to add or remove components and connections from the network.

Returns:

The cluster manager.

deployNetwork

ClusterManager deployNetwork(org.vertx.java.core.json.JsonObject network)

Deploys a json network to the cluster.

The JSON network configuration will be converted to a NetworkConfig before being deployed to the cluster. The conversion is done synchronously, so if the configuration is invalid then this method may throw an exception.

Parameters:

network - The JSON network configuration. For the configuration format see the project documentation.

Returns:

The cluster manager.

deployNetwork

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

Deploys a json network to the cluster.

The JSON network configuration will be converted to a NetworkConfig before being deployed to the cluster. The conversion is done synchronously, so if the configuration is invalid then this method may throw an exception. Once the network has been deployed an ActiveNetwork will be provided which can be used to add and remove components and connections from the network.

Parameters:

network - The JSON network configuration. For the configuration format see the project documentation.

doneHandler - An asynchronous handler to be called once the network has completed deployment. The handler will be called with an ActiveNetwork instance which can be used to add or remove components and connections from the network.

Returns:

The cluster manager.

deployNetwork

ClusterManager deployNetwork(NetworkConfig network)

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.

Parameters:

network - The configuration of the network to deploy.

Returns:

The cluster manager.

deployNetwork

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

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.

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

ClusterManager undeployNetwork(String name)

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.

Parameters:

name - The name of the network to undeploy.

Returns:

The cluster manager.

undeployNetwork

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

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.

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

ClusterManager undeployNetwork(org.vertx.java.core.json.JsonObject network)

Undeploys a network from json.

The JSON configuration will immediately be converted to a NetworkConfig prior to undeploying the network. In order to undeploy the entire network, the configuration should be the same as the deployed configuration. Vertigo will use configuration components to determine whether two configurations are identical. If the given configuration is not identical to the running configuration, any components or connections in the json configuration that are present in the running network will be closed and removed from the running network.

Parameters:

network - The JSON configuration to undeploy. For the configuration format see the project documentation.

Returns:

The cluster manager.

undeployNetwork

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

Undeploys a network from json.

The JSON configuration will immediately be converted to a NetworkConfig prior to undeploying the network. In order to undeploy the entire network, the configuration should be the same as the deployed configuration. Vertigo will use configuration components to determine whether two configurations are identical. If the given configuration is not identical to the running configuration, any components or connections in the json configuration that are present in the running network will be closed and removed from the running network.

Parameters:

network - The JSON configuration to undeploy. For the configuration format see the project documentation.

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

Returns:

The cluster manager.

undeployNetwork

ClusterManager undeployNetwork(NetworkConfig network)

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.

Parameters:

network - The network configuration to undeploy.

Returns:

The cluster manager.

undeployNetwork

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

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.

Parameters:

network - The network configuration to undeploy.

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

Returns:

The cluster manager.