Package org.apache.storm.hdfs.bolt

Class AbstractHdfsBolt

java.lang.Object

org.apache.storm.topology.base.BaseComponent

org.apache.storm.topology.base.BaseRichBolt

org.apache.storm.hdfs.bolt.AbstractHdfsBolt

All Implemented Interfaces:

Serializable, IBolt, IComponent, IRichBolt

Direct Known Subclasses:

AvroGenericRecordBolt, HdfsBolt, SequenceFileBolt

public abstract class AbstractHdfsBolt
extends BaseRichBolt

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected OutputCollector	collector
protected String	configKey
protected FileNameFormat	fileNameFormat
protected Integer	fileRetryCount
protected org.apache.hadoop.fs.FileSystem	fs
protected String	fsUrl
protected org.apache.hadoop.conf.Configuration	hdfsConfig
protected Integer	maxOpenFiles
protected long	offset
protected Partitioner	partitioner
protected List<RotationAction>	rotationActions
protected Map<String,Integer>	rotationCounterMap
protected FileRotationPolicy	rotationPolicy
protected Timer	rotationTimer
protected SyncPolicy	syncPolicy
protected Integer	tickTupleInterval
protected Object	writeLock
protected Map<String,Writer>	writers

Constructor Summary

Constructors

Constructor	Description
AbstractHdfsBolt()

Method Summary

Modifier and Type	Method	Description
void	cleanup()
void	declareOutputFields(OutputFieldsDeclarer outputFieldsDeclarer)
protected abstract void	doPrepare(Map<String,Object> conf, TopologyContext topologyContext, OutputCollector collector)
final void	execute(Tuple tuple)
protected org.apache.hadoop.fs.Path	getBasePathForNextFile(Tuple tuple)
Map<String,Object>	getComponentConfiguration()
protected abstract String	getWriterKey(Tuple tuple)
protected abstract Writer	makeNewWriter(org.apache.hadoop.fs.Path path, Tuple tuple)
final void	prepare(Map<String,Object> conf, TopologyContext topologyContext, OutputCollector collector)	Marked as final to prevent override.
protected void	rotateOutputFile(Writer writer)

Methods inherited from class java.lang.Object

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

Field Details

writers

protected Map<String,Writer> writers

rotationCounterMap

protected Map<String,Integer> rotationCounterMap

rotationActions

protected List<RotationAction> rotationActions

collector

protected OutputCollector collector

fs

protected transient org.apache.hadoop.fs.FileSystem fs

syncPolicy

protected SyncPolicy syncPolicy

rotationPolicy

protected FileRotationPolicy rotationPolicy

fileNameFormat

protected FileNameFormat fileNameFormat

fsUrl

protected String fsUrl

configKey

protected String configKey

writeLock

protected transient Object writeLock

rotationTimer

protected transient Timer rotationTimer

offset

protected long offset

fileRetryCount

protected Integer fileRetryCount

tickTupleInterval

protected Integer tickTupleInterval

maxOpenFiles

protected Integer maxOpenFiles

partitioner

protected Partitioner partitioner

hdfsConfig

protected transient org.apache.hadoop.conf.Configuration hdfsConfig

Constructor Details

AbstractHdfsBolt

public AbstractHdfsBolt()

Method Details

rotateOutputFile

protected void rotateOutputFile(Writer writer)
                         throws IOException

Throws:

IOException

prepare

public final void prepare(Map<String,Object> conf,
 TopologyContext topologyContext,
 OutputCollector collector)

Marked as final to prevent override. Subclasses should implement the doPrepare() method.

execute

public final void execute(Tuple tuple)

getComponentConfiguration

public Map<String,Object> getComponentConfiguration()

Specified by:

getComponentConfiguration in interface IComponent

Overrides:

getComponentConfiguration in class BaseComponent

declareOutputFields

public void declareOutputFields(OutputFieldsDeclarer outputFieldsDeclarer)

cleanup

public void cleanup()

Specified by:

cleanup in interface IBolt

Overrides:

cleanup in class BaseRichBolt

getBasePathForNextFile

protected org.apache.hadoop.fs.Path getBasePathForNextFile(Tuple tuple)

doPrepare

protected abstract void doPrepare(Map<String,Object> conf,
 TopologyContext topologyContext,
 OutputCollector collector)
                           throws IOException

Throws:

IOException

getWriterKey

protected abstract String getWriterKey(Tuple tuple)

makeNewWriter

protected abstract Writer makeNewWriter(org.apache.hadoop.fs.Path path,
 Tuple tuple)
                                 throws IOException

Throws:

IOException