net.kuujo.vertigo.component.impl

Class DefaultComponent

java.lang.Object

net.kuujo.vertigo.component.impl.DefaultComponent

All Implemented Interfaces:

Component

public class DefaultComponent
extends Object
implements Component

A default component implementation.

This component implementation simply handles startup of component inputs and outputs and provides an interface to access messaging APIs.

Author:

Jordan Halterman

Field Summary

Fields

Modifier and Type	Field and Description
protected Cluster	cluster
protected org.vertx.java.platform.Container	container
protected InstanceContext	context
protected DefaultInputCollector	input
protected org.vertx.java.core.logging.Logger	logger
protected DefaultOutputCollector	output
protected org.vertx.java.core.Vertx	vertx

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultComponent(InstanceContext context, org.vertx.java.core.Vertx vertx, org.vertx.java.platform.Container container, Cluster cluster)

Method Summary

Methods

Modifier and Type	Method and Description
Cluster	cluster() Returns the cluster to which the component belongs.
org.vertx.java.platform.Container	container() Gets the component container instance.
InstanceContext	context() Returns the component instance context.
InputCollector	input() Returns the component's InputCollector.
org.vertx.java.core.logging.Logger	logger() Returns the instance logger.
OutputCollector	output() Returns the component's OutputCollector.
Component	start() Starts the component.
Component	start(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Component>> doneHandler) Starts the component.
org.vertx.java.core.Vertx	vertx() Gets the component Vertx instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

vertx

protected final org.vertx.java.core.Vertx vertx

container

protected final org.vertx.java.platform.Container container

cluster

protected final Cluster cluster

logger

protected final org.vertx.java.core.logging.Logger logger

context

protected InstanceContext context

input

protected final DefaultInputCollector input

output

protected final DefaultOutputCollector output

Constructor Detail

DefaultComponent

protected DefaultComponent(InstanceContext context,
                org.vertx.java.core.Vertx vertx,
                org.vertx.java.platform.Container container,
                Cluster cluster)

Method Detail

vertx

public org.vertx.java.core.Vertx vertx()

Description copied from interface: Component

Gets the component Vertx instance.

Specified by:

vertx in interface Component

Returns:

The component Vertx instance.

container

public org.vertx.java.platform.Container container()

Description copied from interface: Component

Gets the component container instance.

Specified by:

container in interface Component

Returns:

The component container instance.

input

public InputCollector input()

Description copied from interface: Component

Returns the component's InputCollector. This is the element of the component which provides an interface for receiving messages from other components.

Specified by:

input in interface Component

Returns:

The components InputCollector.

output

public OutputCollector output()

Description copied from interface: Component

Returns the component's OutputCollector. This is the element of the component which provides an interface for sending messages to other components.

Specified by:

output in interface Component

Returns:

The component's OutputCollector.

context

public InstanceContext context()

Description copied from interface: Component

Returns the component instance context. The instance context can be used to retrieve useful information about an entire network.

Specified by:

context in interface Component

Returns:

The instance context.

cluster

public Cluster cluster()

Description copied from interface: Component

Returns the cluster to which the component belongs.

The cluster type is dependent upon the method by which the component's network was deployed. If the network was deployed in local-mode then the cluster will be locally supported. If the network was deployed in cluster-mode then the cluster will be backed by fault-tolerant data structures.

Specified by:

cluster in interface Component

Returns:

The cluster to which the component belongs.

logger

public org.vertx.java.core.logging.Logger logger()

Description copied from interface: Component

Returns the instance logger. This is a special logger that references the Vertigo component instance and can allow for fine grained control of logging within Vertigo components.

Specified by:

logger in interface Component

Returns:

The logger for the component instance.

start

public Component start()

Description copied from interface: Component

Starts the component. When the component is started, the component will use a ComponentCoordinator to retrieve its context from the current cluster context. This means that input and output connections are not set up until the component has been started.

Specified by:

start in interface Component

Returns:

The component instance.

start

public Component start(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Component>> doneHandler)

Description copied from interface: Component

Starts the component.

When the component is started, the component will use a ComponentCoordinator to retrieve its context from the current cluster context. This means that input and output connections are not set up until the component has been started.

Specified by:

start in interface Component

Parameters:

doneHandler - An asynchronous handler to be called once the component is started.

Returns:

The component instance.