net.kuujo.vertigo.component.impl

Class DefaultComponentCoordinator

java.lang.Object

net.kuujo.vertigo.component.impl.DefaultComponentCoordinator

All Implemented Interfaces:

ComponentCoordinator

public class DefaultComponentCoordinator
extends Object
implements ComponentCoordinator

Default coordinator implementation.

This coordinator implementation uses the current Vertigo cluster facility to coordinate with the network manager using event-based cluster-wide shared data keys.

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
DefaultComponentCoordinator(InstanceContext context, org.vertx.java.core.Vertx vertx, org.vertx.java.platform.Container container)

Method Summary

Methods

Modifier and Type	Method and Description
String	address() Returns the instance address.
ComponentCoordinator	pause() Notifies the network that the component is not ready for operation.
ComponentCoordinator	pause(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Notifies the network that the component is not ready for operation.
ComponentCoordinator	pauseHandler(org.vertx.java.core.Handler<Void> handler) Sets a pause handler on the coordinator.
ComponentCoordinator	resume() Notifies the network that the component is ready to resume.
ComponentCoordinator	resume(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Notifies the network that the component is ready to resume.
ComponentCoordinator	resumeHandler(org.vertx.java.core.Handler<Void> handler) Sets a resume handler on the coordinator.
ComponentCoordinator	start(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<InstanceContext>> doneHandler) Starts the coordinator.
void	stop(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Stops the coordinator.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultComponentCoordinator

public DefaultComponentCoordinator(InstanceContext context,
                           org.vertx.java.core.Vertx vertx,
                           org.vertx.java.platform.Container container)

Method Detail

address

public String address()

Description copied from interface: ComponentCoordinator

Returns the instance address.

Specified by:

address in interface ComponentCoordinator

Returns:

The component instance address.

start

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

Description copied from interface: ComponentCoordinator

Starts the coordinator.

When the coordinator is started the instance context is retrieved from the fault-tolerant cluster. Prior to setup, the component only knows its own address, thus starting the coordinator is essential to component setup.

Specified by:

start in interface ComponentCoordinator

Parameters:

doneHandler - An asynchronous handler to be called once complete. The handler will be called with the current instance context.

Returns:

The coordinator.

resume

public ComponentCoordinator resume()

Description copied from interface: ComponentCoordinator

Notifies the network that the component is ready to resume.

Specified by:

resume in interface ComponentCoordinator

Returns:

The component coordinator.

resume

public ComponentCoordinator resume(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Description copied from interface: ComponentCoordinator

Notifies the network that the component is ready to resume.

Specified by:

resume in interface ComponentCoordinator

Parameters:

doneHandler - An asynchronous handler to be called once the network has been notified.

Returns:

The component coordinator.

pause

public ComponentCoordinator pause()

Description copied from interface: ComponentCoordinator

Notifies the network that the component is not ready for operation.

Specified by:

pause in interface ComponentCoordinator

Returns:

The component coordinator.

pause

public ComponentCoordinator pause(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Description copied from interface: ComponentCoordinator

Notifies the network that the component is not ready for operation.

Specified by:

pause in interface ComponentCoordinator

Parameters:

doneHandler - An asynchronous handler to be called once the network has been notified.

Returns:

The component coordinator.

resumeHandler

public ComponentCoordinator resumeHandler(org.vertx.java.core.Handler<Void> handler)

Description copied from interface: ComponentCoordinator

Sets a resume handler on the coordinator.

This handler will be called when all components in the network are setup and ready to begin processing messages. The network coordinator will make this determination by evaluating component status keys in the cluster.

Specified by:

resumeHandler in interface ComponentCoordinator

Parameters:

handler - A handler to be called when the component should resume operation.

Returns:

The component coordinator.

pauseHandler

public ComponentCoordinator pauseHandler(org.vertx.java.core.Handler<Void> handler)

Description copied from interface: ComponentCoordinator

Sets a pause handler on the coordinator.

This handler will be called when some component somewhere in the network has been paused. When a component is paused, the network manager will notify all component instances that the network is paused until resume.

Specified by:

pauseHandler in interface ComponentCoordinator

Parameters:

handler - A handler to be called when the component should pause operation.

Returns:

The component coordinator.

stop

public void stop(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Description copied from interface: ComponentCoordinator

Stops the coordinator.

Specified by:

stop in interface ComponentCoordinator

Parameters:

doneHandler - An asynchronous handler to be called once complete.