io.druid.data.input

Interface FirehoseFactory<T extends InputRowParser>

All Known Implementing Classes:

AbstractTextFilesFirehoseFactory, ClippedFirehoseFactory, CombiningFirehoseFactory, EventReceiverFirehoseFactory, FixedCountFirehoseFactory, HttpFirehoseFactory, IngestSegmentFirehoseFactory, IrcFirehoseFactory, KafkaEightFirehoseFactory, LocalFirehoseFactory, PrefetchableTextFilesFirehoseFactory, RabbitMQFirehoseFactory, RocketMQFirehoseFactory, StaticAzureBlobStoreFirehoseFactory, StaticCloudFilesFirehoseFactory, StaticGoogleBlobStoreFirehoseFactory, StaticS3FirehoseFactory, TimedShutoffFirehoseFactory, TwitterSpritzerFirehoseFactory

public interface FirehoseFactory<T extends InputRowParser>

FirehoseFactory creates a Firehose which is an interface holding onto the stream of incoming data. It currently provides two methods for creating a Firehose and their default implementations call each other for the backward compatibility. Implementations of this interface must implement one of these methods.

Method Summary

Modifier and Type	Method and Description
default Firehose	connect(T parser) Deprecated.
default Firehose	connect(T parser, File temporaryDirectory) Initialization method that connects up the fire hose.

Method Detail

connect

@Deprecated
default Firehose connect(T parser)
                              throws IOException,
                                     ParseException

Deprecated.

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.

Parameters:

parser - an input row parser

Throws:

IOException

ParseException

connect

default Firehose connect(T parser,
                         File temporaryDirectory)
                  throws IOException,
                         ParseException

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.

Parameters:

parser - an input row parser

temporaryDirectory - a directory where temporary files are stored

Throws:

IOException

ParseException