io.continual.services.processor.engine.library.sources

Class BasicSource

java.lang.Object

io.continual.services.processor.engine.library.sources.BasicSource

All Implemented Interfaces:

Source, Closeable, AutoCloseable

Direct Known Subclasses:

CsvSource, JsonObjectFileSource, JsonObjectStreamSource, QueuingSource

public abstract class BasicSource
extends Object
implements Source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicSource()
protected	BasicSource(org.json.JSONObject config)
protected	BasicSource(String defaultPipelineName)

Method Summary

Modifier and Type	Method and Description
void	close()
protected long[]	getBackoffTimes()
MessageAndRouting	getNextMessage(StreamProcessingContext spc, long timeUnit, TimeUnit units) This basic implementation polls the internalGetNextMessage call periodically until it returns a message, or the operation time limit is reached.
protected abstract MessageAndRouting	internalGetNextMessage(StreamProcessingContext spc) Get the next pending message, if any.
boolean	isEof() Is the source at EOF? Not all sources are bounded, so they may always return false.
protected MessageAndRouting	makeDefRoutingMessage(Message msg)
void	markComplete(StreamProcessingContext spc, MessageAndRouting mr) Called by the processing engine when processing for a given message is complete.
protected void	noteEndOfStream()
void	requeue(MessageAndRouting msgAndRoute) Requeue a message for delivery into the given pipeline

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicSource

protected BasicSource(String defaultPipelineName)

BasicSource

protected BasicSource(org.json.JSONObject config)

BasicSource

protected BasicSource()

Method Detail

isEof

public boolean isEof()

Description copied from interface: Source

Is the source at EOF? Not all sources are bounded, so they may always return false.

Specified by:

isEof in interface Source

Returns:

true if the source is at EOF

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

requeue

public void requeue(MessageAndRouting msgAndRoute)

Description copied from interface: Source

Requeue a message for delivery into the given pipeline

Specified by:

requeue in interface Source

getNextMessage

public final MessageAndRouting getNextMessage(StreamProcessingContext spc,
                                              long timeUnit,
                                              TimeUnit units)
                                       throws IOException,
                                              InterruptedException

This basic implementation polls the internalGetNextMessage call periodically until it returns a message, or the operation time limit is reached. It also pulls from the requeue list with priority.

Specified by:

getNextMessage in interface Source

Returns:

the next message with routing, or null if none are available

Throws:

IOException

InterruptedException

markComplete

public void markComplete(StreamProcessingContext spc,
                         MessageAndRouting mr)

Description copied from interface: Source

Called by the processing engine when processing for a given message is complete.

Specified by:

markComplete in interface Source

internalGetNextMessage

protected abstract MessageAndRouting internalGetNextMessage(StreamProcessingContext spc)
                                                     throws IOException,
                                                            InterruptedException

Get the next pending message, if any.

Parameters:

spc -

Returns:

the next message, or null

Throws:

IOException

InterruptedException

getBackoffTimes

protected long[] getBackoffTimes()

makeDefRoutingMessage

protected MessageAndRouting makeDefRoutingMessage(Message msg)

noteEndOfStream

protected void noteEndOfStream()