io.jenkins.plugins.aws.kinesisconsumer.extensions

Class AWSKinesisStreamListener

java.lang.Object

io.jenkins.plugins.aws.kinesisconsumer.extensions.AWSKinesisStreamListener

All Implemented Interfaces:

ExtensionPoint

public abstract class AWSKinesisStreamListener
extends Object
implements ExtensionPoint

Extension point to implement by external applications to listen to records coming from a Kinesis stream. The external application has to:

• Specify which stream to listen to overriding getStreamName()
• Implement the logic upon record receive by overriding onReceive(byte[])

Author:

Fabio Ponciroli

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
AWSKinesisStreamListener()

Method Summary

Modifier and Type	Method and Description
static void	fireOnReceive(String streamName, byte[] byteRecord)
static ExtensionList<AWSKinesisStreamListener>	getAllRegisteredListeners() Gets all listeners.
abstract String	getStreamName() This needs to be overridden to specify which Kinesis record to listen
abstract void	onReceive(byte[] byteRecord) This needs to be overridden to implement the logic upon record receive

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSKinesisStreamListener

public AWSKinesisStreamListener()

Method Detail

getStreamName

public abstract String getStreamName()

This needs to be overridden to specify which Kinesis record to listen

Returns:

Kinesis stream name to listen

onReceive

public abstract void onReceive(byte[] byteRecord)

This needs to be overridden to implement the logic upon record receive

Parameters:

byteRecord - input byte record to process

fireOnReceive

public static void fireOnReceive(String streamName,
                                 byte[] byteRecord)

getAllRegisteredListeners

public static ExtensionList<AWSKinesisStreamListener> getAllRegisteredListeners()

Gets all listeners.

Returns:

the extension list.