org.apache.pulsar.storm

Class PulsarSpoutConfiguration

java.lang.Object

org.apache.pulsar.storm.PulsarStormConfiguration

org.apache.pulsar.storm.PulsarSpoutConfiguration

All Implemented Interfaces:

Serializable

public class PulsarSpoutConfiguration
extends PulsarStormConfiguration

Class used to specify pulsar spout configuration

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_FAILED_RETRIES_TIMEOUT_NANO
static int	DEFAULT_MAX_FAILED_RETRIES

Fields inherited from class org.apache.pulsar.storm.PulsarStormConfiguration

DEFAULT_METRICS_TIME_INTERVAL_IN_SECS

Constructor Summary

Constructors

Constructor and Description
PulsarSpoutConfiguration()

Method Summary

Modifier and Type	Method and Description
long	getFailedRetriesTimeout(TimeUnit unit)
int	getMaxFailedRetries()
MessageToValuesMapper	getMessageToValuesMapper()
String	getSubscriptionName()
boolean	isSharedConsumerEnabled()
void	setFailedRetriesTimeout(long failedRetriesTimeout, TimeUnit unit) Sets the timeout within which the spout will re-inject failed messages with an exponential backoff (default: 60 seconds) Note: If set to 0, the message will not be retried when failed.
void	setMaxFailedRetries(int maxFailedRetries) Sets the maximum number of times the spout will re-inject failed messages with an exponential backoff (default: -1) Note: If set to 0, the message will not be retried when failed.
void	setMessageToValuesMapper(MessageToValuesMapper mapper) Sets the mapper to convert pulsar message to a storm tuple.
void	setSharedConsumerEnabled(boolean sharedConsumerEnabled) Sets whether the consumer will be shared across different executors of a spout.
void	setSubscriptionName(String subscriptionName) Sets the subscription name for the consumer in the spout

Methods inherited from class org.apache.pulsar.storm.PulsarStormConfiguration

getMetricsTimeIntervalInSecs, getServiceUrl, getTopic, setMetricsTimeIntervalInSecs, setServiceUrl, setTopic

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FAILED_RETRIES_TIMEOUT_NANO

public static final long DEFAULT_FAILED_RETRIES_TIMEOUT_NANO

DEFAULT_MAX_FAILED_RETRIES

public static final int DEFAULT_MAX_FAILED_RETRIES

See Also:

Constant Field Values

Constructor Detail

PulsarSpoutConfiguration

public PulsarSpoutConfiguration()

Method Detail

getSubscriptionName

public String getSubscriptionName()

Returns:

the subscription name for the consumer in the spout

setSubscriptionName

public void setSubscriptionName(String subscriptionName)

Sets the subscription name for the consumer in the spout

Parameters:

subscriptionName -

getMessageToValuesMapper

public MessageToValuesMapper getMessageToValuesMapper()

Returns:

the mapper to convert pulsar message to a storm tuple

setMessageToValuesMapper

public void setMessageToValuesMapper(MessageToValuesMapper mapper)

Sets the mapper to convert pulsar message to a storm tuple.

Note: If the mapper returns null, the message is not emitted to the collector and is acked immediately

Parameters:

mapper -

getFailedRetriesTimeout

public long getFailedRetriesTimeout(TimeUnit unit)

Parameters:

unit -

Returns:

the timeout for retrying failed messages

setFailedRetriesTimeout

public void setFailedRetriesTimeout(long failedRetriesTimeout,
                                    TimeUnit unit)

Sets the timeout within which the spout will re-inject failed messages with an exponential backoff (default: 60 seconds) Note: If set to 0, the message will not be retried when failed. If set to < 0, the message will be retried forever till it is successfully processed or max message retry count is reached, whichever comes first.

Parameters:

failedRetriesTimeout -

unit -

getMaxFailedRetries

public int getMaxFailedRetries()

Returns:

the maximum number of times a failed message will be retried

setMaxFailedRetries

public void setMaxFailedRetries(int maxFailedRetries)

Sets the maximum number of times the spout will re-inject failed messages with an exponential backoff (default: -1) Note: If set to 0, the message will not be retried when failed. If set to < 0, the message will be retried forever till it is successfully processed or configured timeout expires, whichever comes first.

Parameters:

maxFailedRetries -

isSharedConsumerEnabled

public boolean isSharedConsumerEnabled()

Returns:

if the consumer is shared across different executors of a spout

setSharedConsumerEnabled

public void setSharedConsumerEnabled(boolean sharedConsumerEnabled)

Sets whether the consumer will be shared across different executors of a spout. (default: false)

Parameters:

sharedConsumerEnabled -