com.toolsverse.io

Interface StreamingConnector<S extends StreamingPackage,P extends ProducerPackage>

All Known Implementing Classes:

ApiJsonConnector, JsonConnector, KeyValueConnector, TextConnector, XmlObjectConnector, XmlObjectStreamingConnector

public interface StreamingConnector<S extends StreamingPackage,P extends ProducerPackage>

The common interface for all connector classes that can stream data and consume streams using given IoProcessor.

Since:

5.9

Version:

1.0

Method Summary

Modifier and Type	Method and Description
void	beforeStream(P producerPackage) Executed before record has been streamed.
void	closeStream(S streamingPackage) Close stream.
boolean	consume(S streamingPackage, Object message, AtomicInteger row) Consume the next record.
void	endStream(P producerPackage) Executed after record has been streamed.
StreamingCommitPolicy	getCommitPolicy() Gets the commit policy.
void	setCommitPolicy(StreamingCommitPolicy commitPolicy) Sets the commit policy.
void	startStream(P producerPackage) Start the stream.

Method Detail

consume

boolean consume(S streamingPackage,
                Object message,
                AtomicInteger row)
         throws Exception

Consume the next record.

Parameters:

streamingPackage - the streaming package

message - the message to consume

row - the current row number

Returns:

true, if successful

Throws:

Exception - in case of any error

closeStream

void closeStream(S streamingPackage)

Close stream.

Parameters:

streamingPackage - the streaming package

startStream

void startStream(P producerPackage)
          throws Exception

Start the stream.

Parameters:

producerPackage - the producer package

Throws:

Exception - the exception

beforeStream

void beforeStream(P producerPackage)
           throws Exception

Executed before record has been streamed.

Parameters:

producerPackage - the producer package

Throws:

Exception - in case of any error

endStream

void endStream(P producerPackage)
        throws Exception

Executed after record has been streamed.

Parameters:

producerPackage - the producer package

Throws:

Exception - in case of any error

setCommitPolicy

void setCommitPolicy(StreamingCommitPolicy commitPolicy)

Sets the commit policy.

Parameters:

commitPolicy - the new commit policy

getCommitPolicy

StreamingCommitPolicy getCommitPolicy()

Gets the commit policy.

Returns:

the commit policy