net.kuujo.vertigo.component.impl

Class DefaultInstanceContext

java.lang.Object

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

net.kuujo.vertigo.component.impl.DefaultInstanceContext

All Implemented Interfaces:

InstanceContext, Context<InstanceContext>, Observable<InstanceContext>, JsonSerializable

public final class DefaultInstanceContext
extends BaseContext<InstanceContext>
implements InstanceContext

A component instance context which contains information regarding a specific component (module or verticle) instance within a network.

Author:

Jordan Halterman

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultInstanceContext.Builder Instance context builder.

Field Summary

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

address, observers, version

Method Summary

Methods

Modifier and Type	Method and Description
String	address() Returns the instance address.
<T extends ComponentContext> T	component() Returns the parent component context.
static DefaultInstanceContext	fromJson(org.vertx.java.core.json.JsonObject context) Creates a new instance context from JSON.
InputContext	input() Returns the instance input context.
void	notify(InstanceContext update)
int	number() Returns the instance number.
OutputContext	output() Returns the instance output context.
String	status() Returns the instance status address.
static org.vertx.java.core.json.JsonObject	toJson(InstanceContext context) Serializes an instance context to JSON.
String	toString()

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 DefaultInstanceContext fromJson(org.vertx.java.core.json.JsonObject context)

Creates a new instance context from JSON.

Parameters:

context - A JSON representation of the instance context.

Returns:

A new instance context instance.

Throws:

MalformedContextException - If the JSON context is malformed.

toJson

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

Serializes an instance context to JSON.

Parameters:

context - The instance context to serialize.

Returns:

A Json representation of the instance context.

number

public int number()

Description copied from interface: InstanceContext

Returns the instance number.

Specified by:

number in interface InstanceContext

Returns:

The instance number.

address

public String address()

Description copied from interface: InstanceContext

Returns the instance address.

This is simply a unique identifier used to identify the component across all networks.

Specified by:

address in interface InstanceContext

Specified by:

address in interface Context<InstanceContext>

Returns:

The instance address.

status

public String status()

Description copied from interface: InstanceContext

Returns the instance status address.

The status address is used by the component instance to notify the network and other components within the network of its current status. This is used by the network manager to coordinate startup of components across a network.

Specified by:

status in interface InstanceContext

Returns:

The instance status address.

input

public InputContext input()

Description copied from interface: InstanceContext

Returns the instance input context.

Specified by:

input in interface InstanceContext

Returns:

The instance input context.

output

public OutputContext output()

Description copied from interface: InstanceContext

Returns the instance output context.

Specified by:

output in interface InstanceContext

Returns:

The instance output context.

component

public <T extends ComponentContext> T component()

Description copied from interface: InstanceContext

Returns the parent component context.

Specified by:

component in interface InstanceContext

Returns:

The parent component context.

notify

public void notify(InstanceContext update)

Specified by:

notify in interface Observable<InstanceContext>

Overrides:

notify in class BaseContext<InstanceContext>

toString

public String toString()

Overrides:

toString in class BaseContext<InstanceContext>