com.sdl.delivery.deployer.api.queue

Interface QueueAdapter<T extends DeployerQueue>

Type Parameters:

T - The type of the queue this adapter can provide.

public interface QueueAdapter<T extends DeployerQueue>

The adapter for any Queue type. An instance of an implementation of this interface, once configured is capable of producing queues of a certain type. For instance, one implementation of this adapter could be used to provide a FS-based queue. Another implementation of this adapter could be used to provide a JMS-based queue, etc...

Method Summary

Modifier and Type	Method and Description
void	configure(com.sdl.delivery.configuration.Configuration configuration) Configure the Queue Adapter.
T	getQueue(String queueId) Provide a queue based on the Queue Adapter configuration supplied earlier to the Queue Adapter.

Method Detail

configure

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

Configure the Queue Adapter.

Parameters:

configuration - The Queue Adapter configuration.

Throws:

com.sdl.delivery.configuration.ConfigurationException - in case of wrong configuration.

getQueue

T getQueue(String queueId)
    throws com.sdl.delivery.configuration.ConfigurationException

Provide a queue based on the Queue Adapter configuration supplied earlier to the Queue Adapter. This means that before invoking this method, the adapter needs to have been successfully configured.

Parameters:

queueId - id to be used for the queue.

Returns:

The provided queue of the implicit type.

Throws:

com.sdl.delivery.configuration.ConfigurationException - in case of missing mandatory configuration values