io.druid.segment.realtime.firehose

Class TimedShutoffFirehoseFactory

java.lang.Object

io.druid.segment.realtime.firehose.TimedShutoffFirehoseFactory

All Implemented Interfaces:

FirehoseFactory<InputRowParser>

public class TimedShutoffFirehoseFactory
extends Object
implements FirehoseFactory<InputRowParser>

Creates firehoses that shut off at a particular time. Useful for limiting the lifespan of a realtime job.

Constructor Summary

Constructors

Constructor and Description
TimedShutoffFirehoseFactory(FirehoseFactory delegateFactory, org.joda.time.DateTime shutoffTime)

Method Summary

Modifier and Type	Method and Description
Firehose	connect(InputRowParser parser, File temporaryDirectory) Initialization method that connects up the fire hose.
FirehoseFactory	getDelegateFactory()
org.joda.time.DateTime	getShutoffTime()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.druid.data.input.FirehoseFactory

connect

Constructor Detail

TimedShutoffFirehoseFactory

public TimedShutoffFirehoseFactory(FirehoseFactory delegateFactory,
                                   org.joda.time.DateTime shutoffTime)

Method Detail

connect

public Firehose connect(InputRowParser parser,
                        File temporaryDirectory)
                 throws IOException

Description copied from interface: FirehoseFactory

Initialization method that connects up the fire hose. If this method returns successfully it should be safe to call hasMore() on the returned Firehose (which might subsequently block).

If this method returns null, then any attempt to call hasMore(), nextRow(), commit() and close() on the return value will throw a surprising NPE. Throwing IOException on connection failure or runtime exception on invalid configuration is preferred over returning null.

Some fire hoses like PrefetchableTextFilesFirehoseFactory may use a temporary directory to cache data in it.

Specified by:

connect in interface FirehoseFactory<InputRowParser>

Parameters:

parser - an input row parser

temporaryDirectory - a directory where temporary files are stored

Throws:

IOException

getDelegateFactory

public FirehoseFactory getDelegateFactory()

getShutoffTime

public org.joda.time.DateTime getShutoffTime()