net.kuujo.vertigo.cluster

Interface Node

All Known Implementing Classes:

DefaultNode

public interface Node

Client for communicating with a single Vertigo cluster node.

This client handles deployment of modules and verticles on a specific node within a Vertigo cluster.

This client communicates directly with a cluster node over the event bus. Users should get a Node instance by calling Cluster.getNode(String, Handler) rather than by instantiating a node directly. This will ensure that the node's event bus address is properly namespaced according to the cluster and group to which it belongs.

Author:

Jordan Halterman

Method Summary

Methods

Modifier and Type	Method and Description
String	address() Returns the node address.
Node	deployModule(String moduleName) Deploys a module to the node.
Node	deployModule(String moduleName, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a module to the node.
Node	deployModule(String moduleName, int instances) Deploys a module to the node.
Node	deployModule(String moduleName, int instances, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a module to the node.
Node	deployModule(String moduleName, org.vertx.java.core.json.JsonObject config) Deploys a module to the node.
Node	deployModule(String moduleName, org.vertx.java.core.json.JsonObject config, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a module to the node.
Node	deployModule(String moduleName, org.vertx.java.core.json.JsonObject config, int instances) Deploys a module to the node.
Node	deployModule(String moduleName, org.vertx.java.core.json.JsonObject config, int instances, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a module to the node.
Node	deployVerticle(String main) Deploys a verticle to the node.
Node	deployVerticle(String main, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a verticle to the node.
Node	deployVerticle(String main, int instances) Deploys a verticle to the node.
Node	deployVerticle(String main, int instances, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a verticle to the node.
Node	deployVerticle(String main, org.vertx.java.core.json.JsonObject config) Deploys a verticle to the node.
Node	deployVerticle(String main, org.vertx.java.core.json.JsonObject config, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a verticle to the node.
Node	deployVerticle(String main, org.vertx.java.core.json.JsonObject config, int instances) Deploys a verticle to the node.
Node	deployVerticle(String main, org.vertx.java.core.json.JsonObject config, int instances, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a verticle to the node.
Node	deployWorkerVerticle(String main) Deploys a worker verticle to the node.
Node	deployWorkerVerticle(String main, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a worker verticle to the node.
Node	deployWorkerVerticle(String main, int instances) Deploys a worker verticle to the node.
Node	deployWorkerVerticle(String main, int instances, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a worker verticle to the node.
Node	deployWorkerVerticle(String main, org.vertx.java.core.json.JsonObject config) Deploys a worker verticle to the node.
Node	deployWorkerVerticle(String main, org.vertx.java.core.json.JsonObject config, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a worker verticle to the node.
Node	deployWorkerVerticle(String main, org.vertx.java.core.json.JsonObject config, int instances, boolean multiThreaded) Deploys a worker verticle to the node.
Node	deployWorkerVerticle(String main, org.vertx.java.core.json.JsonObject config, int instances, boolean multiThreaded, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Deploys a worker verticle to the node.
Node	installModule(String moduleName) Installs a local module to the node.
Node	installModule(String moduleName, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Installs a local module to the node.
Node	ping(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Node>> resultHandler) Pings the node.
Node	undeployModule(String deploymentID) Undeploys a module from the node.
Node	undeployModule(String deploymentID, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Undeploys a module from the node.
Node	undeployVerticle(String deploymentID) Undeploys a verticle from the node.
Node	undeployVerticle(String deploymentID, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Undeploys a verticle from the node.
Node	uninstallModule(String moduleName) Uninstalls a module from the node.
Node	uninstallModule(String moduleName, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Uninstalls a module from the node.

Method Detail

address

String address()

Returns the node address.

Returns:

The node address.

ping

Node ping(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Node>> resultHandler)

Pings the node.

Parameters:

resultHandler - A handler to be called once the node responds.

Returns:

The node.

installModule

Node installModule(String moduleName)

Installs a local module to the node.

The module being installed must be available on the local classpath in the normal Vert.x mods directory. If the module is already installed on a given node then the node will be skipped, otherwise the local module will be zipped, uploaded, and installed to the node.

Parameters:

moduleName - The name of the module to install.

Returns:

The node.

installModule

Node installModule(String moduleName,
                 org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Installs a local module to the node.

The module being installed must be available on the local classpath in the normal Vert.x mods directory. If the module is already installed on a given node then the node will be skipped, otherwise the local module will be zipped, uploaded, and installed to the node.

Parameters:

moduleName - The name of the module to install.

doneHandler - A handler to be called once the module has been installed.

Returns:

The node.

uninstallModule

Node uninstallModule(String moduleName)

Uninstalls a module from the node.

When the module is uninstalled, it will be removed from the classpath of the remote node. This means you should not uninstall modules that were originally installed on any given node.

Parameters:

moduleName - The name of the module to uninstall.

Returns:

The node.

uninstallModule

Node uninstallModule(String moduleName,
                   org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Uninstalls a module from the node.

When the module is uninstalled, it will be removed from the classpath of the remote node. This means you should not uninstall modules that were originally installed on any given node.

Parameters:

moduleName - The name of the module to uninstall.

doneHandler - A handler to be called once the module has been uninstalled.

Returns:

The node.

deployModule

Node deployModule(String moduleName)

Deploys a module to the node.

The module must be available on the node. You can install the module to the node using the installModule(String, Handler) method.

Parameters:

moduleName - The name of the module to deploy.

Returns:

The node.

deployModule

Node deployModule(String moduleName,
                org.vertx.java.core.json.JsonObject config)

Deploys a module to the node.

The module must be available on the node. You can install the module to the node using the installModule(String, Handler) method.

Parameters:

moduleName - The name of the module to deploy.

config - The module configuration.

Returns:

The node.

deployModule

Node deployModule(String moduleName,
                int instances)

Deploys a module to the node.

The module must be available on the node. You can install the module to the node using the installModule(String, Handler) method.

Parameters:

moduleName - The name of the module to deploy.

instances - The number of instances to deploy.

Returns:

The node.

deployModule

Node deployModule(String moduleName,
                org.vertx.java.core.json.JsonObject config,
                int instances)

Deploys a module to the node.

The module must be available on the node. You can install the module to the node using the installModule(String, Handler) method.

Parameters:

moduleName - The name of the module to deploy.

config - The module configuration.

instances - The number of instances to deploy.

Returns:

The node.

deployModule

Node deployModule(String moduleName,
                org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a module to the node.

The module must be available on the node. You can install the module to the node using the installModule(String, Handler) method.

Parameters:

moduleName - The name of the module to deploy.

doneHandler - A handler to be called once the module has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployModule

Node deployModule(String moduleName,
                org.vertx.java.core.json.JsonObject config,
                org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a module to the node.

The module must be available on the node. You can install the module to the node using the installModule(String, Handler) method.

Parameters:

moduleName - The name of the module to deploy.

config - The module configuration.

doneHandler - A handler to be called once the module has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployModule

Node deployModule(String moduleName,
                int instances,
                org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a module to the node.

The module must be available on the node. You can install the module to the node using the installModule(String, Handler) method.

Parameters:

moduleName - The name of the module to deploy.

instances - The number of instances to deploy.

doneHandler - A handler to be called once the module has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployModule

Node deployModule(String moduleName,
                org.vertx.java.core.json.JsonObject config,
                int instances,
                org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a module to the node.

The module must be available on the node. You can install the module to the node using the installModule(String, Handler) method.

Parameters:

moduleName - The name of the module to deploy.

config - The module configuration.

instances - The number of instances to deploy.

doneHandler - A handler to be called once the module has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployVerticle

Node deployVerticle(String main)

Deploys a verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

Returns:

The node.

deployVerticle

Node deployVerticle(String main,
                  org.vertx.java.core.json.JsonObject config)

Deploys a verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

config - The verticle configuration.

Returns:

The node.

deployVerticle

Node deployVerticle(String main,
                  int instances)

Deploys a verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

instances - The number of instances to deploy.

Returns:

The node.

deployVerticle

Node deployVerticle(String main,
                  org.vertx.java.core.json.JsonObject config,
                  int instances)

Deploys a verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

config - The verticle configuration.

instances - The number of instances to deploy.

Returns:

The node.

deployVerticle

Node deployVerticle(String main,
                  org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

doneHandler - A handler to be called once the verticle has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployVerticle

Node deployVerticle(String main,
                  org.vertx.java.core.json.JsonObject config,
                  org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

config - The verticle configuration.

doneHandler - A handler to be called once the verticle has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployVerticle

Node deployVerticle(String main,
                  int instances,
                  org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

instances - The number of instances to deploy.

doneHandler - A handler to be called once the verticle has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployVerticle

Node deployVerticle(String main,
                  org.vertx.java.core.json.JsonObject config,
                  int instances,
                  org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

config - The verticle configuration.

instances - The number of instances to deploy.

doneHandler - A handler to be called once the verticle has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployWorkerVerticle

Node deployWorkerVerticle(String main)

Deploys a worker verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

Returns:

The node.

deployWorkerVerticle

Node deployWorkerVerticle(String main,
                        org.vertx.java.core.json.JsonObject config)

Deploys a worker verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

config - The verticle configuration.

Returns:

The node.

deployWorkerVerticle

Node deployWorkerVerticle(String main,
                        int instances)

Deploys a worker verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

instances - The number of instances to deploy.

Returns:

The node.

deployWorkerVerticle

Node deployWorkerVerticle(String main,
                        org.vertx.java.core.json.JsonObject config,
                        int instances,
                        boolean multiThreaded)

Deploys a worker verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

config - The verticle configuration.

instances - The number of instances to deploy.

multiThreaded - Indicates whether the worker should be multi-threaded.

Returns:

The node.

deployWorkerVerticle

Node deployWorkerVerticle(String main,
                        org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a worker verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

doneHandler - A handler to be called once the verticle has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployWorkerVerticle

Node deployWorkerVerticle(String main,
                        org.vertx.java.core.json.JsonObject config,
                        org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a worker verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

config - The verticle configuration.

doneHandler - A handler to be called once the verticle has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployWorkerVerticle

Node deployWorkerVerticle(String main,
                        int instances,
                        org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a worker verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

instances - The number of instances to deploy.

doneHandler - A handler to be called once the verticle has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

deployWorkerVerticle

Node deployWorkerVerticle(String main,
                        org.vertx.java.core.json.JsonObject config,
                        int instances,
                        boolean multiThreaded,
                        org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Deploys a worker verticle to the node.

The verticle must be available on the classpath of the node.

Parameters:

main - The verticle main.

config - The verticle configuration.

instances - The number of instances to deploy.

multiThreaded - Indicates whether the worker should be multi-threaded.

doneHandler - A handler to be called once the verticle has been deployed. The handler will be called with the unique deployment ID if successful.

Returns:

The node.

undeployModule

Node undeployModule(String deploymentID)

Undeploys a module from the node.

The deployment ID must be a deployment that was deployed by this node. If the given deployment is not a deployment on the node a ClusterException will occur.

Parameters:

deploymentID - The deployment ID of the module to undeploy.

Returns:

The node.

undeployModule

Node undeployModule(String deploymentID,
                  org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Undeploys a module from the node.

The deployment ID must be a deployment that was deployed by this node. If the given deployment is not a deployment on the node a ClusterException will occur.

Parameters:

deploymentID - The deployment ID of the module to undeploy.

doneHandler - A handler to be called once complete.

Returns:

The node.

undeployVerticle

Node undeployVerticle(String deploymentID)

Undeploys a verticle from the node.

The deployment ID must be a deployment that was deployed by this node. If the given deployment is not a deployment on the node a ClusterException will occur.

Parameters:

deploymentID - The deployment ID of the verticle to undeploy.

Returns:

The node.

undeployVerticle

Node undeployVerticle(String deploymentID,
                    org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Undeploys a verticle from the node.

The deployment ID must be a deployment that was deployed by this node. If the given deployment is not a deployment on the node a ClusterException will occur.

Parameters:

deploymentID - The deployment ID of the verticle to undeploy.

doneHandler - A handler to be called once complete.

Returns:

The node.