net.kuujo.vertigo.component

Interface ComponentConfig<T extends ComponentConfig<T>>

All Superinterfaces:

Config<T>, JsonSerializable

All Known Subinterfaces:

ModuleConfig, VerticleConfig

All Known Implementing Classes:

DefaultModuleConfig, DefaultVerticleConfig

public interface ComponentConfig<T extends ComponentConfig<T>>
extends Config<T>

Components are synonymous with Vert.x modules and verticles. Each component can have its own configuration and any number of instances.

Author:

Jordan Halterman

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ComponentConfig.Type Component type.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_CONFIG config is an object defining the configuration to pass to each instance of the component.
static String	COMPONENT_GROUP group is a component deployment group for HA.
static String	COMPONENT_HOOKS hooks is an array defining component hooks.
static String	COMPONENT_NAME name is a string indicating the network unique component name.
static String	COMPONENT_NUM_INSTANCES instances is a number indicating the number of instances of the component to deploy.
static String	COMPONENT_TYPE type is a string indicating the type of component that will be deployed.
static String	COMPONENT_TYPE_MODULE module is the module component type.
static String	COMPONENT_TYPE_VERTICLE verticle is the verticle component type.

Method Summary

Methods

Modifier and Type	Method and Description
T	addHook(ComponentHook hook) Adds a hook to the component.
org.vertx.java.core.json.JsonObject	getConfig() Returns the component configuration.
String	getGroup() Returns the component deployment group.
List<ComponentHook>	getHooks() Returns a list of component hooks.
int	getInstances() Returns the number of component instances to deploy within the network.
String	getName() Returns the component name.
ComponentConfig.Type	getType() Returns the component type.
T	setConfig(org.vertx.java.core.json.JsonObject config) Sets the component configuration.
T	setGroup(String group) Sets the component deployment group.
T	setInstances(int instances) Sets the number of component instances to deploy within the network.
T	setName(String name) Sets the component name.

Field Detail

COMPONENT_NAME

static final String COMPONENT_NAME

name is a string indicating the network unique component name. This name is used as the basis for generating unique event bus addresses.

See Also:

Constant Field Values

COMPONENT_TYPE

static final String COMPONENT_TYPE

type is a string indicating the type of component that will be deployed. This can be either module or verticle. This field is required.

See Also:

Constant Field Values

COMPONENT_TYPE_MODULE

static final String COMPONENT_TYPE_MODULE

module is the module component type.

See Also:

Constant Field Values

COMPONENT_TYPE_VERTICLE

static final String COMPONENT_TYPE_VERTICLE

verticle is the verticle component type.

See Also:

Constant Field Values

COMPONENT_CONFIG

static final String COMPONENT_CONFIG

config is an object defining the configuration to pass to each instance of the component. If no configuration is provided then an empty configuration will be passed to component instances.

See Also:

Constant Field Values

COMPONENT_NUM_INSTANCES

static final String COMPONENT_NUM_INSTANCES

instances is a number indicating the number of instances of the component to deploy. Defaults to 1

See Also:

Constant Field Values

COMPONENT_GROUP

static final String COMPONENT_GROUP

group is a component deployment group for HA. This option applies when deploying the network to a cluster.

See Also:

Constant Field Values

COMPONENT_HOOKS

static final String COMPONENT_HOOKS

hooks is an array defining component hooks. Each element in the array must be an object containing a hook field which indicates the hook class name.

See Also:

Constant Field Values

Method Detail

getType

ComponentConfig.Type getType()

Returns the component type.

Returns:

The component type.

getName

String getName()

Returns the component name.

Returns:

The component name.

setName

T setName(String name)

Sets the component name.

Parameters:

name - The component name.

Returns:

The component configuration.

getConfig

org.vertx.java.core.json.JsonObject getConfig()

Returns the component configuration.

Returns:

The component configuration.

setConfig

T setConfig(org.vertx.java.core.json.JsonObject config)

Sets the component configuration.

This configuration will be passed to component implementations as the verticle or module configuration when the component is started.

Parameters:

config - The component configuration.

Returns:

The component configuration.

getInstances

int getInstances()

Returns the number of component instances to deploy within the network.

Returns:

The number of component instances.

setInstances

T setInstances(int instances)

Sets the number of component instances to deploy within the network.

Parameters:

instances - The number of component instances.

Returns:

The component configuration.

setGroup

T setGroup(String group)

Sets the component deployment group.

Parameters:

group - The component deployment group.

Returns:

The component configuration.

getGroup

String getGroup()

Returns the component deployment group.

Returns:

The component deployment group.

addHook

T addHook(ComponentHook hook)

Adds a hook to the component.

Parameters:

hook - The hook to add.

Returns:

The component configuration.

getHooks

List<ComponentHook> getHooks()

Returns a list of component hooks.

Returns:

A list of component hooks.