net.kuujo.vertigo.platform

Interface PlatformManager

All Known Implementing Classes:

DefaultPlatformManager

public interface PlatformManager

Local module system manager.

The platform manager facilitates zipping, installing, uninstalling, and deploying modules. This allows Vertigo to read the local module system and distribute modules across the Vertigo cluster.

Author:

Jordan Halterman

Method Summary

Methods

Modifier and Type	Method and Description
PlatformManager	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 local module.
PlatformManager	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.
PlatformManager	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.
PlatformManager	getModuleInfo(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Collection<ModuleInfo>>> resultHandler) Loads module info for all local modules.
PlatformManager	getModuleInfo(String moduleName, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ModuleInfo>> doneHandler) Loads module info for a local module.
PlatformManager	installModule(String moduleZip, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Installs a module from a zip file.
PlatformManager	undeployModule(String deploymentID, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Undeploys a module from the local container.
PlatformManager	undeployVerticle(String deploymentID, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Undeploys a verticle from the local container.
PlatformManager	uninstallModule(String moduleName, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Uninstalls a locally installed module.
PlatformManager	zipModule(String zipFile, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler) Zips a local module.

Method Detail

getModuleInfo

PlatformManager getModuleInfo(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Collection<ModuleInfo>>> resultHandler)

Loads module info for all local modules.

Parameters:

resultHandler - An asynchronous handler to be called once complete. The handler will be called with a collection of module info from which the module identifier and configuration can be read.

Returns:

The platform manager.

getModuleInfo

PlatformManager getModuleInfo(String moduleName,
                            org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<ModuleInfo>> doneHandler)

Loads module info for a local module.

Parameters:

moduleName - The name of the module for which to load info.

doneHandler - An asynchronous handler to be called once complete.

Returns:

The platform manager.

zipModule

PlatformManager zipModule(String zipFile,
                        org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<String>> doneHandler)

Zips a local module.

Parameters:

moduleName - The name of the module to zip.

doneHandler - An asynchronous handler to be called once complete. The handler will be called with the full path to the module zip file.

Returns:

The platform manager.

installModule

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

Installs a module from a zip file.

Parameters:

moduleZip - The full path to the module zip file.

doneHandler - An asynchronous handler to be called once complete.

Returns:

The platform manager.

uninstallModule

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

Uninstalls a locally installed module.

Parameters:

moduleName - The name of the module to uninstall.

doneHandler - An asynchronous handler to be called once complete.

Returns:

The platform manager.

deployModule

PlatformManager 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 local module.

Parameters:

moduleName - The name of the module to deploy.

config - The module configuration.

instances - The number of instances to deploy.

doneHandler - An asynchronous handler to be called with the unique deployment ID.

Returns:

The platform manager.

deployVerticle

PlatformManager 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.

Parameters:

main - The verticle main.

config - The verticle configuration.

instances - The number of instances to deploy.

doneHandler - An asynchronous handler to be called once complete.

Returns:

The platform manager.

deployWorkerVerticle

PlatformManager 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.

Parameters:

main - The verticle main.

config - The verticle configuration.

instances - The number of instances to deploy.

multiThreaded - Whether the verticle should be deployed multi-threaded.

doneHandler - An asynchronous handler to be called once complete.

Returns:

The platform manager.

undeployModule

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

Undeploys a module from the local container.

Parameters:

deploymentID - The module deployment ID.

doneHandler - An asynchronous handler to be called once complete.

Returns:

The platform manager.

undeployVerticle

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

Undeploys a verticle from the local container.

Parameters:

deploymentID - The verticle deployment ID.

doneHandler - An asynchronous handler to be called once complete.

Returns:

The platform manager.