stream.storm

Class ProcessBolt

java.lang.Object

backtype.storm.topology.base.BaseComponent

backtype.storm.topology.base.BaseRichBolt

stream.storm.AbstractBolt

stream.storm.ProcessBolt

All Implemented Interfaces:

backtype.storm.task.IBolt, backtype.storm.topology.IComponent, backtype.storm.topology.IRichBolt, Serializable

Direct Known Subclasses:

MonitorBolt

public class ProcessBolt
extends AbstractBolt

This bolt implementation wraps a process configuration and creates the process including its inner element to provide a bolt that behaves the same as a regular streams process.

TODO: Currently, services are not injected into bolts as there is no service facade implementation for storm, yet.

Author:

Christian Bockermann

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProcessBolt.DataForwarder
class	ProcessBolt.OutputRef

Field Summary

Fields

Modifier and Type	Field and Description
(package private) BoltContext	ctx
(package private) static org.slf4j.Logger	log
(package private) List<ProcessBolt.OutputRef>	outputRefs
protected String[]	outputs
(package private) ProcessorList	process
private static long	serialVersionUID The unique class ID
(package private) Set<Subscription>	subscriptions The list of subscribers (e.g. output queues,...) that need to be connected to this bolt
protected Variables	variables

Fields inherited from class stream.storm.AbstractBolt

output, uuid, xmlConfig

Constructor Summary

Constructors

Constructor and Description
ProcessBolt(String xmlConfig, String uuid, Map<String,String> variables) The bolt implementation requires an XML configuration (the complete container XML as string) and the ID that identifies the corresponding process within that XML.

Method Summary

Modifier and Type	Method and Description
protected ProcessorList	createProcess() This method creates the inner processors of this process bolt.
protected Processor	createProcessor(Element el, ProcessorFactory pf)
void	execute(backtype.storm.tuple.Tuple input)
List<Processor>	getAllProcessors()
protected List<Processor>	getAllProcessors(ProcessorList list)
Set<Subscription>	getSubscriptions() This method returns the list (set) of queues ('sinks') that are referenced by any of the processors of this process bolt.
void	prepare(Map stormConf, backtype.storm.task.TopologyContext context, backtype.storm.task.OutputCollector collector)

Methods inherited from class stream.storm.AbstractBolt

declareOutputFields

Methods inherited from class backtype.storm.topology.base.BaseRichBolt

cleanup

Methods inherited from class backtype.storm.topology.base.BaseComponent

getComponentConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface backtype.storm.topology.IComponent

getComponentConfiguration

Field Detail

serialVersionUID

private static final long serialVersionUID

The unique class ID

See Also:

Constant Field Values

log

static org.slf4j.Logger log

process

transient ProcessorList process

outputRefs

transient List<ProcessBolt.OutputRef> outputRefs

variables

protected final Variables variables

outputs

protected String[] outputs

ctx

final BoltContext ctx

subscriptions

final Set<Subscription> subscriptions

The list of subscribers (e.g. output queues,...) that need to be connected to this bolt

Constructor Detail

ProcessBolt

public ProcessBolt(String xmlConfig,
                   String uuid,
                   Map<String,String> variables)
            throws Exception

The bolt implementation requires an XML configuration (the complete container XML as string) and the ID that identifies the corresponding process within that XML.

Parameters:

xmlConfig - The XML configuration as String.

uuid - The ID of the process.

Throws:

Exception

Method Detail

getSubscriptions

public Set<Subscription> getSubscriptions()

This method returns the list (set) of queues ('sinks') that are referenced by any of the processors of this process bolt. These need to artificially be connected to this bolt (subscription model).

Returns:

createProcess

protected ProcessorList createProcess()
                               throws Exception

This method creates the inner processors of this process bolt.

Returns:

Throws:

Exception

getAllProcessors

public List<Processor> getAllProcessors()

getAllProcessors

protected List<Processor> getAllProcessors(ProcessorList list)

createProcessor

protected Processor createProcessor(Element el,
                                    ProcessorFactory pf)
                             throws Exception

Throws:

Exception

prepare

public void prepare(Map stormConf,
                    backtype.storm.task.TopologyContext context,
                    backtype.storm.task.OutputCollector collector)

See Also:

IBolt.prepare(java.util.Map, backtype.storm.task.TopologyContext, backtype.storm.task.OutputCollector)

execute

public void execute(backtype.storm.tuple.Tuple input)

See Also:

IBolt.execute(backtype.storm.tuple.Tuple)