backtype.storm.topology

Interface IComponent

All Superinterfaces:

Serializable

All Known Subinterfaces:

IBasicBolt, IBatchBolt<T>, ICommitterTransactionalSpout<X>, IOpaquePartitionedTransactionalSpout<T>, IPartitionedTransactionalSpout<T>, IRichBolt, IRichSpout, IRichStateSpout, ITransactionalSpout<T>, ITridentBatchBolt

All Known Implementing Classes:

BaseBasicBolt, BaseBatchBolt, BaseComponent, BaseOpaquePartitionedTransactionalSpout, BasePartitionedTransactionalSpout, BaseRichBolt, BaseRichSpout, BaseTransactionalBolt, BaseTransactionalSpout, BasicBoltExecutor, BatchBoltExecutor, BatchNumberList, BatchProcessWord, BatchRepeatA, BoltTracker, ClojureBolt, ClojureSpout, CoordinatedBolt, CountingBatchBolt, CountingCommitBolt, DRPCSpout, FeederSpout, FixedTupleSpout, IdentityBolt, JoinResult, KeyedCountingBatchBolt, KeyedCountingCommitterBolt, KeyedFairBolt, KeyedSummingBatchBolt, MasterBatchCoordinator, MemoryTransactionalSpout, OpaqueMemoryTransactionalSpout, OpaquePartitionedTransactionalSpoutExecutor, PartitionedTransactionalSpoutExecutor, PrepareBatchBolt, PrepareRequest, PythonShellMetricsBolt, PythonShellMetricsSpout, ReturnResults, RichShellBolt, RichShellSpout, RichSpoutBatchTriggerer, SpoutTracker, SubtopologyBolt, TestAggregatesCounter, TestConfBolt, TestEventLogSpout, TestEventOrderCheckBolt, TestGlobalCount, TestPlannerBolt, TestPlannerSpout, TestWordCounter, TestWordSpout, TransactionalSpoutBatchExecutor, TransactionalSpoutCoordinator, TridentBoltExecutor, TridentSpoutCoordinator, TridentSpoutExecutor, TupleCaptureBolt

public interface IComponent
extends Serializable

Common methods for all possible components in a topology. This interface is used when defining topologies using the Java API.

Method Summary

Methods

Modifier and Type	Method and Description
void	declareOutputFields(OutputFieldsDeclarer declarer) Declare the output schema for all the streams of this topology.
Map<String,Object>	getComponentConfiguration() Declare configuration specific to this component.

Method Detail

declareOutputFields

void declareOutputFields(OutputFieldsDeclarer declarer)

Declare the output schema for all the streams of this topology.

Parameters:

declarer - this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream

getComponentConfiguration

Map<String,Object> getComponentConfiguration()

Declare configuration specific to this component. Only a subset of the "topology.*" configs can be overridden. The component configuration can be further overridden when constructing the topology using TopologyBuilder