com.sdl.delivery.deployer.api.queue

Interface QueueProvider<T extends DeployerQueue>

Type Parameters:

T - used to specify the type of the provided queues.

public interface QueueProvider<T extends DeployerQueue>

Component responsible for providing queues.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_PATH The name of the config element for the queues configuration.
static String	CONFIG_VALUE_ADAPTER_ID Configuration value that holds the Adapter Id.

Method Summary

Modifier and Type	Method and Description
void	configure(com.sdl.delivery.configuration.Configuration configuration) Configure the 'Queue Provider' with the given configuration.
Optional<T>	get(String queueId) Provide the queue by the given queue id.
String	getAdapterId(String queueId) Provide adapter id for given queue id.
List<T>	getAll() Provide all the configured and instantiated queues.
T	getDefault() Provides the default queue.
Optional<T>	getForVerb(String verb) Get a queue for a specific verb.
Set<String>	getIds() Provide all the ids.
Set<String>	getQueueVerbs(String queueId) Provide set of verbs supported by the queue.

Field Detail

CONFIG_PATH

static final String CONFIG_PATH

The name of the config element for the queues configuration.

See Also:

Constant Field Values

CONFIG_VALUE_ADAPTER_ID

static final String CONFIG_VALUE_ADAPTER_ID

Configuration value that holds the Adapter Id. in a Queue configuration.

See Also:

Constant Field Values

Method Detail

configure

void configure(com.sdl.delivery.configuration.Configuration configuration)
        throws com.sdl.delivery.configuration.ConfigurationException

Configure the 'Queue Provider' with the given configuration.

Parameters:

configuration - The given configuration.

Throws:

com.sdl.delivery.configuration.ConfigurationException - if provider could not be configured (i.e. there is no queue configured as default one).

getIds

Set<String> getIds()

Provide all the ids. for the configured queues.

Returns:

All the ids. for the configured queues.

getDefault

T getDefault()

Provides the default queue. Note: Provider MUST be configured before calling this method.

Returns:

The default queue.

get

Optional<T> get(String queueId)

Provide the queue by the given queue id. as a option.

Parameters:

queueId - The given queue id.

Returns:

The queue.

getForVerb

Optional<T> getForVerb(String verb)

Get a queue for a specific verb.

Parameters:

verb - The verb to get the queue for.

Returns:

The queue if present

getAll

List<T> getAll()

Provide all the configured and instantiated queues.

Returns:

All the configured and instantiated queues.

getQueueVerbs

Set<String> getQueueVerbs(String queueId)

Provide set of verbs supported by the queue.

Parameters:

queueId - The given queue id.

Returns:

The set of verbs supported by the queue.

getAdapterId

String getAdapterId(String queueId)

Provide adapter id for given queue id.

Parameters:

queueId - The given queue id.

Returns:

The adapter id for given queue id.