com.adobe.granite.offloading.api

Interface OffloadingTopicManager

public interface OffloadingTopicManager

The OffloadingTopicManager manages instance blacklisting / whitelisting for specific topics. Furthermore, it provides a view of the instances grouped by topic. Clients outside offloading must not use this interface.

Method Summary

Modifier and Type	Method and Description
void	configureInstance(java.lang.String slingID, java.util.Map<TopicConfigurationAction,java.util.Set<java.lang.String>> configuration) Configures the topics an instance will process using a configuration map structured in the following way:
java.util.Set<java.lang.String>	getBlacklistedTopics(InstanceDescription instance) Retrieves the blacklisted topics from an instance.
java.util.Map<java.lang.String,TopicInstancesHolder>	getInstances() Provides a Map view of all the instances from the topology.
java.util.Set<java.lang.String>	getRegisteredTopics(InstanceDescription instance) Retrieves the topics registered for processing from an instance.
java.util.Set<java.lang.String>	getWhitelistedTopics(InstanceDescription instance) Retrieves the whitelisted topics from an instance.

Method Detail

getInstances

java.util.Map<java.lang.String,TopicInstancesHolder> getInstances()

Provides a Map view of all the instances from the topology.

Returns:

a map of instances grouped by topic

configureInstance

void configureInstance(java.lang.String slingID,
                       java.util.Map<TopicConfigurationAction,java.util.Set<java.lang.String>> configuration)

Configures the topics an instance will process using a configuration map structured in the following way:

• key - one of: exclusive, enable, disable (for more details see TopicConfigurationAction
• value - a set of topic strings

The topics marked as exclusive will be added to the exclusive whitelist. The topics marked otherwise will just be added / removed from the blacklist.

Parameters:

slingID - the slingID of the instance to be configured

configuration - a configuration map.

Throws:

OffloadingException - if the configuration operation fails

getRegisteredTopics

java.util.Set<java.lang.String> getRegisteredTopics(InstanceDescription instance)

Retrieves the topics registered for processing from an instance.

Parameters:

instance - the instance

Returns:

a set of topics

getWhitelistedTopics

java.util.Set<java.lang.String> getWhitelistedTopics(InstanceDescription instance)

Retrieves the whitelisted topics from an instance.

Parameters:

instance - the instance

Returns:

a set of topics

getBlacklistedTopics

java.util.Set<java.lang.String> getBlacklistedTopics(InstanceDescription instance)

Retrieves the blacklisted topics from an instance.

Parameters:

instance - the instance

Returns:

a set of topics