net.kuujo.vertigo

Class Vertigo

java.lang.Object

net.kuujo.vertigo.Vertigo

public final class Vertigo
extends Object

The core Vertigo API.

This is the primary interface for creating and deploying Vertigo networks.

Vertigo provides its own cluster abstraction that allows networks to be deployed either in a single Vert.x instance or across a Vert.x cluster. When a network is deployed, Vertigo uses the network's configuration to create a cluster in the proper scope. If the network indicates a LOCAL scope then its components will be deployed within the current Vert.x instance. If the network indicates a CLUSTER scope then its components will be deployed across the cluster using an event bus interface.

This API also supports active network configuration changes. Networks can be partially deployed and undeployed using the same methods as are used to deploy or undeploy entire networks. When a network is being deployed, Vertigo will determine whether a network of the same name is already running in the cluster. If the network is already running, Vertigo will merge the new network's configuration with the running network's configuration and update the running network's components and connections. Similarly, when a network is undeployed Vertigo will unmerge the undeployed network configuration from the running network configuration and only completely undeploy the network if all components have been undeployed.

It's important to note that regardless of the scope in which a network is deployed, Vertigo will always attempt to coordinate networks at the highest level. In other words, even if a network is deployed in LOCAL scope, Vertigo will check all nodes in the cluster to determine whether a network of the same name is already deployed. This helps prevent event bus address clashes in networks of the same name in the same cluster. But it also provides some additional usefulness. Users can connect local networks on different nodes together by simply deploying two networks of the same name in the LOCAL scope on two separate nodes. Since Vertigo coordinates at the cluster level, the two deployments will still become part of the same network and can thus communicate with one another.

Please note that Vertigo only supports the default Hazelcast cluster manager. Attempting to use Vertigo in a Vert.x cluster with any other cluster manager will simply fail.

Author:

Jordan Halterman

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
NetworkConfig	createNetwork(org.vertx.java.core.json.JsonObject json) Creates a network configuration from json.
NetworkConfig	createNetwork(String name) Creates a new network.
Vertigo	deployNetwork(org.vertx.java.core.json.JsonObject network) Deploys a complete or partial network from a JSON configuration.
Vertigo	deployNetwork(org.vertx.java.core.json.JsonObject network, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler) Deploys a complete or partial network from a JSON configuration.
Vertigo	deployNetwork(NetworkConfig network) Deploys a complete or partial network to the Vertigo cluster.
Vertigo	deployNetwork(NetworkConfig network, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler) Deploys a complete or partial network to the Vertigo cluster.
Vertigo	deployNetwork(String name) Deploys a bare network to the Vertigo cluster.
Vertigo	deployNetwork(String name, ClusterConfig cluster) Deploys a bare network to the Vertigo cluster.
Vertigo	deployNetwork(String name, ClusterConfig cluster, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler) Deploys a bare network to the Vertigo cluster.
Vertigo	deployNetwork(String name, ClusterScope scope) Deploys a bare network to the Vertigo cluster.
Vertigo	deployNetwork(String name, ClusterScope scope, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler) Deploys a bare network to the Vertigo cluster.
Vertigo	deployNetwork(String name, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler) Deploys a bare network to the Vertigo cluster.
Vertigo	getNetwork(String name, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> resultHandler) Loads an active network from the cluster.
Vertigo	isDeployed(NetworkConfig network, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> resultHandler) Checks whether a network is deployed in the cluster.
Vertigo	isDeployed(String name, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> resultHandler) Checks whether a network is deployed in the cluster.
Vertigo	undeployNetwork(org.vertx.java.core.json.JsonObject network) Undeploys a complete or partial network from a JSON configuration.
Vertigo	undeployNetwork(org.vertx.java.core.json.JsonObject network, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Undeploys a complete or partial network from a JSON configuration.
Vertigo	undeployNetwork(NetworkConfig network) Undeploys a complete or partial network from the Vertigo cluster.
Vertigo	undeployNetwork(NetworkConfig network, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Undeploys a complete or partial network from the Vertigo cluster.
Vertigo	undeployNetwork(String name) Undeploys a complete network from the Vertigo cluster.
Vertigo	undeployNetwork(String name, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Undeploys a complete network from the Vertigo cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

Vertigo

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

Vertigo

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

Method Detail

createNetwork

public NetworkConfig createNetwork(String name)

Creates a new network.

Parameters:

name - The network name.

Returns:

A new network instance.

See Also:

createNetwork(JsonObject)

createNetwork

public NetworkConfig createNetwork(org.vertx.java.core.json.JsonObject json)

Creates a network configuration from json.

Parameters:

json - A json network configuration.

Returns:

A network configuration.

See Also:

createNetwork(String)

isDeployed

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

Checks whether a network is deployed in the cluster.

Parameters:

name - The name of the network to check.

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

Returns:

The Vertigo instance.

See Also:

isDeployed(NetworkConfig, Handler)

isDeployed

public Vertigo isDeployed(NetworkConfig network,
                 org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> resultHandler)

Checks whether a network is deployed in the cluster.

Vertigo determines whether the network is running by first attempting to load the network's configuration from the internal coordination cluster. If the network's configuration is stored in the cluster, Vertigo loads the network's cluster and checks whether the network's manager is deployed in the appropriate cluster. If so, the network is considered deployed. Note that the configuration provided to this method is mostly irrelevant as only the given configuration's name is used to determine whether the network is running. This method will not indicate whether the entire given configuration is running.

Parameters:

network - The network to check.

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

Returns:

The Vertigo instance.

See Also:

isDeployed(String, Handler)

getNetwork

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

Loads an active network from the cluster.

In order to load the network, Vertigo will first attempt to load the network's configuration from the internal coordination cluster. The coordination cluster stores network configurations regardless of the scope in which a network was deployed. If the network's configuration is found, Vertigo loads the network's cluster scope and checks to ensure the network is running in that cluster. If the network configuration is found and the network is running in the appropriate cluster, an ActiveNetwork will be provided for the network. The active network can be used to reconfigure the network.

Parameters:

name - The name of the network to load.

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

Returns:

The Vertigo instance.

deployNetwork

public Vertigo deployNetwork(String name)

Deploys a bare network to the Vertigo cluster.

This method will deploy an empty network to the current Vertigo cluster. The current cluster is determined by whether the Vert.x instance was deployed as a Hazelcast clustered Vert.x instance. If the current Vert.x cluster is a Hazelcast cluster (the Vert.x default), the network will be deployed across the cluster. This means that any runtime configuration changes to the network will result in components being deployed on various nodes within the cluster rather than within the current Vert.x instance.

Parameters:

name - The name of the network to deploy. If a network with the given name is already deployed in the Vertigo cluster then the deployment will simply have no effect.

Returns:

The Vertigo instance.

See Also:

deployNetwork(String, Handler), deployNetwork(String, ClusterScope), deployNetwork(String, ClusterScope, Handler), deployNetwork(String, ClusterConfig), deployNetwork(String, ClusterConfig, Handler), deployNetwork(JsonObject), deployNetwork(JsonObject, Handler), deployNetwork(NetworkConfig), deployNetwork(NetworkConfig, Handler)

deployNetwork

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

Deploys a bare network to the Vertigo cluster.

This method will deploy an empty network to the current Vertigo cluster. The current cluster is determined by whether the Vert.x instance was deployed as a Hazelcast clustered Vert.x instance. If the current Vert.x cluster is a Hazelcast cluster (the Vert.x default), the network will be deployed across the cluster. This means that any runtime configuration changes to the network will result in components being deployed on various nodes within the cluster rather than within the current Vert.x instance.

Once the deployment is complete, an ActiveNetwork will be provided. The active network can be used to reconfigure the live network just like a normal network configuration. When active network configurations change, the live network is notified and asynchronously reconfigures itself to handle the configuration changes.

Parameters:

name - The name of the network to deploy. if a network with the given name is already deployed in the Vertigo cluster then the deployment will simply have no effect.

doneHandler - An asynchronous handler to be called once complete. If the network is successfully deployed, the handler will be passed an ActiveNetwork which can be used to reconfigure the network asynchronously without shutdown.

Returns:

The Vertigo instance.

See Also:

deployNetwork(String), deployNetwork(String, ClusterScope), deployNetwork(String, ClusterScope, Handler), deployNetwork(String, ClusterConfig), deployNetwork(String, ClusterConfig, Handler), deployNetwork(JsonObject), deployNetwork(JsonObject, Handler), deployNetwork(NetworkConfig), deployNetwork(NetworkConfig, Handler)

deployNetwork

public Vertigo deployNetwork(String name,
                    ClusterScope scope)

Deploys a bare network to the Vertigo cluster.

This method will deploy an empty network to the given cluster scope. If the current Vert.x instance is a Hazelcast clustered instance then the cluster scope may be either LOCAL or CLUSTER, but if the current Vert.x instance is not clustered then the cluster scope will fall back to LOCAL regardless of the value provided.

Parameters:

name - The name of the network to deploy. If a network with the given name is already deployed in the Vertigo cluster then the deployment will simply have no effect.

scope - The cluster scope in which to deploy the network.

Returns:

The Vertigo instance.

See Also:

deployNetwork(String), deployNetwork(String, Handler), deployNetwork(String, ClusterScope, Handler), deployNetwork(String, ClusterConfig), deployNetwork(String, ClusterConfig, Handler), deployNetwork(JsonObject), deployNetwork(JsonObject, Handler), deployNetwork(NetworkConfig), deployNetwork(NetworkConfig, Handler)

deployNetwork

public Vertigo deployNetwork(String name,
                    ClusterScope scope,
                    org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler)

Deploys a bare network to the Vertigo cluster.

This method will deploy an empty network to the given cluster scope. If the current Vert.x instance is a Hazelcast clustered instance then the cluster scope may be either LOCAL or CLUSTER, but if the current Vert.x instance is not clustered then the cluster scope will fall back to LOCAL regardless of the value provided.

Once the deployment is complete, an ActiveNetwork will be provided. The active network can be used to reconfigure the live network just like a normal network configuration. When active network configurations change, the live network is notified and asynchronously reconfigures itself to handle the configuration changes.

Parameters:

name - The name of the network to deploy. If a network with the given name is already deployed in the Vertigo cluster then the deployment will simply have no effect.

scope - The cluster scope in which to deploy the network.

doneHandler - An asynchronous handler to be called once complete. If the network is successfully deployed, the handler will be passed an ActiveNetwork which can be used to reconfigure the network asynchronously without shutdown.

Returns:

The Vertigo instance.

See Also:

deployNetwork(String), deployNetwork(String, Handler), deployNetwork(String, ClusterScope), deployNetwork(String, ClusterConfig), deployNetwork(String, ClusterConfig, Handler), deployNetwork(NetworkConfig), deployNetwork(NetworkConfig, Handler)

deployNetwork

public Vertigo deployNetwork(String name,
                    ClusterConfig cluster)

Deploys a bare network to the Vertigo cluster.

This method will deploy an empty network to the given cluster If the current Vert.x instance is a Hazelcast clustered instance then the cluster may be of either LOCAL or CLUSTER scope, but if the current Vert.x instance is not clustered then the cluster scope will fall back to LOCAL regardless of the cluster configuration.

Parameters:

name - The name of the network to deploy. If a network with the given name is already deployed in the Vertigo cluster then the deployment will simply have no effect.

cluster - The cluster configuration for the cluster to which to deploy the network.

Returns:

The Vertigo instance.

See Also:

deployNetwork(String), deployNetwork(String, Handler), deployNetwork(String, ClusterScope), deployNetwork(String, ClusterScope, Handler), deployNetwork(String, ClusterConfig, Handler), deployNetwork(JsonObject), deployNetwork(JsonObject, Handler), deployNetwork(NetworkConfig), deployNetwork(NetworkConfig, Handler)

deployNetwork

public Vertigo deployNetwork(String name,
                    ClusterConfig cluster,
                    org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ActiveNetwork>> doneHandler)

Deploys a bare network to the Vertigo cluster.

This method will deploy an empty network to the given cluster If the current Vert.x instance is a Hazelcast clustered instance then the cluster may be of either LOCAL or CLUSTER scope, but if the current Vert.x instance is not clustered then the cluster scope will fall back to LOCAL regardless of the cluster configuration.

Once the deployment is complete, an ActiveNetwork will be provided. The active network can be used to reconfigure the live network just like a normal network configuration. When active network configurations change, the live network is notified and asynchronously reconfigures itself to handle the configuration changes.

Parameters:

name - The name of the network to deploy. If a network with the given name is already deployed in the Vertigo cluster then the deployment will simply have no effect.

cluster - The cluster configuration for the cluster to which to deploy the network.

doneHandler - An asynchronous handler to be called once complete. If the network is successfully deployed, the handler will be passed an ActiveNetwork which can be used to reconfigure the network asynchronously without shutdown.

Returns:

The Vertigo instance.

See Also:

deployNetwork(String), deployNetwork(String, Handler), deployNetwork(String, ClusterScope), deployNetwork(String, ClusterScope, Handler), deployNetwork(String, ClusterConfig), deployNetwork(JsonObject), deployNetwork(JsonObject, Handler), deployNetwork(NetworkConfig), deployNetwork(NetworkConfig, Handler)

deployNetwork

public Vertigo deployNetwork(org.vertx.java.core.json.JsonObject network)

Deploys a complete or partial network from a JSON configuration.

If the given network's name matches the name of a network that's already running within the cluster then the configuration will be merged with the existing network's configuration. This allows components or connections to be added to existing networks by deploying separate configurations.

Note that only components and connections may be added or removed from running networks. Changes to things like cluster configurations will have no impact on the network as they are core to the operation of the network and thus require a complete shutdown for configuration changes.

When the network is deployed, Vertigo will use the network's cluster configuration to determine how deployments occur. If the network's cluster scope is CLUSTER and the current Vert.x instance is a Hazelcast clustered instance then Vertigo will attempt to perform deployments over the event bus at the cluster address provided in the configuration.

If the current Vert.x instance is not clustered then Vertigo will deploy the network using the Vert.x Container and coordination will occur strictly through Vert.x shared data structures.

Parameters:

network - The JSON configuration for the network to deploy.

Returns:

The Vertigo instance.

See Also:

createNetwork(JsonObject), deployNetwork(String), deployNetwork(String, Handler), deployNetwork(String, ClusterScope), deployNetwork(String, ClusterScope, Handler), deployNetwork(String, ClusterConfig), deployNetwork(String, ClusterConfig, Handler), deployNetwork(JsonObject, Handler), deployNetwork(NetworkConfig), deployNetwork(NetworkConfig, Handler)

deployNetwork

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

Deploys a complete or partial network from a JSON configuration.

If the given network's name matches the name of a network that's already running within the cluster then the configuration will be merged with the existing network's configuration. This allows components or connections to be added to existing networks by deploying separate configurations.

Note that only components and connections may be added or removed from running networks. Changes to things like cluster configurations will have no impact on the network as they are core to the operation of the network and thus require a complete shutdown for configuration changes.

When the network is deployed, Vertigo will use the network's cluster configuration to determine how deployments occur. If the network's cluster scope is CLUSTER and the current Vert.x instance is a Hazelcast clustered instance then Vertigo will attempt to perform deployments over the event bus at the cluster address provided in the configuration.

If the current Vert.x instance is not clustered then Vertigo will deploy the network using the Vert.x Container and coordination will occur strictly through Vert.x shared data structures.

Once the deployment is complete, an ActiveNetwork will be provided. The active network can be used to reconfigure the live network just like a normal network configuration. When active network configurations change, the live network is notified and asynchronously reconfigures itself to handle the configuration changes.

Parameters:

network - The JSON configuration for the network to deploy.

doneHandler - An asynchronous handler to be called once complete. If the network is successfully deployed, the handler will be passed an ActiveNetwork which can be used to reconfigure the network asynchronously without shutdown.

Returns:

The Vertigo instance.

See Also:

createNetwork(JsonObject), deployNetwork(String), deployNetwork(String, Handler), deployNetwork(String, ClusterScope), deployNetwork(String, ClusterScope, Handler), deployNetwork(String, ClusterConfig), deployNetwork(String, ClusterConfig, Handler), deployNetwork(JsonObject), deployNetwork(NetworkConfig), deployNetwork(NetworkConfig, Handler)

deployNetwork

public Vertigo deployNetwork(NetworkConfig network)

Deploys a complete or partial network to the Vertigo cluster.

If the given network's name matches the name of a network that's already running within the cluster then the configuration will be merged with the existing network's configuration. This allows components or connections to be added to existing networks by deploying separate configurations.

Note that only components and connections may be added or removed from running networks. Changes to things like cluster configurations will have no impact on the network as they are core to the operation of the network and thus require a complete shutdown for configuration changes.

When the network is deployed, Vertigo will use the network's cluster configuration to determine how deployments occur. If the network's cluster scope is CLUSTER and the current Vert.x instance is a Hazelcast clustered instance then Vertigo will attempt to perform deployments over the event bus at the cluster address provided in the configuration.

If the current Vert.x instance is not clustered then Vertigo will deploy the network using the Vert.x Container and coordination will occur strictly through Vert.x shared data structures.

Parameters:

network - The network configuration to deploy.

Returns:

The Vertigo instance.

See Also:

deployNetwork(String), deployNetwork(String, Handler), deployNetwork(String, ClusterScope), deployNetwork(String, ClusterScope, Handler), deployNetwork(String, ClusterConfig), deployNetwork(String, ClusterConfig, Handler), deployNetwork(JsonObject), deployNetwork(JsonObject, Handler), deployNetwork(NetworkConfig, Handler)

deployNetwork

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

Deploys a complete or partial network to the Vertigo cluster.

If the given network's name matches the name of a network that's already running within the cluster then the configuration will be merged with the existing network's configuration. This allows components or connections to be added to existing networks by deploying separate configurations.

Note that only components and connections may be added or removed from running networks. Changes to things like cluster configurations will have no impact on the network as they are core to the operation of the network and thus require a complete shutdown for configuration changes.

When the network is deployed, Vertigo will use the network's cluster configuration to determine how deployments occur. If the network's cluster scope is CLUSTER and the current Vert.x instance is a Hazelcast clustered instance then Vertigo will attempt to perform deployments over the event bus at the cluster address provided in the configuration.

If the current Vert.x instance is not clustered then Vertigo will deploy the network using the Vert.x Container and coordination will occur strictly through Vert.x shared data structures.

Once the deployment is complete, an ActiveNetwork will be provided. The active network can be used to reconfigure the live network just like a normal network configuration. When active network configurations change, the live network is notified and asynchronously reconfigures itself to handle the configuration changes.

Parameters:

network - The network configuration to deploy.

doneHandler - An asynchronous handler to be called once complete. If the network is successfully deployed, the handler will be passed an ActiveNetwork which can be used to reconfigure the network asynchronously without shutdown.

Returns:

The Vertigo instance.

See Also:

deployNetwork(String), deployNetwork(String, Handler), deployNetwork(String, ClusterScope), deployNetwork(String, ClusterScope, Handler), deployNetwork(String, ClusterConfig), deployNetwork(String, ClusterConfig, Handler), deployNetwork(JsonObject), deployNetwork(JsonObject, Handler), deployNetwork(NetworkConfig)

undeployNetwork

public Vertigo undeployNetwork(String name)

Undeploys a complete network from the Vertigo cluster.

The network will be undeployed in its entirety from the scope in which it was originally deployed. When this method is called, Vertigo will load the network's full configuration from the internal coordination cluster. The full configuration will be used to undeploy the proper components and the network manager.

Parameters:

name - The name of the network to undeploy.

Returns:

The Vertigo instance.

See Also:

undeployNetwork(String, Handler), undeployNetwork(JsonObject), undeployNetwork(JsonObject, Handler), undeployNetwork(NetworkConfig), undeployNetwork(NetworkConfig, Handler)

undeployNetwork

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

Undeploys a complete network from the Vertigo cluster.

The network will be undeployed in its entirety from the scope in which it was originally deployed. When this method is called, Vertigo will load the network's full configuration from the internal coordination cluster. The full configuration will be used to undeploy the proper components and the network manager. If the network's configuration cannot be found then the call will fail.

Parameters:

name - The name of the network to undeploy.

doneHandler - An asynchronous handler to be called once complete.

Returns:

The Vertigo instance.

See Also:

undeployNetwork(String), undeployNetwork(JsonObject), undeployNetwork(JsonObject, Handler), undeployNetwork(NetworkConfig), undeployNetwork(NetworkConfig, Handler)

undeployNetwork

public Vertigo undeployNetwork(org.vertx.java.core.json.JsonObject network)

Undeploys a complete or partial network from a JSON configuration.

The network will be undeployed from the scope in which is was originally deployed. In order to guarantee the network is undeployed from the proper scope, Vertigo will load the network's original configuration from its internal coordination cluster and use the original cluster configuration for undeployment. This means cluster configurations in the undeployed configuration provided to this method have no effect.

If the configuration is a complete match to the configuration of the deployed network, the complete network will be undeployed. Alternatively, if the given configuration is only a partial configuration compared to the complete deployed configuration, only the components and connections defined in the given configuration will be undeployed from the running network. This allows the network to be asynchronously reconfigured without undeploying the network.

Parameters:

network - The network configuration to undeploy.

Returns:

The Vertigo instance.

See Also:

undeployNetwork(String), undeployNetwork(String, Handler), undeployNetwork(JsonObject, Handler), undeployNetwork(NetworkConfig), undeployNetwork(NetworkConfig, Handler)

undeployNetwork

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

Undeploys a complete or partial network from a JSON configuration.

The network will be undeployed from the scope in which is was originally deployed. In order to guarantee the network is undeployed from the proper scope, Vertigo will load the network's original configuration from its internal coordination cluster and use the original cluster configuration for undeployment. This means cluster configurations in the undeployed configuration provided to this method have no effect.

If the configuration is a complete match to the configuration of the deployed network, the complete network will be undeployed. Alternatively, if the given configuration is only a partial configuration compared to the complete deployed configuration, only the components and connections defined in the given configuration will be undeployed from the running network. This allows the network to be asynchronously reconfigured without undeploying the network.

Parameters:

network - The network configuration to undeploy.

Returns:

The Vertigo instance.

See Also:

undeployNetwork(String), undeployNetwork(String, Handler), undeployNetwork(JsonObject), undeployNetwork(NetworkConfig), undeployNetwork(NetworkConfig, Handler)

undeployNetwork

public Vertigo undeployNetwork(NetworkConfig network)

Undeploys a complete or partial network from the Vertigo cluster.

The network will be undeployed from the scope in which is was originally deployed. In order to guarantee the network is undeployed from the proper scope, Vertigo will load the network's original configuration from its internal coordination cluster and use the original cluster configuration for undeployment. This means cluster configurations in the undeployed configuration provided to this method have no effect.

If the configuration is a complete match to the configuration of the deployed network, the complete network will be undeployed. Alternatively, if the given configuration is only a partial configuration compared to the complete deployed configuration, only the components and connections defined in the given configuration will be undeployed from the running network. This allows the network to be asynchronously reconfigured without undeploying the network.

Parameters:

network - The network configuration to undeploy.

Returns:

The Vertigo instance.

See Also:

undeployNetwork(String), undeployNetwork(String, Handler), undeployNetwork(JsonObject), undeployNetwork(JsonObject, Handler), undeployNetwork(NetworkConfig, Handler)

undeployNetwork

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

Undeploys a complete or partial network from the Vertigo cluster.

The network will be undeployed from the scope in which is was originally deployed. In order to guarantee the network is undeployed from the proper scope, Vertigo will load the network's original configuration from its internal coordination cluster and use the original cluster configuration for undeployment. This means cluster configurations in the undeployed configuration provided to this method have no effect.

If the configuration is a complete match to the configuration of the deployed network, the complete network will be undeployed. Alternatively, if the given configuration is only a partial configuration compared to the complete deployed configuration, only the components and connections defined in the given configuration will be undeployed from the running network. This allows the network to be asynchronously reconfigured without undeploying the network.

Parameters:

network - The network configuration to undeploy.

Returns:

The Vertigo instance.

See Also:

undeployNetwork(String), undeployNetwork(String, Handler), undeployNetwork(JsonObject), undeployNetwork(JsonObject, Handler), undeployNetwork(NetworkConfig)