org.symphonyoss.s2.fugue.pubsub

Interface ISubscriberAdmin

All Known Implementing Classes:

AbstractSubscriberAdmin

public interface ISubscriberAdmin

A subscriber admin controller.

Author:

Bruce Skingle

Method Summary

Modifier and Type	Method and Description
void	createSubscriptions(boolean dryRun) Create all configured subscriptions.
void	deleteSubscriptions(boolean dryRun) Delete all configured subscriptions.
ISubscriberAdmin	withSubscription(String subscriptionName, Collection<TopicName> topicNames) Subscribe to the given subscription on the given topics.
ISubscriberAdmin	withSubscription(String subscriptionName, String[] topicNames) Subscribe to the given subscription on the given topics.
ISubscriberAdmin	withSubscription(String subscriptionName, String topicName, String... additionalTopicNames) Subscribe to the given subscription on the given topics.
ISubscriberAdmin	withSubscription(Subscription subscription)

Method Detail

withSubscription

ISubscriberAdmin withSubscription(Subscription subscription)

withSubscription

ISubscriberAdmin withSubscription(String subscriptionName,
                                  String topicName,
                                  String... additionalTopicNames)

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.

Parameters:

subscriptionName - A subscription name.

topicName - A topic name.

additionalTopicNames - An optional list of additional topic names.

Returns:

this (fluent method)

withSubscription

ISubscriberAdmin withSubscription(String subscriptionName,
                                  Collection<TopicName> topicNames)

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.

Parameters:

subscriptionName - A subscription name.

topicNames - A list of topic names.

Returns:

this (fluent method)

Throws:

IllegalArgumentException - If the list of topics is empty.

withSubscription

ISubscriberAdmin withSubscription(String subscriptionName,
                                  String[] topicNames)

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.

Parameters:

subscriptionName - A subscription name.

topicNames - A list of topic names.

Returns:

this (fluent method)

Throws:

IllegalArgumentException - If the list of topics is empty.

createSubscriptions

void createSubscriptions(boolean dryRun)

Create all configured subscriptions.

Parameters:

dryRun - If true then don't change anything

deleteSubscriptions

void deleteSubscriptions(boolean dryRun)

Delete all configured subscriptions.

Parameters:

dryRun - If true then don't change anything