net.kuujo.vertigo.network

Interface NetworkConfig

All Superinterfaces:

Config<NetworkConfig>, JsonSerializable

All Known Implementing Classes:

DefaultNetworkConfig

public interface NetworkConfig
extends Config<NetworkConfig>

Network configuration.

The network configuration defines a collection of components (Vert.x modules and verticles) that can be connected together in a meaningful way.

Author:

Jordan Halterman

Field Summary

Fields

Modifier and Type	Field and Description
static String	NETWORK_CLUSTER cluster is an object defining the network's cluster configuration.
static String	NETWORK_COMPONENTS components is an object defining network component configurations.
static String	NETWORK_NAME name is a string indicating the unique network name.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends ComponentConfig<T>> T	addComponent(String name, String moduleOrMain) Adds a module to the network.
<T extends ComponentConfig<T>> T	addComponent(String name, String moduleOrMain, int instances) Adds a module to the network.
<T extends ComponentConfig<T>> T	addComponent(String name, String moduleOrMain, org.vertx.java.core.json.JsonObject config) Adds a module to the network.
<T extends ComponentConfig<T>> T	addComponent(String name, String moduleOrMain, org.vertx.java.core.json.JsonObject config, int instances) Adds a module or verticle component to the network.
<T extends ComponentConfig> T	addComponent(T component) Adds a component to the network.
ModuleConfig	addModule(ModuleConfig module) Adds a module to the network.
ModuleConfig	addModule(String name, String moduleName) Adds a module to the network.
ModuleConfig	addModule(String name, String moduleName, int instances) Adds a module to the network.
ModuleConfig	addModule(String name, String moduleName, org.vertx.java.core.json.JsonObject config) Adds a module to the network.
ModuleConfig	addModule(String name, String moduleName, org.vertx.java.core.json.JsonObject config, int instances) Adds a module to the network.
VerticleConfig	addVerticle(String name, String main) Adds a verticle to the network.
VerticleConfig	addVerticle(String name, String main, int instances) Adds a verticle to the network.
VerticleConfig	addVerticle(String name, String main, org.vertx.java.core.json.JsonObject config) Adds a verticle to the network.
VerticleConfig	addVerticle(String name, String main, org.vertx.java.core.json.JsonObject config, int instances) Adds a verticle to the network.
VerticleConfig	addVerticle(VerticleConfig verticle) Adds a verticle to the network.
ConnectionConfig	createConnection(ConnectionConfig connection) Creates a connection between two components.
ConnectionConfig	createConnection(String source, String target) Creates a connection between two components.
ConnectionConfig	createConnection(String source, String target, Selector selector) Creates a connection between two components.
ConnectionConfig	createConnection(String source, String out, String target, String in) Creates a connection between two components.
ConnectionConfig	createConnection(String source, String out, String target, String in, Selector selector) Creates a connection between two components.
NetworkConfig	destroyConnection(ConnectionConfig connection) Destroys a connection between two components.
NetworkConfig	destroyConnection(String source, String target) Destroys a connection between two components.
NetworkConfig	destroyConnection(String source, String out, String target, String in) Destroys a connection between two components.
ClusterConfig	getClusterConfig() Returns the network's cluster configuration.
<T extends ComponentConfig<T>> T	getComponent(String name) Gets a component by name.
List<ComponentConfig<?>>	getComponents() Gets a list of network components.
Collection<ConnectionConfig>	getConnections() Returns a collection of network connections.
String	getName() Returns the network name.
boolean	hasComponent(String name) Returns a boolean indicating whether the network has a component.
<T extends ComponentConfig<T>> T	removeComponent(String name) Removes a component from the network.
<T extends ComponentConfig<T>> T	removeComponent(T component) Removes a component from the network.
ModuleConfig	removeModule(ModuleConfig module) Removes a module from the network.
ModuleConfig	removeModule(String name) Removes a module from the network.
VerticleConfig	removeVerticle(String name) Removes a verticle configuration from the network.
VerticleConfig	removeVerticle(VerticleConfig verticle) Removes a verticle configuration from the network.
NetworkConfig	setClusterConfig(ClusterConfig cluster) Sets the network's cluster configuration.

Field Detail

NETWORK_NAME

static final String NETWORK_NAME

name is a string indicating the unique network name. This is the address at which the network will monitor network components. This field is required.

See Also:

Constant Field Values

NETWORK_CLUSTER

static final String NETWORK_CLUSTER

cluster is an object defining the network's cluster configuration.

See Also:

Constant Field Values

NETWORK_COMPONENTS

static final String NETWORK_COMPONENTS

components is an object defining network component configurations. Each item in the object must be keyed by the unique component address, with each item being an object containing the component configuration. See the ComponentConfig class for component configuration options.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the network name. This is the event bus address at which the network's coordinator will register a handler for components to connect to once deployed.

Returns:

The network name.

setClusterConfig

NetworkConfig setClusterConfig(ClusterConfig cluster)

Sets the network's cluster configuration.

Parameters:

cluster - The cluster configuration.

Returns:

The network configuration.

getClusterConfig

ClusterConfig getClusterConfig()

Returns the network's cluster configuration.

Returns:

The network's cluster configuration.

getComponents

List<ComponentConfig<?>> getComponents()

Gets a list of network components.

Returns:

A list of network components.

getComponent

<T extends ComponentConfig<T>> T getComponent(String name)

Gets a component by name.

Parameters:

name - The component name.

Returns:

The component configuration.

Throws:

IllegalArgumentException - If the given component address does not exist within the network.

hasComponent

boolean hasComponent(String name)

Returns a boolean indicating whether the network has a component.

Parameters:

name - The component name.

Returns:

Indicates whether the component exists in the network.

addComponent

<T extends ComponentConfig> T addComponent(T component)

Adds a component to the network.

Parameters:

component - The component to add.

Returns:

The added component configuration.

addComponent

<T extends ComponentConfig<T>> T addComponent(String name,
                                            String moduleOrMain)

Adds a module to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

moduleName - The module name.

Returns:

The new module configuration.

Throws:

IllegalArgumentException - If the module name is not a valid module identifier.

addComponent

<T extends ComponentConfig<T>> T addComponent(String name,
                                            String moduleOrMain,
                                            org.vertx.java.core.json.JsonObject config)

Adds a module to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

moduleName - The module name.

config - The module configuration. This configuration will be made available as the verticle configuration within deployed module instances.

Returns:

The new module configuration.

Throws:

IllegalArgumentException - If the module name is not a valid module identifier.

addComponent

<T extends ComponentConfig<T>> T addComponent(String name,
                                            String moduleOrMain,
                                            int instances)

Adds a module to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

moduleName - The module name.

instances - The number of module instances. If multiple instances are defined, groupings will be used to determine how messages are distributed between multiple component instances.

Returns:

The new module configuration.

Throws:

IllegalArgumentException - If the module name is not a valid module identifier.

addComponent

<T extends ComponentConfig<T>> T addComponent(String name,
                                            String moduleOrMain,
                                            org.vertx.java.core.json.JsonObject config,
                                            int instances)

Adds a module or verticle component to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

moduleOrMain - The component module name or verticle main.

config - The component configuration. This configuration will be made available as the verticle configuration within deployed module instances.

instances - The number of component instances. If multiple instances are defined, groupings will be used to determine how messages are distributed between multiple component instances.

Returns:

The new module configuration.

removeComponent

<T extends ComponentConfig<T>> T removeComponent(T component)

Removes a component from the network.

Parameters:

component - The component to remove.

Returns:

The removed component configuration.

removeComponent

<T extends ComponentConfig<T>> T removeComponent(String name)

Removes a component from the network.

Parameters:

name - The component name.

Returns:

The removed component configuration.

addModule

ModuleConfig addModule(ModuleConfig module)

Adds a module to the network.

Parameters:

module - The module to add.

Returns:

The added module component configuration.

addModule

ModuleConfig addModule(String name,
                     String moduleName)

Adds a module to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

moduleName - The module name.

Returns:

The new module configuration.

Throws:

IllegalArgumentException - If the module name is not a valid module identifier.

addModule

ModuleConfig addModule(String name,
                     String moduleName,
                     org.vertx.java.core.json.JsonObject config)

Adds a module to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

moduleName - The module name.

config - The module configuration. This configuration will be made available as the verticle configuration within deployed module instances.

Returns:

The new module configuration.

Throws:

IllegalArgumentException - If the module name is not a valid module identifier.

addModule

ModuleConfig addModule(String name,
                     String moduleName,
                     int instances)

Adds a module to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

moduleName - The module name.

instances - The number of module instances. If multiple instances are defined, groupings will be used to determine how messages are distributed between multiple component instances.

Returns:

The new module configuration.

Throws:

IllegalArgumentException - If the module name is not a valid module identifier.

addModule

ModuleConfig addModule(String name,
                     String moduleName,
                     org.vertx.java.core.json.JsonObject config,
                     int instances)

Adds a module to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

moduleName - The module name.

config - The module configuration. This configuration will be made available as the verticle configuration within deployed module instances.

instances - The number of module instances. If multiple instances are defined, groupings will be used to determine how messages are distributed between multiple component instances.

Returns:

The new module configuration.

Throws:

IllegalArgumentException - If the module name is not a valid module identifier.

removeModule

ModuleConfig removeModule(ModuleConfig module)

Removes a module from the network.

Parameters:

module - The module component.

Returns:

The removed module configuration.

removeModule

ModuleConfig removeModule(String name)

Removes a module from the network.

Parameters:

name - The module component name.

Returns:

The removed module configuration.

addVerticle

VerticleConfig addVerticle(VerticleConfig verticle)

Adds a verticle to the network.

Parameters:

verticle - The verticle to add.

Returns:

The added verticle component configuration.

addVerticle

VerticleConfig addVerticle(String name,
                         String main)

Adds a verticle to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

main - The verticle main.

Returns:

The new verticle configuration.

addVerticle

VerticleConfig addVerticle(String name,
                         String main,
                         org.vertx.java.core.json.JsonObject config)

Adds a verticle to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

main - The verticle main.

config - The verticle configuration. This configuration will be made available as the verticle configuration within deployed module instances.

Returns:

The new verticle configuration.

addVerticle

VerticleConfig addVerticle(String name,
                         String main,
                         int instances)

Adds a verticle to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

main - The verticle main.

instances - The number of verticle instances. If multiple instances are defined, groupings will be used to determine how messages are distributed between multiple component instances.

Returns:

The new verticle configuration.

addVerticle

VerticleConfig addVerticle(String name,
                         String main,
                         org.vertx.java.core.json.JsonObject config,
                         int instances)

Adds a verticle to the network.

Parameters:

name - The component name. This will be used as the basis for internal component addresses.

main - The verticle main.

config - The verticle configuration. This configuration will be made available as the verticle configuration within deployed module instances.

instances - The number of verticle instances. If multiple instances are defined, groupings will be used to determine how messages are distributed between multiple component instances.

Returns:

The new verticle configuration.

removeVerticle

VerticleConfig removeVerticle(VerticleConfig verticle)

Removes a verticle configuration from the network.

Parameters:

verticle - The verticle component.

Returns:

The removed verticle configuration.

removeVerticle

VerticleConfig removeVerticle(String name)

Removes a verticle configuration from the network.

Parameters:

name - The verticle component name.

Returns:

The removed verticle configuration.

getConnections

Collection<ConnectionConfig> getConnections()

Returns a collection of network connections.

Returns:

A collection of connections in the network.

createConnection

ConnectionConfig createConnection(ConnectionConfig connection)

Creates a connection between two components.

Parameters:

connection - The new connection.

Returns:

The connection instance.

createConnection

ConnectionConfig createConnection(String source,
                                String target)

Creates a connection between two components.

Parameters:

source - The source component.

target - The target component.

Returns:

A new connection instance.

createConnection

ConnectionConfig createConnection(String source,
                                String target,
                                Selector selector)

Creates a connection between two components.

Parameters:

source - The source component.

target - The target component.

selector - The connection selector.

Returns:

A new connection instance.

createConnection

ConnectionConfig createConnection(String source,
                                String out,
                                String target,
                                String in)

Creates a connection between two components.

Parameters:

source - The source component.

out - The source output port.

target - The target component.

in - The target output port.

Returns:

A new connection instance.

createConnection

ConnectionConfig createConnection(String source,
                                String out,
                                String target,
                                String in,
                                Selector selector)

Creates a connection between two components.

Parameters:

source - The source component.

out - The source output port.

target - The target component.

in - The target output port.

selector - The connection selector.

Returns:

A new connection instance.

destroyConnection

NetworkConfig destroyConnection(ConnectionConfig connection)

Destroys a connection between two components.

Parameters:

connection - The connection to destroy.

Returns:

The network configuration.

destroyConnection

NetworkConfig destroyConnection(String source,
                              String target)

Destroys a connection between two components.

Parameters:

source - The source component name and port.

target - The target component name and port.

Returns:

The network configuration.

destroyConnection

NetworkConfig destroyConnection(String source,
                              String out,
                              String target,
                              String in)

Destroys a connection between two components.

Parameters:

source - The source component name.

out - The source component out port.

target - The target component name.

in - The target component in port.

Returns:

The network configuration.