net.kuujo.vertigo.network

Interface NetworkContext

All Superinterfaces:

Context<NetworkContext>, JsonSerializable, Observable<NetworkContext>

All Known Implementing Classes:

DefaultNetworkContext

public interface NetworkContext
extends Context<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

Method Summary

Methods

Modifier and Type	Method and Description
<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.
boolean	hasComponent(String name) Returns a boolean indicating whether the component exists.
String	name() Returns the network name.
String	status() Returns the network status address.
String	version() Returns the network version.

Methods inherited from interface net.kuujo.vertigo.Context

address

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

notify, registerObserver, unregisterObserver

Method Detail

name

String name()

Returns the network name.

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

Returns:

The network name.

version

String version()

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

Returns:

The network version.

config

NetworkConfig config()

Returns the network configuration from which the context was built.

Returns:

The network configuration.

status

String status()

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.

Returns:

The network status address.

components

List<ComponentContext<?>> components()

Returns a list of network component contexts.

Returns:

A list of network component contexts.

hasComponent

boolean hasComponent(String name)

Returns a boolean indicating whether the component exists.

Parameters:

name - The name of the component to check.

Returns:

Indicates whether a component with that name exists.

component

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

Returns a component context by name.

Parameters:

name - The component name.

Returns:

A component context.

Throws:

IllegalArgumentException - If a component does not exist at the given name.