ComponentContext (Vertigo Core 0.7.0-beta1 API)

All Superinterfaces:

Context<T>, JsonSerializable, Observable<T>

All Known Subinterfaces:

ModuleContext, VerticleContext

All Known Implementing Classes:

DefaultComponentContext, DefaultModuleContext, DefaultVerticleContext
```
public interface ComponentContext<T extends ComponentContext<T>>
extends Context<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. The component context is not actually used by any Vertigo object, but is a wrapper around multiple InstanceContext instances, with each instance representing an instance of the component - a Vert.x verticle or module.
See ModuleContext and VerticleContext for module and verticle specific configuration options respectively.

Author:

Jordan Halterman

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.
`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.
`NetworkContext`	`network()` Returns the parent network context.
`int`	`numInstances()` Returns the number of component instances.
`String`	`status()` Returns the component status address.

Methods inherited from interface net.kuujo.vertigo.util.Observable
notify, registerObserver, unregisterObserver

- Method Detail
  - name
```
String name()
```
    Reurns the component name.
    
    Returns:
    The component name.
  - address
```
String address()
```
    Gets the unique component address.
    
    Specified by:
    
    address in interface Context<T extends ComponentContext<T>>
    
    Returns:
    The component address.
  - status
```
String status()
```
    Returns the component status address.
    
    Returns:
    The component status address.
  - isModule
```
boolean isModule()
```
    Returns a boolean indicating whether the component is a module.
    
    Returns:
    Indicates whether the component is a module.
  - isVerticle
```
boolean isVerticle()
```
    Returns a boolean indicating whether the component is a verticle.
    
    Returns:
    Indicates whether the component is a verticle.
  - config
```
org.vertx.java.core.json.JsonObject config()
```
    Gets the component configuration.
    
    Returns:
    The component configuration.
  - instances
```
List<InstanceContext> instances()
```
    Gets a list of all component instance contexts.
    
    Returns:
    A list of component instance contexts.
  - numInstances
```
int numInstances()
```
    Returns the number of component instances.
    
    Returns:
    The number of component instances.
  - instance
```
InstanceContext instance(int instanceNumber)
```
    Gets a component instance context by instance ID.
    
    Parameters:
    id - The instance ID.
    
    Returns:
    A component instance or null if the instance doesn't exist.
  - instance
```
InstanceContext instance(String address)
```
    Gets a component instance context by instance address.
    
    Parameters:
    address - The instance address.
    
    Returns:
    A component instance or null if the instance doesn't exist.
  - group
```
String group()
```
    Returns the component deployment group.
    
    Returns:
    The component HA group.
  - hooks
```
List<ComponentHook> hooks()
```
    Returns a list of component hooks.
    
    Returns:
    A list of component hooks.
  - asModule
```
ModuleContext asModule()
```
    Returns the component context as a module context.
    
    Returns:
    A module context.
  - asVerticle
```
VerticleContext asVerticle()
```
    Returns the component context as a verticle context.
    
    Returns:
    A verticle context.
  - network
```
NetworkContext network()
```
    Returns the parent network context.
    
    Returns:
    The parent network context.

Interface ComponentContext<T extends ComponentContext<T>>

Method Summary

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

Method Detail

name

address

status

isModule

isVerticle

config

instances

numInstances

instance

instance

group

hooks

asModule

asVerticle

network