backtype.storm.task

Class GeneralTopologyContext

java.lang.Object

backtype.storm.task.GeneralTopologyContext

All Implemented Interfaces:

org.json.simple.JSONAware

Direct Known Subclasses:

WorkerTopologyContext

public class GeneralTopologyContext
extends java.lang.Object
implements org.json.simple.JSONAware

Constructor Summary

Constructors

Constructor and Description
GeneralTopologyContext(GeneralTopologyContext delegate)
GeneralTopologyContext(StormTopology topology, java.util.Map stormConf, java.util.Map<java.lang.Integer,java.lang.String> taskToComponent, java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> componentToSortedTasks, java.util.Map<java.lang.String,java.util.Map<java.lang.String,Fields>> componentToStreamToFields, java.lang.String stormId)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComponentId(int taskId) Gets the component id for the specified task id.
java.util.Set<java.lang.String>	getComponentIds() Gets a list of all component ids in this topology
Fields	getComponentOutputFields(java.lang.String componentId, java.lang.String streamId) Gets the declared output fields for the specified component/stream.
java.util.Set<java.lang.String>	getComponentStreams(java.lang.String componentId) Gets the set of streams declared for the specified component.
java.util.List<java.lang.Integer>	getComponentTasks(java.lang.String componentId) Gets the task ids allocated for the given component id.
java.lang.String	getStormId() Gets the unique id assigned to this topology.
java.util.Map<java.lang.Integer,java.lang.String>	getTaskToComponent() Gets a map from task id to component id.
java.lang.String	toJSONString() Gets information about who is consuming the outputs of the specified component, and how.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeneralTopologyContext

public GeneralTopologyContext(StormTopology topology,
                              java.util.Map stormConf,
                              java.util.Map<java.lang.Integer,java.lang.String> taskToComponent,
                              java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> componentToSortedTasks,
                              java.util.Map<java.lang.String,java.util.Map<java.lang.String,Fields>> componentToStreamToFields,
                              java.lang.String stormId)

GeneralTopologyContext

public GeneralTopologyContext(GeneralTopologyContext delegate)

Method Detail

getStormId

public java.lang.String getStormId()

Gets the unique id assigned to this topology. The id is the storm name with a unique nonce appended to it.

Returns:

the storm id

getComponentId

public java.lang.String getComponentId(int taskId)

Gets the component id for the specified task id. The component id maps to a component id specified for a Spout or Bolt in the topology definition.

Parameters:

taskId - the task id

Returns:

the component id for the input task id

getComponentStreams

public java.util.Set<java.lang.String> getComponentStreams(java.lang.String componentId)

Gets the set of streams declared for the specified component.

getComponentTasks

public java.util.List<java.lang.Integer> getComponentTasks(java.lang.String componentId)

Gets the task ids allocated for the given component id. The task ids are always returned in ascending order.

getComponentOutputFields

public Fields getComponentOutputFields(java.lang.String componentId,
                                       java.lang.String streamId)

Gets the declared output fields for the specified component/stream.

toJSONString

public java.lang.String toJSONString()

Gets information about who is consuming the outputs of the specified component, and how.

Specified by:

toJSONString in interface org.json.simple.JSONAware

Returns:

Map from stream id to component id to the Grouping used.

getTaskToComponent

public java.util.Map<java.lang.Integer,java.lang.String> getTaskToComponent()

Gets a map from task id to component id.

getComponentIds

public java.util.Set<java.lang.String> getComponentIds()

Gets a list of all component ids in this topology