org.apache.samza.task

Interface EndOfStreamListenerTask

public interface EndOfStreamListenerTask

The EndOfStreamListenerTask augments StreamTask allowing the method implementor to specify code to be executed when the 'end-of-stream' is reached for all input SSPs. While some streaming sources are infinite (like kafka), some others like HDFS, File based sources are bounded. For instance, file based sources have the notion of EOF to indicate that there is no more data.

Method Summary

Modifier and Type	Method and Description
void	onEndOfStream(MessageCollector collector, TaskCoordinator coordinator) Guaranteed to be invoked when all SSPs processed by this task have reached their end-of-stream.

Method Detail

onEndOfStream

void onEndOfStream(MessageCollector collector,
                   TaskCoordinator coordinator)
            throws java.lang.Exception

Guaranteed to be invoked when all SSPs processed by this task have reached their end-of-stream. Users can choose to invoke commit on the TaskCoordinator to commit changes.

Parameters:

collector - Contains the means of sending message envelopes to an output stream.*

coordinator - Manages execution of tasks.

Throws:

java.lang.Exception - Any exception types encountered during the execution of the processing task.