Package org.apache.kafka.streams.processor.internals

Class ForwardingDisabledProcessorContext

java.lang.Object

org.apache.kafka.streams.processor.internals.ForwardingDisabledProcessorContext

All Implemented Interfaces:

ProcessorContext

public final class ForwardingDisabledProcessorContext
extends Object
implements ProcessorContext

ProcessorContext implementation that will throw on any forward call.

Constructor Summary

Constructors

Constructor	Description
ForwardingDisabledProcessorContext(ProcessorContext delegate)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	appConfigs()	Returns all the application config properties as key/value pairs.
Map<String,Object>	appConfigsWithPrefix(String prefix)	Returns all the application config properties with the given key prefix, as key/value pairs stripping the prefix.
String	applicationId()	Returns the application id.
String	applicationInternalStream()	Returns the application internal stream name
void	commit()	Requests a commit.
<K,V> void	forward(K key, V value)	Forwards a key/value pair to all downstream processors.
<K,V> void	forward(K key, V value, int childIndex)	Deprecated.
<K,V> void	forward(K key, V value, String childName)	Deprecated.
<K,V> void	forward(K key, V value, To to)	Forwards a key/value pair to the specified downstream processors.
StateStore	getStateStore(String name)	Get the state store given the store name.
Headers	headers()	Returns the headers of the current input record; could be null if it is not available (for example, if this method is invoked from the punctuate call).
Serde<?>	keySerde()	Returns the default key serde.
StreamsMetrics	metrics()	Returns Metrics instance.
long	offset()	Returns the offset of the current input record; could be -1 if it is not available (for example, if this method is invoked from the punctuate call).
int	partition()	Returns the partition id of the current input record; could be -1 if it is not available (for example, if this method is invoked from the punctuate call).
void	register(StateStore store, StateRestoreCallback stateRestoreCallback)	Registers and possibly restores the specified storage engine.
Cancellable	schedule(long intervalMs, PunctuationType type, Punctuator callback)	Deprecated.
Cancellable	schedule(Duration interval, PunctuationType type, Punctuator callback)	Schedules a periodic operation for processors.
File	stateDir()	Returns the state directory for the partition.
TaskId	taskId()	Returns the task id.
long	timestamp()	Returns the current timestamp.
String	topic()	Returns the topic name of the current input record; could be null if it is not available (for example, if this method is invoked from the punctuate call).
Serde<?>	valueSerde()	Returns the default value serde.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingDisabledProcessorContext

public ForwardingDisabledProcessorContext(ProcessorContext delegate)

Method Detail

applicationId

public String applicationId()

Description copied from interface: ProcessorContext

Returns the application id.

Specified by:

applicationId in interface ProcessorContext

Returns:

the application id

applicationInternalStream

public String applicationInternalStream()

Description copied from interface: ProcessorContext

Returns the application internal stream name

Specified by:

applicationInternalStream in interface ProcessorContext

Returns:

the application internal stream

taskId

public TaskId taskId()

Description copied from interface: ProcessorContext

Returns the task id.

Specified by:

taskId in interface ProcessorContext

Returns:

the task id

keySerde

public Serde<?> keySerde()

Description copied from interface: ProcessorContext

Returns the default key serde.

Specified by:

keySerde in interface ProcessorContext

Returns:

the key serializer

valueSerde

public Serde<?> valueSerde()

Description copied from interface: ProcessorContext

Returns the default value serde.

Specified by:

valueSerde in interface ProcessorContext

Returns:

the value serializer

stateDir

public File stateDir()

Description copied from interface: ProcessorContext

Returns the state directory for the partition.

Specified by:

stateDir in interface ProcessorContext

Returns:

the state directory

metrics

public StreamsMetrics metrics()

Description copied from interface: ProcessorContext

Returns Metrics instance.

Specified by:

metrics in interface ProcessorContext

Returns:

StreamsMetrics

register

public void register(StateStore store,
                     StateRestoreCallback stateRestoreCallback)

Description copied from interface: ProcessorContext

Registers and possibly restores the specified storage engine.

Specified by:

register in interface ProcessorContext

Parameters:

store - the storage engine

stateRestoreCallback - the restoration callback logic for log-backed state stores upon restart

getStateStore

public StateStore getStateStore(String name)

Description copied from interface: ProcessorContext

Get the state store given the store name.

Specified by:

getStateStore in interface ProcessorContext

Parameters:

name - The store name

Returns:

The state store instance

schedule

@Deprecated
public Cancellable schedule(long intervalMs,
                            PunctuationType type,
                            Punctuator callback)

Deprecated.

Description copied from interface: ProcessorContext

Schedules a periodic operation for processors. A processor may call this method during initialization or processing to schedule a periodic callback — called a punctuation — to Punctuator.punctuate(long). The type parameter controls what notion of time is used for punctuation:

• PunctuationType.STREAM_TIME — uses "stream time", which is advanced by the processing of messages in accordance with the timestamp as extracted by the TimestampExtractor in use. The first punctuation will be triggered by the first record that is processed. NOTE: Only advanced if messages arrive
• PunctuationType.WALL_CLOCK_TIME — uses system time (the wall-clock time), which is advanced independent of whether new messages arrive. The first punctuation will be triggered after interval has elapsed. NOTE: This is best effort only as its granularity is limited by how long an iteration of the processing loop takes to complete

Skipping punctuations: Punctuations will not be triggered more than once at any given timestamp. This means that "missed" punctuation will be skipped. It's possible to "miss" a punctuation if:

• with PunctuationType.STREAM_TIME, when stream time advances more than interval
• with PunctuationType.WALL_CLOCK_TIME, on GC pause, too short interval, ...

Specified by:

schedule in interface ProcessorContext

Parameters:

intervalMs - the time interval between punctuations in milliseconds

type - one of: PunctuationType.STREAM_TIME, PunctuationType.WALL_CLOCK_TIME

callback - a function consuming timestamps representing the current stream or system time

Returns:

a handle allowing cancellation of the punctuation schedule established by this method

schedule

public Cancellable schedule(Duration interval,
                            PunctuationType type,
                            Punctuator callback)
                     throws IllegalArgumentException

Description copied from interface: ProcessorContext

Schedules a periodic operation for processors. A processor may call this method during initialization or processing to schedule a periodic callback — called a punctuation — to Punctuator.punctuate(long). The type parameter controls what notion of time is used for punctuation:

• PunctuationType.STREAM_TIME — uses "stream time", which is advanced by the processing of messages in accordance with the timestamp as extracted by the TimestampExtractor in use. The first punctuation will be triggered by the first record that is processed. NOTE: Only advanced if messages arrive
• PunctuationType.WALL_CLOCK_TIME — uses system time (the wall-clock time), which is advanced independent of whether new messages arrive. The first punctuation will be triggered after interval has elapsed. NOTE: This is best effort only as its granularity is limited by how long an iteration of the processing loop takes to complete

Skipping punctuations: Punctuations will not be triggered more than once at any given timestamp. This means that "missed" punctuation will be skipped. It's possible to "miss" a punctuation if:

• with PunctuationType.STREAM_TIME, when stream time advances more than interval
• with PunctuationType.WALL_CLOCK_TIME, on GC pause, too short interval, ...

Specified by:

schedule in interface ProcessorContext

Parameters:

interval - the time interval between punctuations (supported minimum is 1 millisecond)

type - one of: PunctuationType.STREAM_TIME, PunctuationType.WALL_CLOCK_TIME

callback - a function consuming timestamps representing the current stream or system time

Returns:

a handle allowing cancellation of the punctuation schedule established by this method

Throws:

IllegalArgumentException

forward

public <K,V> void forward(K key,
                                V value)

Description copied from interface: ProcessorContext

Forwards a key/value pair to all downstream processors. Used the input record's timestamp as timestamp for the output record.

Specified by:

forward in interface ProcessorContext

Parameters:

key - key

value - value

forward

public <K,V> void forward(K key,
                                V value,
                                To to)

Description copied from interface: ProcessorContext

Forwards a key/value pair to the specified downstream processors. Can be used to set the timestamp of the output record.

Specified by:

forward in interface ProcessorContext

Parameters:

key - key

value - value

to - the options to use when forwarding

forward

@Deprecated
public <K,V> void forward(K key,
                                V value,
                                int childIndex)

Deprecated.

Description copied from interface: ProcessorContext

Forwards a key/value pair to one of the downstream processors designated by childIndex.

Specified by:

forward in interface ProcessorContext

Parameters:

key - key

value - value

childIndex - index in list of children of this node

forward

@Deprecated
public <K,V> void forward(K key,
                                V value,
                                String childName)

Deprecated.

Description copied from interface: ProcessorContext

Forwards a key/value pair to one of the downstream processors designated by the downstream processor name.

Specified by:

forward in interface ProcessorContext

Parameters:

key - key

value - value

childName - name of downstream processor

commit

public void commit()

Description copied from interface: ProcessorContext

Requests a commit.

Specified by:

commit in interface ProcessorContext

topic

public String topic()

Description copied from interface: ProcessorContext

Returns the topic name of the current input record; could be null if it is not available (for example, if this method is invoked from the punctuate call).

Specified by:

topic in interface ProcessorContext

Returns:

the topic name

partition

public int partition()

Description copied from interface: ProcessorContext

Returns the partition id of the current input record; could be -1 if it is not available (for example, if this method is invoked from the punctuate call).

Specified by:

partition in interface ProcessorContext

Returns:

the partition id

offset

public long offset()

Description copied from interface: ProcessorContext

Returns the offset of the current input record; could be -1 if it is not available (for example, if this method is invoked from the punctuate call).

Specified by:

offset in interface ProcessorContext

Returns:

the offset

headers

public Headers headers()

Description copied from interface: ProcessorContext

Returns the headers of the current input record; could be null if it is not available (for example, if this method is invoked from the punctuate call).

Specified by:

headers in interface ProcessorContext

Returns:

the headers

timestamp

public long timestamp()

Description copied from interface: ProcessorContext

Returns the current timestamp.

If it is triggered while processing a record streamed from the source processor, timestamp is defined as the timestamp of the current input record; the timestamp is extracted from ConsumerRecord by TimestampExtractor.

If it is triggered while processing a record generated not from the source processor (for example, if this method is invoked from the punctuate call), timestamp is defined as the current task's stream time, which is defined as the largest timestamp of any record processed by the task.

Specified by:

timestamp in interface ProcessorContext

Returns:

the timestamp

appConfigs

public Map<String,Object> appConfigs()

Description copied from interface: ProcessorContext

Returns all the application config properties as key/value pairs.

The config properties are defined in the StreamsConfig object and associated to the ProcessorContext.

The type of the values is dependent on the type of the property (e.g. the value of DEFAULT_KEY_SERDE_CLASS_CONFIG will be of type Class, even if it was specified as a String to StreamsConfig(Map)).

Specified by:

appConfigs in interface ProcessorContext

Returns:

all the key/values from the StreamsConfig properties

appConfigsWithPrefix

public Map<String,Object> appConfigsWithPrefix(String prefix)

Description copied from interface: ProcessorContext

Returns all the application config properties with the given key prefix, as key/value pairs stripping the prefix.

The config properties are defined in the StreamsConfig object and associated to the ProcessorContext.

Specified by:

appConfigsWithPrefix in interface ProcessorContext

Parameters:

prefix - the properties prefix

Returns:

the key/values matching the given prefix from the StreamsConfig properties.