org.apache.storm.kafka

Interface FailedMsgRetryManager

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ExponentialBackoffMsgRetryManager

public interface FailedMsgRetryManager
extends java.io.Serializable

Method Summary

Modifier and Type	Method and Description
void	acked(java.lang.Long offset) Message corresponding to the offset, was acked to kafka spout.
java.util.Set<java.lang.Long>	clearOffsetsBefore(java.lang.Long kafkaOffset) Clear any offsets before kafkaOffset.
void	failed(java.lang.Long offset) Message corresponding to the offset failed in kafka spout.
java.lang.Long	nextFailedMessageToRetry() The offset of message, which is to be re-emitted.
void	prepare(SpoutConfig spoutConfig, java.util.Map<java.lang.String,java.lang.Object> stormConf) Initialization
boolean	retryFurther(java.lang.Long offset) Spout will clean up the state for this offset if false is returned.
void	retryStarted(java.lang.Long offset) Message corresponding to the offset, has been re-emitted and under transit.
boolean	shouldReEmitMsg(java.lang.Long offset) Decide whether the message corresponding to the offset should be emitted NOW

Method Detail

prepare

void prepare(SpoutConfig spoutConfig,
             java.util.Map<java.lang.String,java.lang.Object> stormConf)

Initialization

failed

void failed(java.lang.Long offset)

Message corresponding to the offset failed in kafka spout.

Parameters:

offset -

acked

void acked(java.lang.Long offset)

Message corresponding to the offset, was acked to kafka spout.

Parameters:

offset -

retryStarted

void retryStarted(java.lang.Long offset)

Message corresponding to the offset, has been re-emitted and under transit.

Parameters:

offset -

nextFailedMessageToRetry

java.lang.Long nextFailedMessageToRetry()

The offset of message, which is to be re-emitted. Spout will fetch messages starting from this offset and resend them, except completed messages.

Returns:

shouldReEmitMsg

boolean shouldReEmitMsg(java.lang.Long offset)

Decide whether the message corresponding to the offset should be emitted NOW

Parameters:

offset -

Returns:

True if the message corresponding to the offset should be emitted NOW. False otherwise.

retryFurther

boolean retryFurther(java.lang.Long offset)

Spout will clean up the state for this offset if false is returned.

Parameters:

offset -

Returns:

True if the message will be retried again. False otherwise.

clearOffsetsBefore

java.util.Set<java.lang.Long> clearOffsetsBefore(java.lang.Long kafkaOffset)

Clear any offsets before kafkaOffset. These offsets are no longer available in kafka.

Parameters:

kafkaOffset -

Returns:

Set of offsets removed.