org.symphonyoss.s2.fugue.pubsub

Class AbstractSubscriberManager<P,T extends ISubscriberManager<P,T>>

java.lang.Object

org.symphonyoss.s2.common.fluent.Fluent<T>

org.symphonyoss.s2.fugue.FugueLifecycleComponent<T>

org.symphonyoss.s2.fugue.pubsub.AbstractSubscriberBase<P,T>

org.symphonyoss.s2.fugue.pubsub.AbstractSubscriberManager<P,T>

Type Parameters:

P - Type of payload received.

T - Type of concrete manager, needed for fluent methods.

All Implemented Interfaces:

org.symphonyoss.s2.common.fluent.IFluent<T>, IFugueComponent, IFugueLifecycleComponent, ISubscriberManager<P,T>

public abstract class AbstractSubscriberManager<P,T extends ISubscriberManager<P,T>>
extends AbstractSubscriberBase<P,T>
implements ISubscriberManager<P,T>

Base class for subscriber managers.

Author:

Bruce Skingle

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	FAILED_CONSUMER_RETRY_TIME
protected static long	FAILED_DEAD_LETTER_RETRY_TIME
protected static long	MESSAGE_PROCESSED_OK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSubscriberManager(Class<T> type, ITraceContextFactory traceFactory, IThreadSafeErrorConsumer<P> unprocessableMessageConsumer)

Method Summary

Modifier and Type	Method and Description
protected void	assertConfigurable()
protected ITraceContextFactory	getTraceFactory()
long	handleMessage(IThreadSafeRetryableConsumer<P> consumer, P payload, ITraceContext trace, String messageId) Handle the given message.
protected void	setLifeCycleState(FugueLifecycleState arg0)
void	start()
protected abstract void	startSubscription(Subscription<P> subscription)
void	stop()
protected abstract void	stopSubscriptions() Stop all subscribers.
T	withSubscription(IThreadSafeRetryableConsumer<P> consumer, String subscriptionName, List<String> topicNames) Subscribe to the given subscription on the given topics.
T	withSubscription(IThreadSafeRetryableConsumer<P> consumer, String subscriptionName, String[] topicNames) Subscribe to the given subscription on the given topics.
T	withSubscription(IThreadSafeRetryableConsumer<P> consumer, String subscriptionName, String topicName, String... additionalTopicNames) Subscribe to the given subscription on the given topics.

Methods inherited from class org.symphonyoss.s2.fugue.pubsub.AbstractSubscriberBase

getSubscribers

Methods inherited from class org.symphonyoss.s2.common.fluent.Fluent

self

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.symphonyoss.s2.common.fluent.IFluent

self

Methods inherited from interface org.symphonyoss.s2.fugue.IFugueComponent

getComponentId, getComponentState, getComponentStatusMessage

Field Detail

FAILED_DEAD_LETTER_RETRY_TIME

protected static final long FAILED_DEAD_LETTER_RETRY_TIME

FAILED_CONSUMER_RETRY_TIME

protected static final long FAILED_CONSUMER_RETRY_TIME

MESSAGE_PROCESSED_OK

protected static final long MESSAGE_PROCESSED_OK

See Also:

Constant Field Values

Constructor Detail

AbstractSubscriberManager

protected AbstractSubscriberManager(Class<T> type,
                                    ITraceContextFactory traceFactory,
                                    IThreadSafeErrorConsumer<P> unprocessableMessageConsumer)

Method Detail

withSubscription

public T withSubscription(IThreadSafeRetryableConsumer<P> consumer,
                          String subscriptionName,
                          String topicName,
                          String... additionalTopicNames)

Description copied from interface: ISubscriberManager

Subscribe to the given subscription on the given topics. This method allows for the creation of the same subscription on one or more topics, the same consumer will receive messages received on the given subscription on any of the topics. The topics are all treated in the same way, the method is declared with topic and additionalTopics to ensure that at least one topic is provided. This method does the same thing as the other withSubscription methods, alternative signatures are provided as a convenience.

Specified by:

withSubscription in interface ISubscriberManager<P,T extends ISubscriberManager<P,T>>

Overrides:

withSubscription in class AbstractSubscriberBase<P,T extends ISubscriberManager<P,T>>

Parameters:

consumer - A consumer for received messages.

subscriptionName - A subscription name.

topicName - A topic name.

additionalTopicNames - An optional list of additional topic names.

Returns:

this (fluent method)

withSubscription

public T withSubscription(IThreadSafeRetryableConsumer<P> consumer,
                          String subscriptionName,
                          List<String> topicNames)

Description copied from interface: ISubscriberManager

Subscribe to the given subscription on the given topics. This method allows for the creation of the same subscription on one or more topics, the same consumer will receive messages received on the given subscription on any of the topics. The topics are all treated in the same way, the method is declared with topic and additionalTopics to ensure that at least one topic is provided. This method does the same thing as the other withSubscription methods, alternative signatures are provided as a convenience.

Specified by:

withSubscription in interface ISubscriberManager<P,T extends ISubscriberManager<P,T>>

Overrides:

withSubscription in class AbstractSubscriberBase<P,T extends ISubscriberManager<P,T>>

Parameters:

consumer - A consumer for received messages.

subscriptionName - A subscription name.

topicNames - A list of topic names.

Returns:

this (fluent method)

withSubscription

public T withSubscription(IThreadSafeRetryableConsumer<P> consumer,
                          String subscriptionName,
                          String[] topicNames)

Description copied from interface: ISubscriberManager

Subscribe to the given subscription on the given topics. This method allows for the creation of the same subscription on one or more topics, the same consumer will receive messages received on the given subscription on any of the topics. The topics are all treated in the same way, the method is declared with topic and additionalTopics to ensure that at least one topic is provided. This method does the same thing as the other withSubscription methods, alternative signatures are provided as a convenience.

Specified by:

withSubscription in interface ISubscriberManager<P,T extends ISubscriberManager<P,T>>

Overrides:

withSubscription in class AbstractSubscriberBase<P,T extends ISubscriberManager<P,T>>

Parameters:

consumer - A consumer for received messages.

subscriptionName - A subscription name.

topicNames - A list of topic names.

Returns:

this (fluent method)

startSubscription

protected abstract void startSubscription(Subscription<P> subscription)

stopSubscriptions

protected abstract void stopSubscriptions()

Stop all subscribers.

getTraceFactory

protected ITraceContextFactory getTraceFactory()

start

public void start()

Specified by:

start in interface IFugueComponent

stop

public void stop()

Specified by:

stop in interface IFugueComponent

handleMessage

public long handleMessage(IThreadSafeRetryableConsumer<P> consumer,
                          P payload,
                          ITraceContext trace,
                          String messageId)

Handle the given message.

Parameters:

consumer - The consumer for the message.

payload - A received message.

trace - A trace context.

messageId - A unique ID for the message.

Returns:

The number of milliseconds after which a retry should be made, or -1 if the message was processed and no retry is necessary.

assertConfigurable

protected void assertConfigurable()

setLifeCycleState

protected void setLifeCycleState(FugueLifecycleState arg0)