org.apache.storm.task

Class TopologyContext

java.lang.Object

org.apache.storm.task.GeneralTopologyContext

org.apache.storm.task.WorkerTopologyContext

org.apache.storm.task.TopologyContext

All Implemented Interfaces:

org.apache.storm.shade.org.json.simple.JSONAware, IMetricsContext

public class TopologyContext
extends WorkerTopologyContext
implements IMetricsContext

A TopologyContext is given to bolts and spouts in their prepare() and open() methods, respectively. This object provides information about the component’s place within the topology, such as task ids, inputs and outputs, etc.

The TopologyContext is also used to declare ISubscribedState objects to synchronize state with StateSpouts this object is subscribed to.

Field Summary

Fields inherited from class org.apache.storm.task.WorkerTopologyContext

SHARED_EXECUTOR

Fields inherited from class org.apache.storm.task.GeneralTopologyContext

_doSanityCheck, _topoConf

Constructor Summary

Constructors

Constructor and Description

TopologyContext(StormTopology topology, Map<String,Object> topoConf, Map<Integer,String> taskToComponent, Map<String,List<Integer>> componentToSortedTasks, Map<String,Map<String,Fields>> componentToStreamToFields, Map<String,Long> blobToLastKnownVersionShared, String stormId, String codeDir, String pidDir, Integer taskId, Integer workerPort, List<Integer> workerTasks, Map<String,Object> defaultResources, Map<String,Object> userResources, Map<String,Object> executorData, Map<Integer,Map<Integer,Map<String,IMetric>>> registeredMetrics, AtomicBoolean openOrPrepareWasCalled)

Method Summary

Modifier and Type	Method and Description
void	addTaskHook(ITaskHook hook)
Map<String,Long>	getBlobToLastKnownVersion()
Object	getExecutorData(String name)
List<ITaskHook>	getHooks()
IMetric	getRegisteredMetricByName(String name) Deprecated.
Object	getTaskData(String name)
String	getThisComponentId()
Map<String,Map<String,List<String>>>	getThisInputFields() Gets the declared input fields for this component.
Fields	getThisOutputFields(String streamId) Gets the declared output fields for the specified stream id for the component this task is a part of.
Map<String,List<String>>	getThisOutputFieldsForStreams() Gets the declared output fields for all streams for the component this task is a part of.
Map<GlobalStreamId,Grouping>	getThisSources() Gets the declared inputs to this component.
Set<String>	getThisStreams() Gets the set of streams declared for the component of this task.
Map<String,Map<String,Grouping>>	getThisTargets() Gets information about who is consuming the outputs of this component, and how.
int	getThisTaskId() Gets the task id of this task.
int	getThisTaskIndex() Gets the index of this task id in getComponentTasks(getThisComponentId()).
com.codahale.metrics.Counter	registerCounter(String name)
com.codahale.metrics.Gauge	registerGauge(String name, com.codahale.metrics.Gauge gauge)
com.codahale.metrics.Histogram	registerHistogram(String name)
com.codahale.metrics.Meter	registerMeter(String name)
CombinedMetric	registerMetric(String name, ICombiner combiner, int timeBucketSizeInSecs) Deprecated.
ReducedMetric	registerMetric(String name, IReducer reducer, int timeBucketSizeInSecs) Deprecated.
<T extends IMetric> T	registerMetric(String name, T metric, int timeBucketSizeInSecs) Deprecated.
com.codahale.metrics.Timer	registerTimer(String name)
<T extends ISubscribedState> T	setAllSubscribedState(T obj) All state from all subscribed state spouts streams will be synced with the provided object.
void	setExecutorData(String name, Object data)
<T extends ISubscribedState> T	setSubscribedState(String componentId, String streamId, T obj) Synchronizes the specified stream from the specified state spout component id with the provided ISubscribedState object.
<T extends ISubscribedState> T	setSubscribedState(String componentId, T obj) Synchronizes the default stream from the specified state spout component id with the provided ISubscribedState object.
void	setTaskData(String name, Object data)
String	toJSONString()

Methods inherited from class org.apache.storm.task.WorkerTopologyContext

getCodeDir, getPIDDir, getResource, getSharedExecutor, getTaskToNodePort, getThisWorkerHost, getThisWorkerPort, getThisWorkerTasks

Methods inherited from class org.apache.storm.task.GeneralTopologyContext

doSanityCheck, getComponentCommon, getComponentId, getComponentIds, getComponentOutputFields, getComponentOutputFields, getComponentStreams, getComponentTasks, getConf, getRawTopology, getSources, getStormId, getTargets, getTaskToComponent, maxTopologyMessageTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

TopologyContext

public TopologyContext(StormTopology topology,
                       Map<String,Object> topoConf,
                       Map<Integer,String> taskToComponent,
                       Map<String,List<Integer>> componentToSortedTasks,
                       Map<String,Map<String,Fields>> componentToStreamToFields,
                       Map<String,Long> blobToLastKnownVersionShared,
                       String stormId,
                       String codeDir,
                       String pidDir,
                       Integer taskId,
                       Integer workerPort,
                       List<Integer> workerTasks,
                       Map<String,Object> defaultResources,
                       Map<String,Object> userResources,
                       Map<String,Object> executorData,
                       Map<Integer,Map<Integer,Map<String,IMetric>>> registeredMetrics,
                       AtomicBoolean openOrPrepareWasCalled)

Method Detail

setAllSubscribedState

public <T extends ISubscribedState> T setAllSubscribedState(T obj)

All state from all subscribed state spouts streams will be synced with the provided object.

It is recommended that your ISubscribedState object is kept as an instance variable of this object. The recommended usage of this method is as follows:

java _myState = context.setAllSubscribedState(new MyState());

Parameters:

obj - Provided ISubscribedState implementation

Returns:

Returns the ISubscribedState object provided

setSubscribedState

public <T extends ISubscribedState> T setSubscribedState(String componentId,
                                                         T obj)

Synchronizes the default stream from the specified state spout component id with the provided ISubscribedState object.

The recommended usage of this method is as follows:

java _myState = context.setSubscribedState(componentId, new MyState());

Parameters:

componentId - the id of the StateSpout component to subscribe to

obj - Provided ISubscribedState implementation

Returns:

Returns the ISubscribedState object provided

setSubscribedState

public <T extends ISubscribedState> T setSubscribedState(String componentId,
                                                         String streamId,
                                                         T obj)

Synchronizes the specified stream from the specified state spout component id with the provided ISubscribedState object.

The recommended usage of this method is as follows:

java _myState = context.setSubscribedState(componentId, streamId, new MyState());

Parameters:

componentId - the id of the StateSpout component to subscribe to

streamId - the stream to subscribe to

obj - Provided ISubscribedState implementation

Returns:

Returns the ISubscribedState object provided

getBlobToLastKnownVersion

public Map<String,Long> getBlobToLastKnownVersion()

getThisTaskId

public int getThisTaskId()

Gets the task id of this task.

Returns:

the task id

getThisComponentId

public String getThisComponentId()

Returns:

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

getThisOutputFields

public Fields getThisOutputFields(String streamId)

Gets the declared output fields for the specified stream id for the component this task is a part of.

getThisOutputFieldsForStreams

public Map<String,List<String>> getThisOutputFieldsForStreams()

Gets the declared output fields for all streams for the component this task is a part of.

getThisStreams

public Set<String> getThisStreams()

Gets the set of streams declared for the component of this task.

getThisTaskIndex

public int getThisTaskIndex()

Gets the index of this task id in getComponentTasks(getThisComponentId()). An example use case for this method is determining which task accesses which resource in a distributed resource to ensure an even distribution.

getThisInputFields

public Map<String,Map<String,List<String>>> getThisInputFields()

Gets the declared input fields for this component.

Returns:

A map from sources to streams to fields.

getThisSources

public Map<GlobalStreamId,Grouping> getThisSources()

Gets the declared inputs to this component.

Returns:

A map from subscribed component/stream to the grouping subscribed with.

getThisTargets

public Map<String,Map<String,Grouping>> getThisTargets()

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

Returns:

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

setTaskData

public void setTaskData(String name,
                        Object data)

getTaskData

public Object getTaskData(String name)

setExecutorData

public void setExecutorData(String name,
                            Object data)

getExecutorData

public Object getExecutorData(String name)

addTaskHook

public void addTaskHook(ITaskHook hook)

getHooks

public List<ITaskHook> getHooks()

toJSONString

public String toJSONString()

Specified by:

toJSONString in interface org.apache.storm.shade.org.json.simple.JSONAware

Overrides:

toJSONString in class GeneralTopologyContext

registerMetric

@Deprecated
public <T extends IMetric> T registerMetric(String name,
                                                        T metric,
                                                        int timeBucketSizeInSecs)

Deprecated.

Specified by:

registerMetric in interface IMetricsContext

getRegisteredMetricByName

@Deprecated
public IMetric getRegisteredMetricByName(String name)

Deprecated.

Get component’s metric from registered metrics by name. Notice: Normally, one component can only register one metric name once. But now registerMetric has a bug(https://issues.apache.org/jira/browse/STORM-254) cause the same metric name can register twice. So we just return the first metric we meet.

registerMetric

@Deprecated
public ReducedMetric registerMetric(String name,
                                                IReducer reducer,
                                                int timeBucketSizeInSecs)

Deprecated.

Specified by:

registerMetric in interface IMetricsContext

registerMetric

@Deprecated
public CombinedMetric registerMetric(String name,
                                                 ICombiner combiner,
                                                 int timeBucketSizeInSecs)

Deprecated.

Specified by:

registerMetric in interface IMetricsContext

registerTimer

public com.codahale.metrics.Timer registerTimer(String name)

registerHistogram

public com.codahale.metrics.Histogram registerHistogram(String name)

registerMeter

public com.codahale.metrics.Meter registerMeter(String name)

registerCounter

public com.codahale.metrics.Counter registerCounter(String name)

registerGauge

public com.codahale.metrics.Gauge registerGauge(String name,
                                                com.codahale.metrics.Gauge gauge)