Vert.x 4.5.13 · io.vertx.core.impl.launcher.commands.RunCommand

Modifier and Type	Field and Description
protected boolean	cluster
protected String	config
protected DeploymentOptions	deploymentOptions
protected boolean	ha
protected int	instances
protected String	mainVerticle
protected String	onRedeployCommand
protected List<String>	redeploy
private long	redeployGracePeriod
private long	redeployScanPeriod
private long	redeployTerminationPeriod
protected String	vertxApplicationBackgroundId
protected Watcher	watcher
protected boolean	worker

Access	Constructor and Description
public	RunCommand()

Method Summary

Modifier and Type	Method and Description
protected void	afterConfigParsed(JsonObject config) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element.
protected void	afterStoppingVertx()
protected void	beforeDeployingVerticle(DeploymentOptions deploymentOptions)
protected void	beforeStoppingVertx(Vertx vertx)
public void	close(Promise<Void> the promise to signal when close has completed completion) Implements io.vertx.core.Closeable.close. Close this resource, the `completion` promise must be notified when the operation has completed.
protected void	deploy()
protected JsonObject	getConfiguration() References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element.
public boolean	getHA() Overrides io.vertx.core.impl.launcher.commands.BareCommand.getHA.
private void	handleDeployFailed(Throwable cause)
protected synchronized void	initializeRedeployment() Initializes the redeployment cycle.
public boolean	Returns: whether the `cluster` option or the `ha` option are enabled. Also `true` when a custom launcher modifies the Vert.x options to set `clustered` to `true` isClustered() Overrides io.vertx.core.impl.launcher.commands.BareCommand.isClustered.
public void	run() Overrides io.vertx.core.impl.launcher.commands.BareCommand.run. Implements io.vertx.core.spi.launcher.Command.run. Starts vert.x and deploy the verticle.
public void	setCluster(boolean whether or not to start vert.x in clustered mode. cluster) Enables / disables the clustering.
public void	setConfig(String the configuration configuration) The main verticle configuration, it can be a json file or a json string.
public void	setHighAvailability(boolean whether or not to enable the HA. ha) Enables / disables the high-availability.
public void	setInstances(int the number of instances instances) Sets the number of instance of the verticle to create.
public void	setMainVerticle(String the verticle verticle) Sets the main verticle that is deployed.
public void	setOnRedeployCommand(String command)
public void	setOnRedeployCommandOld(String the on redeploy command command) Deprecated Use 'on-redeploy' instead. It will be removed in vert.x 3.3 Sets the user command executed during redeployment.
public void	setRedeploy(List<String> redeploy)
public void	setRedeployGracePeriod(long period)
public void	setRedeployScanPeriod(long period)
public void	setRedeployStopWaitingTime(long period)
public void	setUp(ExecutionContext - the execution context context) Overrides io.vertx.core.spi.launcher.DefaultCommand.setUp. Implements io.vertx.core.spi.launcher.Command.setUp. Validates the command line parameters.
public void	setWorker(boolean `true` to deploy the verticle as worker, `false` otherwise worker) Whether or not the verticle is deployed as a worker verticle.
protected synchronized void	shutdownRedeployment() Stop the redeployment if started.
protected void	startAsBackgroundApplication(Handler<Void> an optional on-completion handler. If set it must be invoked at the end of this method. onCompletion) On-Deploy action invoked while redeploying.
protected synchronized void	stopBackgroundApplication(Handler<Void> an optional on-completion handler. If set it must be invoked at the end of this method. onCompletion) On-Undeploy action invoked while redeploying.

cluster	back to summary
protected boolean cluster

config	back to summary
protected String config

deploymentOptions	back to summary
protected DeploymentOptions deploymentOptions

ha	back to summary
protected boolean ha

instances	back to summary
protected int instances

mainVerticle	back to summary
protected String mainVerticle

onRedeployCommand	back to summary
protected String onRedeployCommand

redeploy	back to summary
protected List<String> redeploy

redeployGracePeriod	back to summary
private long redeployGracePeriod

redeployScanPeriod	back to summary
private long redeployScanPeriod

redeployTerminationPeriod	back to summary
private long redeployTerminationPeriod

vertxApplicationBackgroundId	back to summary
protected String vertxApplicationBackgroundId

watcher	back to summary
protected Watcher watcher

worker	back to summary
protected boolean worker

RunCommand	back to summary
public RunCommand()

Method Detail

afterConfigParsed	back to summary
protected void afterConfigParsed(JsonObject config) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

afterStoppingVertx	back to summary
protected void afterStoppingVertx()

beforeDeployingVerticle	back to summary
protected void beforeDeployingVerticle(DeploymentOptions deploymentOptions)

beforeStoppingVertx	back to summary
protected void beforeStoppingVertx(Vertx vertx)

close back to summary

close	back to summary
public void close(Promise<Void> completion) Implements io.vertx.core.Closeable.close. Doc from io.vertx.core.Closeable.close. Close this resource, the `completion` promise must be notified when the operation has completed. Parameters completion:Promise<Void> the promise to signal when close has completed Annotations @Override

public void close(Promise<Void> completion)

Implements io.vertx.core.Closeable.close.

Doc from io.vertx.core.Closeable.close.

Close this resource, the completion promise must be notified when the operation has completed.

Parameters

completion:Promise<Void>: the promise to signal when close has completed

Annotations

@Override

deploy	back to summary
protected void deploy()

getConfiguration	back to summary
protected JsonObject getConfiguration() References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

getHA back to summary

getHA	back to summary
public boolean getHA() Overrides io.vertx.core.impl.launcher.commands.BareCommand.getHA. Returns:boolean Doc from io.vertx.core.impl.launcher.commands.BareCommand.getHA. whether or not the vert.x instance should be launched in high-availability mode. This implementation returns `true`. Annotations @Override

public boolean getHA()

Overrides io.vertx.core.impl.launcher.commands.BareCommand.getHA.

Returns:boolean

Doc from io.vertx.core.impl.launcher.commands.BareCommand.getHA.

whether or not the vert.x instance should be launched in high-availability mode. This implementation returns true.

Annotations

@Override

handleDeployFailed	back to summary
private void handleDeployFailed(Throwable cause)

initializeRedeployment	back to summary
protected synchronized void initializeRedeployment() Initializes the redeployment cycle. In "redeploy mode", the application is launched as background, and is restarted after every change. A `Watcher` instance is responsible for monitoring files and triggering the redeployment.

isClustered back to summary

isClustered	back to summary
public boolean isClustered() Overrides io.vertx.core.impl.launcher.commands.BareCommand.isClustered. Returns:boolean whether the `cluster` option or the `ha` option are enabled. Also `true` when a custom launcher modifies the Vert.x options to set `clustered` to `true` Annotations @Override

public boolean isClustered()

Overrides io.vertx.core.impl.launcher.commands.BareCommand.isClustered.

Returns:boolean

whether the cluster option or the ha option are enabled. Also true when a custom launcher modifies the Vert.x options to set `clustered` to true

Annotations

@Override

run	back to summary
public void run() Overrides io.vertx.core.impl.launcher.commands.BareCommand.run. Implements io.vertx.core.spi.launcher.Command.run. Starts vert.x and deploy the verticle. Annotations @Override

run

back to summary

public void run()

Overrides io.vertx.core.impl.launcher.commands.BareCommand.run.

Implements io.vertx.core.spi.launcher.Command.run.

Starts vert.x and deploy the verticle.

Annotations

@Override

setCluster	back to summary
public void setCluster(boolean cluster) Enables / disables the clustering. Parameters cluster:boolean whether or not to start vert.x in clustered mode. Annotations @Option longName:cluster acceptValue:false flag:true @Description:If specified then the vert.x instance will form a cluster with any other vert.x instances on the network.

setCluster

back to summary

public void setCluster(boolean cluster)

Enables / disables the clustering.

Parameters

cluster:boolean: whether or not to start vert.x in clustered mode.

Annotations

@Option
longName:cluster
acceptValue:false
flag:true
@Description:If specified then the vert.x instance will form a cluster with any other vert.x instances on the network.

setConfig	back to summary
public void setConfig(String configuration) The main verticle configuration, it can be a json file or a json string. Parameters configuration:String the configuration Annotations @Option longName:conf argName:config @Description:Specifies configuration that should be provided to the verticle. should reference either a text file containing a valid JSON object which represents the configuration OR be a JSON string.

setConfig

back to summary

public void setConfig(String configuration)

The main verticle configuration, it can be a json file or a json string.

Parameters

configuration:String: the configuration

Annotations

@Option
longName:conf
argName:config
@Description:Specifies configuration that should be provided to the verticle. should reference either a text file containing a valid JSON object which represents the configuration OR be a JSON string.

setHighAvailability	back to summary
public void setHighAvailability(boolean ha) Enables / disables the high-availability. Parameters ha:boolean whether or not to enable the HA. Annotations @Option longName:ha acceptValue:false flag:true @Description:If specified the verticle will be deployed as a high availability (HA) deployment. This means it can fail over to any other nodes in the cluster started with the same HA group.

setHighAvailability

back to summary

public void setHighAvailability(boolean ha)

Enables / disables the high-availability.

Parameters

ha:boolean: whether or not to enable the HA.

Annotations

@Option
longName:ha
acceptValue:false
flag:true
@Description:If specified the verticle will be deployed as a high availability (HA) deployment. This means it can fail over to any other nodes in the cluster started with the same HA group.

setInstances	back to summary
public void setInstances(int instances) Sets the number of instance of the verticle to create. Parameters instances:int the number of instances Annotations @Option longName:instances argName:instances @DefaultValue:1 @Description:Specifies how many instances of the verticle will be deployed. Defaults to 1.

setInstances

back to summary

public void setInstances(int instances)

Sets the number of instance of the verticle to create.

Parameters

instances:int: the number of instances

Annotations

@Option
longName:instances
argName:instances
@DefaultValue:1
@Description:Specifies how many instances of the verticle will be deployed. Defaults to 1.

setMainVerticle	back to summary
public void setMainVerticle(String verticle) Sets the main verticle that is deployed. Parameters verticle:String the verticle Annotations @Argument index:0 argName:main-verticle required:true @Description:The main verticle to deploy, it can be a fully qualified class name or a file.

setMainVerticle

back to summary

public void setMainVerticle(String verticle)

Sets the main verticle that is deployed.

Parameters

verticle:String: the verticle

Annotations

@Argument
index:0
argName:main-verticle
required:true
@Description:The main verticle to deploy, it can be a fully qualified class name or a file.

setOnRedeployCommand	back to summary
public void setOnRedeployCommand(String command) Annotations @Option longName:on-redeploy argName:cmd @Description:Optional shell command executed when a redeployment is triggered

setOnRedeployCommandOld	back to summary
public void setOnRedeployCommandOld(String command) Deprecated Use 'on-redeploy' instead. It will be removed in vert.x 3.3 Sets the user command executed during redeployment. Parameters command:String the on redeploy command Annotations @Option longName:onRedeploy argName:cmd @Description:Optional shell command executed when a redeployment is triggered (deprecated - will be removed in 3.3, use \'on-redeploy\' instead @Hidden @Deprecated

setOnRedeployCommandOld

back to summary

public void setOnRedeployCommandOld(String command)

Deprecated

Use 'on-redeploy' instead. It will be removed in vert.x 3.3

Sets the user command executed during redeployment.

Parameters

command:String: the on redeploy command

Annotations

@Option
longName:onRedeploy
argName:cmd
@Description:Optional shell command executed when a redeployment is triggered (deprecated - will be removed in 3.3, use \'on-redeploy\' instead
@Hidden
@Deprecated

setRedeploy	back to summary
public void setRedeploy(List<String> redeploy) Annotations @Option longName:redeploy argName:includes @Description:Enable automatic redeployment of the application. This option takes a set on includes as parameter indicating which files need to be watched. Patterns are separated by a comma. @ParsedAsList

setRedeployGracePeriod	back to summary
public void setRedeployGracePeriod(long period) Annotations @Option longName:redeploy-grace-period argName:period @Description:When redeploy is enabled, this option configures the grace period between 2 redeployments. The time is given in milliseconds. 1000 ms by default. @DefaultValue:1000

setRedeployScanPeriod	back to summary
public void setRedeployScanPeriod(long period) Annotations @Option longName:redeploy-scan-period argName:period @Description:When redeploy is enabled, this option configures the file system scanning period to detect file changes. The time is given in milliseconds. 250 ms by default. @DefaultValue:250

setRedeployStopWaitingTime	back to summary
public void setRedeployStopWaitingTime(long period) Annotations @Option longName:redeploy-termination-period argName:period @Description:When redeploy is enabled, this option configures the time waited to be sure that the previous version of the application has been stopped. It is useful on Windows, where the \'terminate\' command may take time to be executed.The time is given in milliseconds. 0 ms by default. @DefaultValue:0

setRedeployStopWaitingTime

back to summary

public void setRedeployStopWaitingTime(long period)

Annotations

@Option
longName:redeploy-termination-period
argName:period
@Description:When redeploy is enabled, this option configures the time waited to be sure that the previous version of the application has been stopped. It is useful on Windows, where the \'terminate\' command may take time to be executed.The time is given in milliseconds. 0 ms by default.
@DefaultValue:0

setUp	back to summary
public void setUp(ExecutionContext context) throws CLIException Overrides io.vertx.core.spi.launcher.DefaultCommand.setUp. Implements io.vertx.core.spi.launcher.Command.setUp. Validates the command line parameters. Parameters context:ExecutionContext - the execution context Annotations @Override Exceptions CLIException: - validation failed

setUp

back to summary

public void setUp(ExecutionContext context) throws CLIException

Overrides io.vertx.core.spi.launcher.DefaultCommand.setUp.

Implements io.vertx.core.spi.launcher.Command.setUp.

Validates the command line parameters.

Parameters

context:ExecutionContext: - the execution context

Annotations

@Override

Exceptions

CLIException:: - validation failed

setWorker back to summary

setWorker	back to summary
public void setWorker(boolean worker) Whether or not the verticle is deployed as a worker verticle. Parameters worker:boolean `true` to deploy the verticle as worker, `false` otherwise Annotations @Option longName:worker acceptValue:false @Description:If specified then the verticle is a worker verticle.

public void setWorker(boolean worker)

Whether or not the verticle is deployed as a worker verticle.

Parameters

worker:boolean: true to deploy the verticle as worker, false otherwise

Annotations

@Option
longName:worker
acceptValue:false
@Description:If specified then the verticle is a worker verticle.

shutdownRedeployment	back to summary
protected synchronized void shutdownRedeployment() Stop the redeployment if started.

startAsBackgroundApplication	back to summary
protected void startAsBackgroundApplication(Handler<Void> onCompletion) On-Deploy action invoked while redeploying. It just starts the application in background, copying all input parameters. In addition, the vertx application id is set. Parameters onCompletion:Handler<Void> an optional on-completion handler. If set it must be invoked at the end of this method.

startAsBackgroundApplication

back to summary

protected void startAsBackgroundApplication(Handler<Void> onCompletion)

On-Deploy action invoked while redeploying. It just starts the application in background, copying all input parameters. In addition, the vertx application id is set.

Parameters

onCompletion:Handler<Void>: an optional on-completion handler. If set it must be invoked at the end of this method.

stopBackgroundApplication	back to summary
protected synchronized void stopBackgroundApplication(Handler<Void> onCompletion) On-Undeploy action invoked while redeploying. It just stops the application launched in background. Parameters onCompletion:Handler<Void> an optional on-completion handler. If set it must be invoked at the end of this method.

stopBackgroundApplication

back to summary

protected synchronized void stopBackgroundApplication(Handler<Void> onCompletion)

On-Undeploy action invoked while redeploying. It just stops the application launched in background.

Parameters

onCompletion:Handler<Void>: an optional on-completion handler. If set it must be invoked at the end of this method.

public Class RunCommand

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail