org.symphonyoss.s2.fugue.pubsub

Class AbstractSubscriberAdmin<P,T extends ISubscriberAdmin & org.symphonyoss.s2.common.fluent.IFluent<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.AbstractSubscriberAdmin<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, ISubscriberAdmin

public abstract class AbstractSubscriberAdmin<P,T extends ISubscriberAdmin & org.symphonyoss.s2.common.fluent.IFluent<T>>
extends AbstractSubscriberBase<P,T>
implements ISubscriberAdmin

Base class for subscriber managers.

Author:

Bruce Skingle

Field Summary

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

nameFactory_, subscribers_

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSubscriberAdmin(INameFactory nameFactory, Class<T> type)

Method Summary

Modifier and Type	Method and Description
protected void	assertConfigurable()
protected abstract void	createSubcription(TopicName topicName, SubscriptionName subscriptionName, boolean dryRun)
void	createSubscriptions(boolean dryRun) Create all configured subscriptions.
protected abstract void	deleteSubcription(TopicName topicName, SubscriptionName subscriptionName, boolean dryRun)
void	deleteSubscriptions(boolean dryRun) Delete all configured subscriptions.
protected void	setLifeCycleState(FugueLifecycleState arg0)
void	start()
void	stop()
T	withSubscription(String subscriptionId, Collection<TopicName> topicNames) Subscribe to the given subscription on the given topics.
T	withSubscription(String subscriptionId, String[] topicNames) Subscribe to the given subscription on the given topics.
T	withSubscription(String subscriptionId, String topicId, String... additionalTopicIds) Subscribe to the given subscription on the given topics.
ISubscriberAdmin	withSubscription(Subscription subscription)

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

getSubscribers, getTotalSubscriptionCnt, withSubscription, withSubscription, withSubscription, withSubscription

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.fugue.IFugueComponent

getComponentId, getComponentState, getComponentStatusMessage, quiesce

Constructor Detail

AbstractSubscriberAdmin

protected AbstractSubscriberAdmin(INameFactory nameFactory,
                                  Class<T> type)

Method Detail

withSubscription

public ISubscriberAdmin withSubscription(Subscription subscription)

Specified by:

withSubscription in interface ISubscriberAdmin

withSubscription

public T withSubscription(String subscriptionId,
                          String topicId,
                          String... additionalTopicIds)

Description copied from interface: ISubscriberAdmin

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 ISubscriberAdmin

Parameters:

subscriptionId - A subscription name.

topicId - A topic name.

additionalTopicIds - An optional list of additional topic names.

Returns:

this (fluent method)

withSubscription

public T withSubscription(String subscriptionId,
                          Collection<TopicName> topicNames)

Description copied from interface: ISubscriberAdmin

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 ISubscriberAdmin

Parameters:

subscriptionId - A subscription name.

topicNames - A list of topic names.

Returns:

this (fluent method)

withSubscription

public T withSubscription(String subscriptionId,
                          String[] topicNames)

Description copied from interface: ISubscriberAdmin

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 ISubscriberAdmin

Parameters:

subscriptionId - A subscription name.

topicNames - A list of topic names.

Returns:

this (fluent method)

start

public void start()

Specified by:

start in interface IFugueComponent

stop

public void stop()

Specified by:

stop in interface IFugueComponent

createSubcription

protected abstract void createSubcription(TopicName topicName,
                                          SubscriptionName subscriptionName,
                                          boolean dryRun)

deleteSubcription

protected abstract void deleteSubcription(TopicName topicName,
                                          SubscriptionName subscriptionName,
                                          boolean dryRun)

createSubscriptions

public void createSubscriptions(boolean dryRun)

Description copied from interface: ISubscriberAdmin

Create all configured subscriptions.

Specified by:

createSubscriptions in interface ISubscriberAdmin

Parameters:

dryRun - If true then don't change anything

deleteSubscriptions

public void deleteSubscriptions(boolean dryRun)

Description copied from interface: ISubscriberAdmin

Delete all configured subscriptions.

Specified by:

deleteSubscriptions in interface ISubscriberAdmin

Parameters:

dryRun - If true then don't change anything

assertConfigurable

protected void assertConfigurable()

setLifeCycleState

protected void setLifeCycleState(FugueLifecycleState arg0)