BareCommand (Vertx Javadocs 4.0.3.GA API)

java.lang.Object
- io.vertx.core.spi.launcher.DefaultCommand
- - io.vertx.core.impl.launcher.commands.ClasspathHandler
  - - io.vertx.core.impl.launcher.commands.BareCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

RunCommand
```
public class BareCommand
extends ClasspathHandler
```
Command to create a bare instance of vert.x.

Author:

Clement Escoffier

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`clusterHost`
`protected int`	`clusterPort`
`protected String`	`clusterPublicHost`
`protected int`	`clusterPublicPort`
`static String`	`DEPLOYMENT_OPTIONS_PROP_PREFIX`
`protected Runnable`	`finalAction`
`protected String`	`haGroup`
`static String`	`METRICS_OPTIONS_PROP_PREFIX`
`protected VertxOptions`	`options`
`protected int`	`quorum`
`protected Vertx`	`vertx`
`static String`	`VERTX_EVENTBUS_PROP_PREFIX`
`static String`	`VERTX_OPTIONS_PROP_PREFIX`
`protected String`	`vertxOptions`

Fields inherited from class io.vertx.core.impl.launcher.commands.ClasspathHandler
classpath, log, manager, PATH_SEP

Fields inherited from class io.vertx.core.spi.launcher.DefaultCommand
executionContext, out, systemProperties

Constructor Summary

Constructors
Constructor and Description

BareCommand()

Constructors
Constructor and Description
`BareCommand()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected static void`	`addShutdownHook(Vertx vertx, Logger log, Runnable action)` Registers a shutdown hook closing the given vert.x instance when the JVM is terminating.
`protected void`	`afterStartingVertx(Vertx instance)` Hook called after starting vert.x.
`protected void`	`beforeStartingVertx(VertxOptions options)` Hook called before starting vert.x.
`static void`	`configureFromSystemProperties(Object options, String prefix)` This is used as workaround to retain the existing behavior of the Vert.x CLI and won't be executed in other situation.
`protected String`	`getDefaultAddress()` Deprecated. as of 4.0, this method is no longer used.
`protected EventBusOptions`	`getEventBusOptions()`
`protected EventBusOptions`	`getEventBusOptions(JsonObject jsonObject)`
`boolean`	`getHA()`
`protected JsonObject`	`getJsonFromFileOrString(String jsonFileOrString, String argName)`
`static Runnable`	`getTerminationRunnable(Vertx vertx, Logger log, Runnable action)` Gets the termination runnable used to close the Vert.x instance.
`boolean`	`isClustered()`
`void`	`run()` Starts the vert.x instance.
`void`	`run(Runnable action)` Starts the vert.x instance and sets the final action (called when vert.x is closed).
`void`	`setClusterHost(String host)` Sets the cluster host.
`void`	`setClusterPort(int port)` Sets the cluster port.
`void`	`setClusterPublicHost(String host)` Sets the cluster public host.
`void`	`setClusterPublicPort(int port)` Sets the cluster public port.
`void`	`setExecutionContext(ExecutionContext context)` For testing purpose only.
`void`	`setHAGroup(String group)` Sets the HA group name.
`void`	`setQuorum(int quorum)` Sets the quorum option.
`void`	`setVertxOptions(String vertxOptions)` The Vert.x options, it can be a json file or a json string.
`protected Vertx`	`startVertx()` Starts the vert.x instance.
`Vertx`	`vertx()`

Methods inherited from class io.vertx.core.impl.launcher.commands.ClasspathHandler
create, create, createClassloader, deploy, newInstance, setClasspath

Methods inherited from class io.vertx.core.spi.launcher.DefaultCommand
applySystemProperties, getCwd, out, setCwd, setSystemProps, setUp, tearDown

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERTX_OPTIONS_PROP_PREFIX
```
public static final String VERTX_OPTIONS_PROP_PREFIX
```
    See Also:
    
    Constant Field Values
  - VERTX_EVENTBUS_PROP_PREFIX
```
public static final String VERTX_EVENTBUS_PROP_PREFIX
```
    See Also:
    
    Constant Field Values
  - DEPLOYMENT_OPTIONS_PROP_PREFIX
```
public static final String DEPLOYMENT_OPTIONS_PROP_PREFIX
```
    See Also:
    
    Constant Field Values
  - METRICS_OPTIONS_PROP_PREFIX
```
public static final String METRICS_OPTIONS_PROP_PREFIX
```
    See Also:
    
    Constant Field Values
  - vertx
```
protected Vertx vertx
```
  - clusterPort
```
protected int clusterPort
```
  - clusterHost
```
protected String clusterHost
```
  - clusterPublicPort
```
protected int clusterPublicPort
```
  - clusterPublicHost
```
protected String clusterPublicHost
```
  - quorum
```
protected int quorum
```
  - haGroup
```
protected String haGroup
```
  - vertxOptions
```
protected String vertxOptions
```
  - options
```
protected VertxOptions options
```
  - finalAction
```
protected Runnable finalAction
```
- Constructor Detail
  - BareCommand
```
public BareCommand()
```
- Method Detail
  - setQuorum
```
public void setQuorum(int quorum)
```
    Sets the quorum option.
    
    Parameters:
    
    quorum - the quorum, default to 1.
  - setHAGroup
```
public void setHAGroup(String group)
```
    Sets the HA group name.
    
    Parameters:
    
    group - the name of the group, default to __DEFAULT__.
  - setClusterPort
```
public void setClusterPort(int port)
```
    Sets the cluster port.
    
    Parameters:
    
    port - the port
  - setClusterHost
```
public void setClusterHost(String host)
```
    Sets the cluster host.
    
    Parameters:
    
    host - the cluster host
  - setClusterPublicPort
```
public void setClusterPublicPort(int port)
```
    Sets the cluster public port.
    
    Parameters:
    
    port - the port
  - setClusterPublicHost
```
public void setClusterPublicHost(String host)
```
    Sets the cluster public host.
    
    Parameters:
    
    host - the host
  - setVertxOptions
```
public void setVertxOptions(String vertxOptions)
```
    The Vert.x options, it can be a json file or a json string.
    
    Parameters:
    
    vertxOptions - the configuration
  - isClustered
```
public boolean isClustered()
```
    Returns:
    
    whether or not the vert.x instance should be clustered. This implementation returns true.
  - getHA
```
public boolean getHA()
```
    Returns:
    
    whether or not the vert.x instance should be launched in high-availability mode. This implementation returns true.
  - run
```
public void run()
```
    Starts the vert.x instance.
  - run
```
public void run(Runnable action)
```
    Starts the vert.x instance and sets the final action (called when vert.x is closed).
    
    Parameters:
    
    action - the action, can be null
  - startVertx
```
protected Vertx startVertx()
```
    Starts the vert.x instance.
    
    Returns:
    
    the created instance of vert.x
  - getJsonFromFileOrString
```
protected JsonObject getJsonFromFileOrString(String jsonFileOrString,
                                             String argName)
```
  - afterStartingVertx
```
protected void afterStartingVertx(Vertx instance)
```
    Hook called after starting vert.x.
    
    Parameters:
    
    instance - the created vert.x instance.
  - beforeStartingVertx
```
protected void beforeStartingVertx(VertxOptions options)
```
    Hook called before starting vert.x.
    
    Parameters:
    
    options - the deployment options
  - getEventBusOptions
```
protected EventBusOptions getEventBusOptions()
```
    Returns:
    
    the event bus options.
  - getEventBusOptions
```
protected EventBusOptions getEventBusOptions(JsonObject jsonObject)
```
    Returns:
    
    the event bus options.
  - configureFromSystemProperties
```
public static void configureFromSystemProperties(Object options,
                                                 String prefix)
```
    This is used as workaround to retain the existing behavior of the Vert.x CLI and won't be executed in other situation.
  - addShutdownHook
```
protected static void addShutdownHook(Vertx vertx,
                                      Logger log,
                                      Runnable action)
```
    Registers a shutdown hook closing the given vert.x instance when the JVM is terminating. Optionally, an action can be executed after the termination of the Vertx instance.
    
    Parameters:
    
    vertx - the vert.x instance, must not be null
    
    log - the log, must not be null
    
    action - the action, may be null
  - getTerminationRunnable
```
public static Runnable getTerminationRunnable(Vertx vertx,
                                              Logger log,
                                              Runnable action)
```
    Gets the termination runnable used to close the Vert.x instance.
    
    Parameters:
    
    vertx - the vert.x instance, must not be null
    
    log - the log, must not be null
    
    action - the action, may be null
  - getDefaultAddress
```
@Deprecated
protected String getDefaultAddress()
```
    Deprecated. as of 4.0, this method is no longer used.
    
    Returns:
    
    Get default interface to use since the user hasn't specified one.
  - setExecutionContext
```
public void setExecutionContext(ExecutionContext context)
```
    For testing purpose only.
    
    Parameters:
    
    context - the context to inject for testing.
  - vertx
```
public Vertx vertx()
```
    Returns:
    
    the vert.x instance if created.

Class BareCommand

Field Summary

Fields inherited from class io.vertx.core.impl.launcher.commands.ClasspathHandler

Fields inherited from class io.vertx.core.spi.launcher.DefaultCommand

Constructor Summary

Method Summary

Methods inherited from class io.vertx.core.impl.launcher.commands.ClasspathHandler

Methods inherited from class io.vertx.core.spi.launcher.DefaultCommand

Methods inherited from class java.lang.Object

Field Detail

VERTX_OPTIONS_PROP_PREFIX

VERTX_EVENTBUS_PROP_PREFIX

DEPLOYMENT_OPTIONS_PROP_PREFIX

METRICS_OPTIONS_PROP_PREFIX

vertx

clusterPort

clusterHost

clusterPublicPort

clusterPublicHost

quorum

haGroup

vertxOptions

options

finalAction

Constructor Detail

BareCommand

Method Detail

setQuorum

setHAGroup

setClusterPort

setClusterHost

setClusterPublicPort

setClusterPublicHost

setVertxOptions

isClustered

getHA

run

run

startVertx

getJsonFromFileOrString

afterStartingVertx

beforeStartingVertx

getEventBusOptions

getEventBusOptions

configureFromSystemProperties

addShutdownHook

getTerminationRunnable

getDefaultAddress

setExecutionContext

vertx