Package com.adaptris.kafka

Class PollingKafkaConsumer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.core.AdaptrisPollingConsumer

com.adaptris.kafka.PollingKafkaConsumer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, StateManagedComponent, LoggingContext

@ComponentProfile(summary="Receive messages via Apache Kafka",
                  tag="consumer,kafka",
                  recommended=com.adaptris.core.NullConnection.class)
public class PollingKafkaConsumer
extends AdaptrisPollingConsumer
implements LoggingContext

Wrapper around KafkaConsumer.

In the adapter configuration file this class is aliased as polling-apache-kafka-consumer which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.AdaptrisPollingConsumer

AdaptrisPollingConsumer.LockOperator

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Fields inherited from interface com.adaptris.kafka.LoggingContext

LOGGER

Constructor Summary

Constructors

Constructor	Description
PollingKafkaConsumer()
PollingKafkaConsumer(ConsumerConfigBuilder b)

Method Summary

Modifier and Type	Method	Description
boolean	additionalDebug()
void	close()
java.lang.Boolean	getAdditionalDebug()	Whether or not to log all stacktraces.
@NotNull @NonNull ConsumerConfigBuilder	getConsumerConfig()	Configuration builder for this consumer
TimeInterval	getReceiveTimeout()	Set the receive timeout.
java.lang.String	getTopics()	A comma separated list of topics that you want to consume from.
org.slf4j.Logger	logger()
protected java.lang.String	newThreadName()
protected void	prepareConsumer()
protected int	processMessages()
void	setAdditionalDebug(java.lang.Boolean additionalDebug)	Whether or not to log all stacktraces.
void	setConsumerConfig(@NotNull @NonNull ConsumerConfigBuilder consumerConfig)	Configuration builder for this consumer
void	setReceiveTimeout(TimeInterval receiveTimeout)	Set the receive timeout.
void	setTopics(java.lang.String topics)	A comma separated list of topics that you want to consume from.
void	start()
void	stop()
PollingKafkaConsumer	withTopics(java.lang.String s)

Methods inherited from class com.adaptris.core.AdaptrisPollingConsumer

continueProcessingMessages, getMaxMessagesPerPoll, getPoller, getReacquireLockBetweenMessages, init, prepare, releaseLock, setMaxMessagesPerPoll, setPoller, setReacquireLockBetweenMessages

Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp

changeState, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory, withUniqueID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.AdaptrisMessageConsumer

consumeLocationKey

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Detail

PollingKafkaConsumer

public PollingKafkaConsumer()

PollingKafkaConsumer

public PollingKafkaConsumer(ConsumerConfigBuilder b)

Method Detail

start

public void start()
           throws CoreException

Specified by:

start in interface ComponentLifecycle

Overrides:

start in class AdaptrisPollingConsumer

Throws:

CoreException

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

Overrides:

stop in class AdaptrisPollingConsumer

close

public void close()

Specified by:

close in interface ComponentLifecycle

Overrides:

close in class AdaptrisPollingConsumer

processMessages

protected int processMessages()

Specified by:

processMessages in class AdaptrisPollingConsumer

additionalDebug

public boolean additionalDebug()

Specified by:

additionalDebug in interface LoggingContext

logger

public org.slf4j.Logger logger()

Specified by:

logger in interface LoggingContext

withTopics

public PollingKafkaConsumer withTopics(java.lang.String s)

prepareConsumer

protected void prepareConsumer()
                        throws CoreException

Specified by:

prepareConsumer in class AdaptrisPollingConsumer

Throws:

CoreException

newThreadName

protected java.lang.String newThreadName()

Overrides:

newThreadName in class AdaptrisMessageConsumerImp

getConsumerConfig

@NotNull
@NonNull
public @NotNull @NonNull ConsumerConfigBuilder getConsumerConfig()

Configuration builder for this consumer

setConsumerConfig

public void setConsumerConfig(@NotNull @NonNull
                              @NotNull @NonNull ConsumerConfigBuilder consumerConfig)

Configuration builder for this consumer

Parameters:

consumerConfig -

getReceiveTimeout

public TimeInterval getReceiveTimeout()

Set the receive timeout.

setReceiveTimeout

public void setReceiveTimeout(TimeInterval receiveTimeout)

Set the receive timeout.

Parameters:

receiveTimeout - the receive timout.

getAdditionalDebug

public java.lang.Boolean getAdditionalDebug()

Whether or not to log all stacktraces.

Returns:

the additionalDebug

setAdditionalDebug

public void setAdditionalDebug(java.lang.Boolean additionalDebug)

Whether or not to log all stacktraces.

Parameters:

additionalDebug - , default false

getTopics

public java.lang.String getTopics()

A comma separated list of topics that you want to consume from.

setTopics

public void setTopics(java.lang.String topics)

A comma separated list of topics that you want to consume from.

Parameters:

topics -