org.vertx.java.platform.impl

Class DefaultPlatformManager

java.lang.Object

org.vertx.java.platform.impl.DefaultPlatformManager

All Implemented Interfaces:

ModuleReloader, PlatformManagerInternal, PlatformManager

public class DefaultPlatformManager
extends java.lang.Object
implements PlatformManagerInternal, ModuleReloader

Field Summary

Fields

Modifier and Type	Field and Description
protected org.vertx.java.core.spi.cluster.ClusterManager	clusterManager
protected java.util.Map<java.lang.String,Deployment>	deployments
protected HAManager	haManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultPlatformManager()
protected	DefaultPlatformManager(int port, java.lang.String hostname)
protected	DefaultPlatformManager(int port, java.lang.String hostname, int quorumSize, java.lang.String haGroup)
protected	DefaultPlatformManager(int port, java.lang.String hostname, int quorumSize, java.lang.String haGroup, boolean haEnabled)

Method Summary

Methods

Modifier and Type	Method and Description
int	checkNoModules()
org.vertx.java.core.json.JsonObject	config()
void	createModuleLink(java.lang.String moduleName, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.Void>> doneHandler)
java.util.Map<java.lang.String,Deployment>	deployments()
void	deployModule(java.lang.String moduleName, org.vertx.java.core.json.JsonObject config, int instances, boolean ha, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler) Deploy a module
void	deployModule(java.lang.String moduleName, org.vertx.java.core.json.JsonObject config, int instances, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler) Deploy a module
void	deployModuleFromClasspath(java.lang.String moduleName, org.vertx.java.core.json.JsonObject config, int instances, java.net.URL[] classpath, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler) Deploy a module from the classpath.
void	deployModuleFromZip(java.lang.String zipFileName, org.vertx.java.core.json.JsonObject config, int instances, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler) Deploy a module from a zip file.
void	deployModuleInternal(java.lang.String moduleName, org.vertx.java.core.json.JsonObject config, int instances, boolean ha, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler)
void	deployVerticle(java.lang.String main, org.vertx.java.core.json.JsonObject config, java.net.URL[] classpath, int instances, java.lang.String includes, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler) Deploy a verticle
void	deployWorkerVerticle(boolean multiThreaded, java.lang.String main, org.vertx.java.core.json.JsonObject config, java.net.URL[] classpath, int instances, java.lang.String includes, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler) Deploy a worker verticle
void	exit()
void	installModule(java.lang.String moduleName, org.vertx.java.core.Handler<org.vertx.java.core.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
org.vertx.java.core.logging.Logger	logger()
void	makeFatJar(java.lang.String moduleName, java.lang.String directory, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.Void>> doneHandler) Create a fat executable jar which includes the Vert.x binaries and the module so it can be run directly with java without having to pre-install Vert.x.
void	pullInDependencies(java.lang.String moduleName, org.vertx.java.core.Handler<org.vertx.java.core.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(org.vertx.java.core.Handler<java.lang.Void> handler) Register a handler that will be called when the platform exits because of a verticle calling container.exit()
void	reloadModules(java.util.Set<Deployment> deps)
void	removeModule(java.lang.String moduleKey)
void	stop() Stop the platform manager
void	undeploy(java.lang.String deploymentID, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.Void>> doneHandler) Undeploy a deployment
void	undeployAll(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.Void>> doneHandler) Undeploy all verticles and modules
void	uninstallModule(java.lang.String moduleName, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.Void>> doneHandler) Uninstall a module from the filesystem
org.vertx.java.core.Vertx	vertx()

Methods inherited from class java.lang.Object

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

Field Detail

deployments

protected final java.util.Map<java.lang.String,Deployment> deployments

clusterManager

protected final org.vertx.java.core.spi.cluster.ClusterManager clusterManager

haManager

protected HAManager haManager

Constructor Detail

DefaultPlatformManager

protected DefaultPlatformManager()

DefaultPlatformManager

protected DefaultPlatformManager(int port,
                      java.lang.String hostname)

DefaultPlatformManager

protected DefaultPlatformManager(int port,
                      java.lang.String hostname,
                      int quorumSize,
                      java.lang.String haGroup)

DefaultPlatformManager

protected DefaultPlatformManager(int port,
                      java.lang.String hostname,
                      int quorumSize,
                      java.lang.String haGroup,
                      boolean haEnabled)

Method Detail

registerExitHandler

public void registerExitHandler(org.vertx.java.core.Handler<java.lang.Void> handler)

Description copied from interface: PlatformManager

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

Specified by:

registerExitHandler in interface PlatformManager

Parameters:

handler - The handler

deployVerticle

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

Description copied from interface: PlatformManager

Deploy a verticle

Specified by:

deployVerticle in interface PlatformManager

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

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

Description copied from interface: PlatformManager

Deploy a worker verticle

Specified by:

deployWorkerVerticle in interface PlatformManager

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

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

Description copied from interface: PlatformManager

Deploy a module

Specified by:

deployModule in interface PlatformManager

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

deployModule

public void deployModule(java.lang.String moduleName,
                org.vertx.java.core.json.JsonObject config,
                int instances,
                boolean ha,
                org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler)

Description copied from interface: PlatformManager

Deploy a module

Specified by:

deployModule in interface PlatformManager

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

ha - If true then the module is enabled for ha and will failover to any other vert.x instances with the same group in the cluster

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

deployModuleFromClasspath

public void deployModuleFromClasspath(java.lang.String moduleName,
                             org.vertx.java.core.json.JsonObject config,
                             int instances,
                             java.net.URL[] classpath,
                             org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler)

Description copied from interface: PlatformManager

Deploy a module from the classpath. The classpath must contain a single mod.json and the resources for that module only.

Specified by:

deployModuleFromClasspath in interface PlatformManager

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

classpath - Array of URLS corresponding to the classpath for the module

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

undeploy

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

Description copied from interface: PlatformManager

Undeploy a deployment

Specified by:

undeploy in interface PlatformManager

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

public void undeployAll(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.Void>> doneHandler)

Description copied from interface: PlatformManager

Undeploy all verticles and modules

Specified by:

undeployAll in interface PlatformManager

Parameters:

doneHandler - The done handler will be called when complete

listInstances

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

Description copied from interface: PlatformManager

List all deployments, with deployment ID and number of instances

Specified by:

listInstances in interface PlatformManager

Returns:

map of instances

installModule

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

Description copied from interface: PlatformManager

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

Specified by:

installModule in interface PlatformManager

Parameters:

moduleName - The name of the module

uninstallModule

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

Description copied from interface: PlatformManager

Uninstall a module from the filesystem

Specified by:

uninstallModule in interface PlatformManager

pullInDependencies

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

Description copied from interface: PlatformManager

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.

Specified by:

pullInDependencies in interface PlatformManager

Parameters:

moduleName - The name of the module

makeFatJar

public void makeFatJar(java.lang.String moduleName,
              java.lang.String directory,
              org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.Void>> doneHandler)

Description copied from interface: PlatformManager

Create a fat executable jar which includes the Vert.x binaries and the module so it can be run directly with java without having to pre-install Vert.x. e.g.: java -jar mymod~1.0-fat.jar

Specified by:

makeFatJar in interface PlatformManager

Parameters:

moduleName - The name of the module to create the fat jar for

directory - Directory in which to place the jar

doneHandler - Handler that will be called on completion

createModuleLink

public void createModuleLink(java.lang.String moduleName,
                    org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.Void>> doneHandler)

Specified by:

createModuleLink in interface PlatformManager

reloadModules

public void reloadModules(java.util.Set<Deployment> deps)

Specified by:

reloadModules in interface ModuleReloader

vertx

public org.vertx.java.core.Vertx vertx()

Specified by:

vertx in interface PlatformManager

Returns:

A reference to the Vertx instance used by the platform manager

deployModuleFromZip

public void deployModuleFromZip(java.lang.String zipFileName,
                       org.vertx.java.core.json.JsonObject config,
                       int instances,
                       org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler)

Description copied from interface: PlatformManager

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

Specified by:

deployModuleFromZip in interface PlatformManager

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

exit

public void exit()

Specified by:

exit in interface PlatformManagerInternal

config

public org.vertx.java.core.json.JsonObject config()

Specified by:

config in interface PlatformManagerInternal

logger

public org.vertx.java.core.logging.Logger logger()

Specified by:

logger in interface PlatformManagerInternal

deployments

public java.util.Map<java.lang.String,Deployment> deployments()

Specified by:

deployments in interface PlatformManagerInternal

deployModuleInternal

public void deployModuleInternal(java.lang.String moduleName,
                        org.vertx.java.core.json.JsonObject config,
                        int instances,
                        boolean ha,
                        org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> doneHandler)

Specified by:

deployModuleInternal in interface PlatformManagerInternal

stop

public void stop()

Description copied from interface: PlatformManager

Stop the platform manager

Specified by:

stop in interface PlatformManager

checkNoModules

public int checkNoModules()

Specified by:

checkNoModules in interface PlatformManagerInternal

removeModule

public void removeModule(java.lang.String moduleKey)

Specified by:

removeModule in interface PlatformManagerInternal