Package org.apache.storm.topology
Class BaseStatefulBoltExecutor
java.lang.Object
org.apache.storm.topology.BaseStatefulBoltExecutor
- All Implemented Interfaces:
- Serializable,- IBolt,- IComponent,- IRichBolt
- Direct Known Subclasses:
- CheckpointTupleForwarder,- StatefulBoltExecutor
Base class that abstracts the common logic for executing bolts in a stateful topology.
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionprotected static class
- 
Field SummaryFields
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voiddeclareCheckpointStream(OutputFieldsDeclarer declarer) voidProcess a single tuple of input.protected abstract voidhandleCheckpoint(Tuple checkpointTuple, CheckPointState.Action action, long txid) Sub-classes can implement the logic for handling checkpoint tuple.protected abstract voidhandleTuple(Tuple input) Sub-classes can implement the logic for handling the tuple.protected voidinit(TopologyContext context, OutputCollector collector) Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.storm.topology.IComponentdeclareOutputFields, getComponentConfiguration
- 
Field Details- 
collector
 
- 
- 
Constructor Details- 
BaseStatefulBoltExecutorpublic BaseStatefulBoltExecutor()
 
- 
- 
Method Details- 
init
- 
executeDescription copied from interface:IBoltProcess a single tuple of input. The Tuple object contains metadata on it about which component/stream/task it came from. The values of the Tuple can be accessed using Tuple#getValue. The IBolt does not have to process the Tuple immediately. It is perfectly fine to hang onto a tuple and process it later (for instance, to do an aggregation or join).Tuples should be emitted using the OutputCollector provided through the prepare method. It is required that all input tuples are acked or failed at some point using the OutputCollector. Otherwise, Storm will be unable to determine when tuples coming off the spouts have been completed. For the common case of acking an input tuple at the end of the execute method, see IBasicBolt which automates this. 
- 
declareCheckpointStream
- 
handleTupleSub-classes can implement the logic for handling the tuple.- Parameters:
- input- the input tuple
 
- 
handleCheckpointprotected abstract void handleCheckpoint(Tuple checkpointTuple, CheckPointState.Action action, long txid) Sub-classes can implement the logic for handling checkpoint tuple.- Parameters:
- checkpointTuple- the checkpoint tuple
- action- the action (prepare, commit, rollback or initstate)
- txid- the transaction id.
 
 
-