net.kuujo.vertigo.network.impl

Class DefaultNetworkContext

java.lang.Object

net.kuujo.vertigo.impl.BaseContext<NetworkContext>

net.kuujo.vertigo.network.impl.DefaultNetworkContext

All Implemented Interfaces:

Context<NetworkContext>, NetworkContext, Observable<NetworkContext>, JsonSerializable

public class DefaultNetworkContext
extends BaseContext<NetworkContext>
implements NetworkContext

A network context which contains information regarding the complete structure of a deployed network. Network contexts are immutable as they are constructed after a network is deployed.

Author:

Jordan Halterman

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultNetworkContext.Builder Network context builder.

Field Summary

Fields inherited from class net.kuujo.vertigo.impl.BaseContext

address, observers

Method Summary

Methods

Modifier and Type	Method and Description
String	address() Returns the context address.
ClusterContext	cluster() Returns the network's cluster context.
<T extends ComponentContext<T>> T	component(String name) Returns a component context by name.
List<ComponentContext<?>>	components() Returns a list of network component contexts.
NetworkConfig	config() Returns the network configuration from which the context was built.
static DefaultNetworkContext	fromJson(org.vertx.java.core.json.JsonObject context) Creates a network context from JSON.
boolean	hasComponent(String name) Returns a boolean indicating whether the component exists.
String	name() Returns the network name.
void	notify(NetworkContext update)
String	status() Returns the network status address.
static org.vertx.java.core.json.JsonObject	toJson(NetworkContext context) Serializes a network context to JSON.
String	toString()
String	version() Returns the network version.

Methods inherited from class net.kuujo.vertigo.impl.BaseContext

copy, equals, hashCode, registerObserver, unregisterObserver

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.kuujo.vertigo.util.Observable

registerObserver, unregisterObserver

Method Detail

fromJson

public static DefaultNetworkContext fromJson(org.vertx.java.core.json.JsonObject context)

Creates a network context from JSON.

Parameters:

context - A JSON representation of the network context.

Returns:

A new network context instance.

Throws:

MalformedContextException - If the network context is malformed.

toJson

public static org.vertx.java.core.json.JsonObject toJson(NetworkContext context)

Serializes a network context to JSON.

Parameters:

context - The network context to serialize.

Returns:

A serialized network context.

name

public String name()

Description copied from interface: NetworkContext

Returns the network name.

The network name is unique to the network within a Vertigo cluster.

Specified by:

name in interface NetworkContext

Returns:

The network name.

version

public String version()

Description copied from interface: NetworkContext

Returns the network version. Contexts may be updated through network configuration changes, so the version can be used to track updates to the network.

Specified by:

version in interface NetworkContext

Returns:

The network version.

config

public NetworkConfig config()

Description copied from interface: NetworkContext

Returns the network configuration from which the context was built.

Specified by:

config in interface NetworkContext

Returns:

The network configuration.

cluster

public ClusterContext cluster()

Description copied from interface: NetworkContext

Returns the network's cluster context.

Specified by:

cluster in interface NetworkContext

Returns:

The network's cluster context.

address

public String address()

Description copied from interface: Context

Returns the context address.

Specified by:

address in interface Context<NetworkContext>

Returns:

The context address.

status

public String status()

Description copied from interface: NetworkContext

Returns the network status address.

This is the address of a shared-data key that is monitored by all component instances in the cluster. When the key is set, components know that the network is considered stable. During a network configuration change, the network manager will unset the status address, notifying components that the network is no longer stable until the key is reset. This is the mechanism used by Vertigo to perform coordination between components.

Specified by:

status in interface NetworkContext

Returns:

The network status address.

components

public List<ComponentContext<?>> components()

Description copied from interface: NetworkContext

Returns a list of network component contexts.

Specified by:

components in interface NetworkContext

Returns:

A list of network component contexts.

hasComponent

public boolean hasComponent(String name)

Returns a boolean indicating whether the component exists.

Specified by:

hasComponent in interface NetworkContext

Parameters:

name - The name of the component to check.

Returns:

Indicates whether a component with that name exists.

component

public <T extends ComponentContext<T>> T component(String name)

Description copied from interface: NetworkContext

Returns a component context by name.

Specified by:

component in interface NetworkContext

Parameters:

name - The component name.

Returns:

A component context.

notify

public void notify(NetworkContext update)

Specified by:

notify in interface Observable<NetworkContext>

Overrides:

notify in class BaseContext<NetworkContext>

toString

public String toString()

Overrides:

toString in class BaseContext<NetworkContext>