Package org.apache.storm.hdfs.spout
Class HdfsSpout
java.lang.Object
org.apache.storm.topology.base.BaseComponent
org.apache.storm.topology.base.BaseRichSpout
org.apache.storm.hdfs.spout.HdfsSpout
- All Implemented Interfaces:
- Serializable,- ISpout,- IComponent,- IRichSpout
- See Also:
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidStorm has determined that the tuple emitted by this spout with the msgId identifier has been fully processed.voidclose()Called when an ISpout is going to be shutdown.voiddeclareOutputFields(OutputFieldsDeclarer declarer) Declare the output schema for all the streams of this topology.protected voidvoidThe tuple emitted by this spout with the msgId identifier has failed to be fully processed.org.apache.hadoop.fs.PathvoidWhen this method is called, Storm is requesting that the Spout emit tuples to the output collector.voidopen(Map<String, Object> conf, TopologyContext context, SpoutOutputCollector collector) Called when a task for this component is initialized within a worker on the cluster.setArchiveDir(String archiveDir) setBadFilesDir(String badFilesDir) setClocksInSync(boolean clocksInSync) setCommitFrequencyCount(int commitFrequencyCount) setCommitFrequencySec(int commitFrequencySec) setHdfsUri(String hdfsUri) setIgnoreSuffix(String ignoreSuffix) setLockDir(String lockDir) setLockTimeoutSec(int lockTimeoutSec) setMaxOutstanding(int maxOutstanding) setReaderType(String readerType) setSourceDir(String sourceDir) withConfigKey(String configKey) set key name under which HDFS options are placed.withOutputFields(String... fields) Output field names.withOutputStream(String streamName) Set output stream name.Methods inherited from class org.apache.storm.topology.base.BaseRichSpoutactivate, deactivateMethods inherited from class org.apache.storm.topology.base.BaseComponentgetComponentConfigurationMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.storm.topology.IComponentgetComponentConfiguration
- 
Constructor Details- 
HdfsSpoutpublic HdfsSpout()
 
- 
- 
Method Details- 
setHdfsUri
- 
setReaderType
- 
setSourceDir
- 
setArchiveDir
- 
setBadFilesDir
- 
setLockDir
- 
setCommitFrequencyCount
- 
setCommitFrequencySec
- 
setMaxOutstanding
- 
setLockTimeoutSec
- 
setClocksInSync
- 
setIgnoreSuffix
- 
withOutputFieldsOutput field names. Number of fields depends upon the reader type
- 
withConfigKeyset key name under which HDFS options are placed. (similar to HDFS bolt). default key name is 'hdfs.config'
- 
withOutputStreamSet output stream name.
- 
getLockDirPathpublic org.apache.hadoop.fs.Path getLockDirPath()
- 
getCollector
- 
nextTuplepublic void nextTuple()Description copied from interface:ISpoutWhen this method is called, Storm is requesting that the Spout emit tuples to the output collector. This method should be non-blocking, so if the Spout has no tuples to emit, this method should return. nextTuple, ack, and fail are all called in a tight loop in a single thread in the spout task. When there are no tuples to emit, it is courteous to have nextTuple sleep for a short amount of time (like a single millisecond) so as not to waste too much CPU.
- 
emitData
- 
openDescription copied from interface:ISpoutCalled when a task for this component is initialized within a worker on the cluster. It provides the spout with the environment in which the spout executes.This includes the: - Parameters:
- conf- The Storm configuration for this spout. 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 spout. Tuples can be emitted at any time, including the open and close methods. The collector is thread-safe and should be saved as an instance variable of this spout object.
 
- 
closepublic void close()Description copied from interface:ISpoutCalled when an ISpout is going to be shutdown. There is no guarentee that close will be called, because the supervisor kill -9's worker processes on the cluster.The one context where close is guaranteed to be called is a topology is killed when running Storm in local mode. - Specified by:
- closein interface- ISpout
- Overrides:
- closein class- BaseRichSpout
 
- 
ackDescription copied from interface:ISpoutStorm has determined that the tuple emitted by this spout with the msgId identifier has been fully processed. Typically, an implementation of this method will take that message off the queue and prevent it from being replayed.- Specified by:
- ackin interface- ISpout
- Overrides:
- ackin class- BaseRichSpout
 
- 
failDescription copied from interface:ISpoutThe tuple emitted by this spout with the msgId identifier has failed to be fully processed. Typically, an implementation of this method will put that message back on the queue to be replayed at a later time.- Specified by:
- failin interface- ISpout
- Overrides:
- failin class- BaseRichSpout
 
- 
declareOutputFieldsDescription copied from interface:IComponentDeclare 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
 
 
-