org.vertx.java.platform

Interface PlatformManager

public interface PlatformManager

Public interface for PlatformManager It's the role of a PlatformManager to deploy and undeploy modules and verticles. It's also used to install modules, and for various other tasks. The Platform Manager basically represents the Vert.x container in which verticles and modules run. The Platform Manager is used by the Vert.x CLI to run/install/etc modules and verticles but you could also use it if you want to embed the entire Vert.x container in an application, or write some other tool (e.g. a build tool, or a test tool) which needs to do stuff with the container

Method Summary

Methods

Modifier and Type	Method and Description
void	deployModule(java.lang.String moduleName, JsonObject config, int instances, Handler<AsyncResult<java.lang.String>> doneHandler) Deploy a module
void	deployModuleFromZip(java.lang.String zipFileName, JsonObject config, int instances, Handler<AsyncResult<java.lang.String>> doneHandler) Deploy a module from a zip file.
void	deployVerticle(java.lang.String main, JsonObject config, java.net.URL[] classpath, int instances, java.lang.String includes, Handler<AsyncResult<java.lang.String>> doneHandler) Deploy a verticle
void	deployWorkerVerticle(boolean multiThreaded, java.lang.String main, JsonObject config, java.net.URL[] classpath, int instances, java.lang.String includes, Handler<AsyncResult<java.lang.String>> doneHandler) Deploy a worker verticle
void	installModule(java.lang.String moduleName, Handler<AsyncResult<java.lang.Void>> doneHandler) Install a module into the filesystem Vert.x will search in the configured repos to locate the module
java.util.Map<java.lang.String,java.lang.Integer>	listInstances() List all deployments, with deployment ID and number of instances
void	pullInDependencies(java.lang.String moduleName, Handler<AsyncResult<java.lang.Void>> doneHandler) Pull in all the dependencies (the 'includes' and the 'deploys' fields in mod.json) and copy them into an internal mods directory in the module.
void	registerExitHandler(Handler<java.lang.Void> handler) Register a handler that will be called when the platform exits because of a verticle calling container.exit()
void	stop() Stop the platform manager
void	undeploy(java.lang.String deploymentID, Handler<AsyncResult<java.lang.Void>> doneHandler) Undeploy a deployment
void	undeployAll(Handler<AsyncResult<java.lang.Void>> doneHandler) Undeploy all verticles and modules
void	uninstallModule(java.lang.String moduleName, Handler<AsyncResult<java.lang.Void>> doneHandler) Uninstall a module from the filesystem
Vertx	vertx()

Method Detail

deployVerticle

void deployVerticle(java.lang.String main,
                  JsonObject config,
                  java.net.URL[] classpath,
                  int instances,
                  java.lang.String includes,
                  Handler<AsyncResult<java.lang.String>> doneHandler)

Deploy a verticle

Parameters:

main - The main, e.g. app.js, foo.rb, org.mycompany.MyMain, etc

config - Any JSON config to pass to the verticle, or null if none

classpath - The classpath for the verticle

instances - The number of instances to deploy

includes - Comma separated list of modules to include, or null if none

doneHandler - Handler will be called with deploymentID when deployed, or null if it fails to deploy

deployWorkerVerticle

void deployWorkerVerticle(boolean multiThreaded,
                        java.lang.String main,
                        JsonObject config,
                        java.net.URL[] classpath,
                        int instances,
                        java.lang.String includes,
                        Handler<AsyncResult<java.lang.String>> doneHandler)

Deploy a worker verticle

Parameters:

multiThreaded - Is it a multi-threaded worker verticle?

main - The main, e.g. app.js, foo.rb, org.mycompany.MyMain, etc

config - Any JSON config to pass to the verticle, or null if none

classpath - The classpath for the verticle

instances - The number of instances to deploy

includes - Comma separated list of modules to include, or null if none

doneHandler - Handler will be called with deploymentID when deployed, or null if it fails to deploy

deployModule

void deployModule(java.lang.String moduleName,
                JsonObject config,
                int instances,
                Handler<AsyncResult<java.lang.String>> doneHandler)

Deploy a module

Parameters:

moduleName - The name of the module to deploy

config - Any JSON config to pass to the verticle, or null if none

instances - The number of instances to deploy

doneHandler - Handler will be called with deploymentID when deployed, or null if it fails to deploy

deployModuleFromZip

void deployModuleFromZip(java.lang.String zipFileName,
                       JsonObject config,
                       int instances,
                       Handler<AsyncResult<java.lang.String>> doneHandler)

Deploy a module from a zip file. The zip must contain a valid Vert.x module. Vert.x will automatically install the module from the zip into the local mods dir or the system mods dir (if it's a system module), or VERTX_MODS if set, and then deploy the module

Parameters:

zipFileName - The name of the zip file that contains the module

config - Any JSON config to pass to the verticle, or null if none

instances - The number of instances to deploy

doneHandler - Handler will be called with deploymentID when deployed, or null if it fails to deploy

undeploy

void undeploy(java.lang.String deploymentID,
            Handler<AsyncResult<java.lang.Void>> doneHandler)

Undeploy a deployment

Parameters:

deploymentID - The ID of the deployment to undeploy, as given in the doneHandler when deploying

doneHandler - The done handler will be called when deployment is complete or fails

undeployAll

void undeployAll(Handler<AsyncResult<java.lang.Void>> doneHandler)

Undeploy all verticles and modules

Parameters:

doneHandler - The done handler will be called when complete

listInstances

java.util.Map<java.lang.String,java.lang.Integer> listInstances()

List all deployments, with deployment ID and number of instances

Returns:

map of instances

installModule

void installModule(java.lang.String moduleName,
                 Handler<AsyncResult<java.lang.Void>> doneHandler)

Install a module into the filesystem Vert.x will search in the configured repos to locate the module

Parameters:

moduleName - The name of the module

uninstallModule

void uninstallModule(java.lang.String moduleName,
                   Handler<AsyncResult<java.lang.Void>> doneHandler)

Uninstall a module from the filesystem

Parameters:

moduleName -

pullInDependencies

void pullInDependencies(java.lang.String moduleName,
                      Handler<AsyncResult<java.lang.Void>> doneHandler)

Pull in all the dependencies (the 'includes' and the 'deploys' fields in mod.json) and copy them into an internal mods directory in the module. This allows a self contained module to be created.

Parameters:

moduleName - The name of the module

registerExitHandler

void registerExitHandler(Handler<java.lang.Void> handler)

Register a handler that will be called when the platform exits because of a verticle calling container.exit()

Parameters:

handler - The handler

vertx

Vertx vertx()

Returns:

A reference to the Vertx instance used by the platform manager

stop

void stop()

Stop the platform manager