DefaultComponentContext (Vertigo Core 0.7.0-beta1 API)

java.lang.Object
- net.kuujo.vertigo.impl.BaseContext<T>
- - net.kuujo.vertigo.component.impl.DefaultComponentContext<T>

All Implemented Interfaces:

ComponentContext<T>, Context<T>, Observable<T>, JsonSerializable

Direct Known Subclasses:

DefaultModuleContext, DefaultVerticleContext
```
public abstract class DefaultComponentContext<T extends ComponentContext<T>>
extends BaseContext<T>
implements ComponentContext<T>
```
A component context which contains information regarding each component instance within a single network component. Contexts are immutable as they are constructed once a network has been deployed.

Author:

Jordan Halterman

Nested Class Summary
- Nested classes/interfaces inherited from class net.kuujo.vertigo.impl.BaseContext
  BaseContext.Builder<T extends BaseContext.Builder<T,U>,U extends BaseContext>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`config`
`protected String`	`group`
`protected List<ComponentHook>`	`hooks`
`protected List<InstanceContext>`	`instances`
`protected String`	`name`
`protected String`	`status`

Fields inherited from class net.kuujo.vertigo.impl.BaseContext
address, observers, version

Constructor Summary

Constructors
Constructor and Description

DefaultComponentContext()

Constructors
Constructor and Description
`DefaultComponentContext()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`address()` Gets the unique component address.
`ModuleContext`	`asModule()` Returns the component context as a module context.
`VerticleContext`	`asVerticle()` Returns the component context as a verticle context.
`org.vertx.java.core.json.JsonObject`	`config()` Gets the component configuration.
`static <T extends DefaultComponentContext<T>> T`	`fromJson(org.vertx.java.core.json.JsonObject context)` Creates a component context from JSON.
`String`	`group()` Returns the component deployment group.
`List<ComponentHook>`	`hooks()` Returns a list of component hooks.
`InstanceContext`	`instance(int instanceNumber)` Gets a component instance context by instance ID.
`InstanceContext`	`instance(String address)` Gets a component instance context by instance address.
`List<InstanceContext>`	`instances()` Gets a list of all component instance contexts.
`boolean`	`isModule()` Returns a boolean indicating whether the component is a module.
`boolean`	`isVerticle()` Returns a boolean indicating whether the component is a verticle.
`String`	`name()` Reurns the component name.
`DefaultNetworkContext`	`network()` Returns the parent network context.
`void`	`notify(T update)`
`int`	`numInstances()` Returns the number of component instances.
`T`	`setNetworkContext(DefaultNetworkContext network)` Sets the component parent.
`String`	`status()` Returns the component status address.
`static org.vertx.java.core.json.JsonObject`	`toJson(ComponentContext context)` Serializes a component context to JSON.
`String`	`toString()`
`protected abstract String`	`type()` Returns the component deployment type.

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

- Field Detail
  - name
```
protected String name
```
  - status
```
protected String status
```
  - group
```
protected String group
```
  - config
```
protected Map<String,Object> config
```
  - instances
```
protected List<InstanceContext> instances
```
  - hooks
```
protected List<ComponentHook> hooks
```
- Constructor Detail
  - DefaultComponentContext
```
public DefaultComponentContext()
```
- Method Detail
  - fromJson
```
public static <T extends DefaultComponentContext<T>> T fromJson(org.vertx.java.core.json.JsonObject context)
```
    Creates a component context from JSON.
    
    Parameters:
    context - A JSON representation of the component context.
    
    Returns:
    A component context instance.
    
    Throws:
    
    MalformedContextException - If the context is malformed.
  - toJson
```
public static org.vertx.java.core.json.JsonObject toJson(ComponentContext context)
```
    Serializes a component context to JSON.
    
    Parameters:
    context - The component context to serialize.
    
    Returns:
    A Json representation of the component context.
  - type
```
protected abstract String type()
```
    Returns the component deployment type.
  - setNetworkContext
```
public T setNetworkContext(DefaultNetworkContext network)
```
    Sets the component parent.
  - name
```
public String name()
```
    Description copied from interface: ComponentContext
    
    Reurns the component name.
    
    Specified by:
    
    name in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    The component name.
  - address
```
public String address()
```
    Description copied from interface: ComponentContext
    
    Gets the unique component address.
    
    Specified by:
    
    address in interface ComponentContext<T extends ComponentContext<T>>
    
    Specified by:
    
    address in interface Context<T extends ComponentContext<T>>
    
    Returns:
    The component address.
  - status
```
public String status()
```
    Description copied from interface: ComponentContext
    
    Returns the component status address.
    
    Specified by:
    
    status in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    The component status address.
  - isModule
```
public boolean isModule()
```
    Description copied from interface: ComponentContext
    
    Returns a boolean indicating whether the component is a module.
    
    Specified by:
    
    isModule in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    Indicates whether the component is a module.
  - isVerticle
```
public boolean isVerticle()
```
    Description copied from interface: ComponentContext
    
    Returns a boolean indicating whether the component is a verticle.
    
    Specified by:
    
    isVerticle in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    Indicates whether the component is a verticle.
  - config
```
public org.vertx.java.core.json.JsonObject config()
```
    Description copied from interface: ComponentContext
    
    Gets the component configuration.
    
    Specified by:
    
    config in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    The component configuration.
  - instances
```
public List<InstanceContext> instances()
```
    Description copied from interface: ComponentContext
    
    Gets a list of all component instance contexts.
    
    Specified by:
    
    instances in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    A list of component instance contexts.
  - numInstances
```
public int numInstances()
```
    Description copied from interface: ComponentContext
    
    Returns the number of component instances.
    
    Specified by:
    
    numInstances in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    The number of component instances.
  - instance
```
public InstanceContext instance(int instanceNumber)
```
    Description copied from interface: ComponentContext
    
    Gets a component instance context by instance ID.
    
    Specified by:
    
    instance in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    A component instance or null if the instance doesn't exist.
  - instance
```
public InstanceContext instance(String address)
```
    Description copied from interface: ComponentContext
    
    Gets a component instance context by instance address.
    
    Specified by:
    
    instance in interface ComponentContext<T extends ComponentContext<T>>
    
    Parameters:
    address - The instance address.
    
    Returns:
    A component instance or null if the instance doesn't exist.
  - group
```
public String group()
```
    Description copied from interface: ComponentContext
    
    Returns the component deployment group.
    
    Specified by:
    
    group in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    The component HA group.
  - hooks
```
public List<ComponentHook> hooks()
```
    Description copied from interface: ComponentContext
    
    Returns a list of component hooks.
    
    Specified by:
    
    hooks in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    A list of component hooks.
  - asModule
```
public ModuleContext asModule()
```
    Description copied from interface: ComponentContext
    
    Returns the component context as a module context.
    
    Specified by:
    
    asModule in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    A module context.
  - asVerticle
```
public VerticleContext asVerticle()
```
    Description copied from interface: ComponentContext
    
    Returns the component context as a verticle context.
    
    Specified by:
    
    asVerticle in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    A verticle context.
  - network
```
public DefaultNetworkContext network()
```
    Returns the parent network context.
    
    Specified by:
    
    network in interface ComponentContext<T extends ComponentContext<T>>
    
    Returns:
    The parent network context.
  - notify
```
public void notify(T update)
```
    Specified by:
    
    notify in interface Observable<T extends ComponentContext<T>>
    
    Overrides:
    
    notify in class BaseContext<T extends ComponentContext<T>>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class BaseContext<T extends ComponentContext<T>>

Class DefaultComponentContext<T extends ComponentContext<T>>

Nested Class Summary

Nested classes/interfaces inherited from class net.kuujo.vertigo.impl.BaseContext

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

name

status

group

config

instances

hooks

Constructor Detail

DefaultComponentContext

Method Detail

fromJson

toJson

type

setNetworkContext

name

address

status

isModule

isVerticle

config

instances

numInstances

instance

instance

group

hooks

asModule

asVerticle

network

notify

toString