Package org.apache.storm.topology
Class PersistentWindowedBoltExecutor<T extends State>
java.lang.Object
org.apache.storm.topology.WindowedBoltExecutor
org.apache.storm.topology.PersistentWindowedBoltExecutor<T>
- All Implemented Interfaces:
- Serializable,- IBolt,- IComponent,- IRichBolt,- IStatefulBolt<T>,- IStatefulComponent<T>
public class PersistentWindowedBoltExecutor<T extends State>
extends WindowedBoltExecutor
implements IStatefulBolt<T>
Wraps a 
IStatefulWindowedBolt and handles the execution. Uses state and the underlying checkpointing mechanisms to save the
 tuples in window to state. The tuples are also kept in-memory by transparently caching the window partitions and checkpointing them as
 needed.- See Also:
- 
Field SummaryFields inherited from class org.apache.storm.topology.WindowedBoltExecutorLATE_TUPLE_FIELD
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidProcess a single tuple of input.voidThis method is invoked by the framework with the previously saved state of the component.protected WindowLifecycleListener<Tuple>voidpreCommit(long txid) This is a hook for the component to perform some actions just before the framework commits its state.voidprepare(Map<String, Object> topoConf, TopologyContext context, OutputCollector collector) Called when a task for this component is initialized within a worker on the cluster.voidprePrepare(long txid) This is a hook for the component to perform some actions just before the framework prepares its state.voidThis is a hook for the component to perform some actions just before the framework rolls back the prepared state.protected voidstart()Start the trigger policy and waterMarkEventGenerator if set.protected voidvalidate(Map<String, Object> topoConf, BaseWindowedBolt.Count windowLengthCount, BaseWindowedBolt.Duration windowLengthDuration, BaseWindowedBolt.Count slidingIntervalCount, BaseWindowedBolt.Duration slidingIntervalDuration) Methods inherited from class org.apache.storm.topology.WindowedBoltExecutorboltExecute, boltExecute, cleanup, declareOutputFields, doPrepare, getComponentConfiguration, getState, getTopologyTimeoutMillis, restoreStateMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.storm.topology.IComponentdeclareOutputFields, getComponentConfigurationMethods inherited from interface org.apache.storm.topology.IStatefulBoltcleanup
- 
Constructor Details- 
PersistentWindowedBoltExecutor
 
- 
- 
Method Details- 
preparepublic void prepare(Map<String, Object> topoConf, TopologyContext context, OutputCollector collector) Description copied from interface:IBoltCalled when a task for this component is initialized within a worker on the cluster. It provides the bolt with the environment in which the bolt executes.This includes the: - Specified by:
- preparein interface- IBolt
- Specified by:
- preparein interface- IStatefulBolt<T extends State>
- Overrides:
- preparein class- WindowedBoltExecutor
- Parameters:
- topoConf- The Storm configuration for this bolt. This is the configuration provided to the topology merged in with cluster configuration on this machine.
- context- This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.
- collector- The collector is used to emit tuples from this bolt. Tuples can be emitted at any time, including the prepare and cleanup methods. The collector is thread-safe and should be saved as an instance variable of this bolt object.
- See Also:
 
- 
validateprotected void validate(Map<String, Object> topoConf, BaseWindowedBolt.Count windowLengthCount, BaseWindowedBolt.Duration windowLengthDuration, BaseWindowedBolt.Count slidingIntervalCount, BaseWindowedBolt.Duration slidingIntervalDuration) - Overrides:
- validatein class- WindowedBoltExecutor
 
- 
startprotected void start()Description copied from class:WindowedBoltExecutorStart the trigger policy and waterMarkEventGenerator if set.- Overrides:
- startin class- WindowedBoltExecutor
 
- 
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. - Specified by:
- executein interface- IBolt
- Specified by:
- executein interface- IStatefulBolt<T extends State>
- Overrides:
- executein class- WindowedBoltExecutor
- Parameters:
- input- The input tuple to be processed.
- See Also:
 
- 
initStateDescription copied from interface:IStatefulComponentThis method is invoked by the framework with the previously saved state of the component. This is invoked after prepare but before the component starts processing tuples.- Specified by:
- initStatein interface- IStatefulComponent<T extends State>
- Parameters:
- state- the previously saved state of the component.
 
- 
prePreparepublic void prePrepare(long txid) Description copied from interface:IStatefulComponentThis is a hook for the component to perform some actions just before the framework prepares its state.- Specified by:
- prePreparein interface- IStatefulComponent<T extends State>
 
- 
preCommitpublic void preCommit(long txid) Description copied from interface:IStatefulComponentThis is a hook for the component to perform some actions just before the framework commits its state.- Specified by:
- preCommitin interface- IStatefulComponent<T extends State>
 
- 
preRollbackpublic void preRollback()Description copied from interface:IStatefulComponentThis is a hook for the component to perform some actions just before the framework rolls back the prepared state.- Specified by:
- preRollbackin interface- IStatefulComponent<T extends State>
 
- 
newWindowLifecycleListener- Overrides:
- newWindowLifecycleListenerin class- WindowedBoltExecutor
 
 
-