org.apache.kafka.streams.processor

Class AbstractProcessor<K,V>

java.lang.Object

org.apache.kafka.streams.processor.AbstractProcessor<K,V>

Type Parameters:

K - the type of keys

V - the type of values

All Implemented Interfaces:

Processor<K,V>

public abstract class AbstractProcessor<K,V>
extends java.lang.Object
implements Processor<K,V>

An abstract implementation of Processor that manages the ProcessorContext instance and provides default no-op implementations of punctuate(long) and close().

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProcessor()

Method Summary

Modifier and Type	Method and Description
void	close() Close this processor and clean up any resources.
protected ProcessorContext	context() Get the processor's context set during initialization.
void	init(ProcessorContext context) Initialize this processor with the given context.
void	punctuate(long timestamp) Perform any periodic operations, if this processor schedule itself with the context during initialization.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.streams.processor.Processor

process

Constructor Detail

AbstractProcessor

protected AbstractProcessor()

Method Detail

init

public void init(ProcessorContext context)

Description copied from interface: Processor

Initialize this processor with the given context. The framework ensures this is called once per processor when the topology that contains it is initialized.

The provided context can be used to access topology and record meta data, to schedule a method to be called periodically and to access attached StateStores.

Specified by:

init in interface Processor<K,V>

Parameters:

context - the context; may not be null

punctuate

public void punctuate(long timestamp)

Perform any periodic operations, if this processor schedule itself with the context during initialization.

This method does nothing by default; if desired, subclasses should override it with custom functionality.

Specified by:

punctuate in interface Processor<K,V>

Parameters:

timestamp - the wallclock time when this method is being called

close

public void close()

Close this processor and clean up any resources.

This method does nothing by default; if desired, subclasses should override it with custom functionality.

Specified by:

close in interface Processor<K,V>

context

protected final ProcessorContext context()

Get the processor's context set during initialization.

Returns:

the processor context; null only when called prior to initialization.