org.thales.punch.libraries.storm.spout.impl

Class FileSpout

java.lang.Object

org.apache.storm.topology.base.BaseComponent

org.apache.storm.topology.base.BaseRichSpout

org.thales.punch.libraries.storm.api.BaseInputNode

org.thales.punch.libraries.storm.spout.AbstractFileInput

org.thales.punch.libraries.storm.spout.impl.FileSpout

All Implemented Interfaces:

Serializable, org.apache.storm.spout.ISpout, org.apache.storm.topology.IComponent, org.apache.storm.topology.IRichSpout

public class FileSpout
extends AbstractFileInput
implements org.thales.punch.libraries.storm.api.ISpout

The original implementation of the File Spout. This one is NOT able to detect any new file added to a directory path after the Spout initialisation. To have this behaviour, see FileSpoutWatcher.

To get the complete Java documentation, please see the AbstractFileInput.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.thales.punch.libraries.storm.spout.AbstractFileInput

AbstractFileInput.Item

Field Summary

Fields inherited from class org.thales.punch.libraries.storm.spout.AbstractFileInput

failed, inputQueue, inputQueues, orderedRead, path, pathRegexPattern, processAlreadyExisting, queueSize

Fields inherited from class org.thales.punch.libraries.storm.api.BaseInputNode

collector, exitCondition, latencyRecordSender, loadController, metricContext, myself, nodeSettings

Constructor Summary

Constructors

Constructor and Description
FileSpout(org.thales.punch.libraries.storm.api.NodeSettings settings)

Method Summary

Modifier and Type	Method and Description
void	open(Map stormSettings, org.apache.storm.task.TopologyContext topologyContext, org.apache.storm.spout.SpoutOutputCollector collector) Setup this spout before it starts receiving data and emitting tuples into the topology.

Methods inherited from class org.thales.punch.libraries.storm.spout.AbstractFileInput

ack, drainNextLogs, emitNextLine, fail, getListFiles, nextTuple, readOneFile

Methods inherited from class org.thales.punch.libraries.storm.api.BaseInputNode

close, deactivate, declareOutputFields, getPublishedStreams, regulate, sendLatencyRecord

Methods inherited from class org.apache.storm.topology.base.BaseRichSpout

activate

Methods inherited from class org.apache.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 org.thales.punch.libraries.storm.api.ISpout

registerNextTupleCallback

Methods inherited from interface org.apache.storm.spout.ISpout

ack, activate, close, deactivate, fail, nextTuple

Methods inherited from interface org.apache.storm.topology.IComponent

declareOutputFields, getComponentConfiguration

Constructor Detail

FileSpout

public FileSpout(org.thales.punch.libraries.storm.api.NodeSettings settings)

Parameters:

settings - the spout settings

Method Detail

open

public void open(Map stormSettings,
                 org.apache.storm.task.TopologyContext topologyContext,
                 org.apache.storm.spout.SpoutOutputCollector collector)

Setup this spout before it starts receiving data and emitting tuples into the topology.

This is called by the Storm runtime at topology activation.

Specified by:

open in interface org.apache.storm.spout.ISpout

Overrides:

open in class AbstractFileInput

Parameters:

stormSettings - storm configuration

topologyContext - the storm topology context

collector - the output collector for emitting tuples.