com.sdl.delivery.deployer.api.queue

Interface DeployerQueue

public interface DeployerQueue

Interface for component that seats in the middle of the Deployment Endpoint and Unified Content Deployer. It operates with items of type Command. Note: this is write-only queue, intended to be used on endpoint side, where we do not need ability to dequeue.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_VALUE_QUEUE_ID Configuration value that holds the Queue Id in a Queue configuration.

Method Summary

Modifier and Type	Method and Description
Optional<Command>	dequeue() De-queue one command as an optional.
boolean	enqueue(Command command) Adds the specified command to the queue if it is possible, returning true upon success and false if this queue is full.
String	getId() Gets an identifier of this queue.
boolean	isActive() Check whether the queue has been started successfully and is ready to receive enqueue and dequeue requests.
boolean	start() Start or enable the queue.
boolean	stop() Stop or release the queue.

Field Detail

CONFIG_VALUE_QUEUE_ID

static final String CONFIG_VALUE_QUEUE_ID

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

See Also:

Constant Field Values

Method Detail

getId

String getId()

Gets an identifier of this queue.

Returns:

The identifier of this queue.

start

boolean start()

Start or enable the queue. This is fully implementation specific. It could be that some implementations do nothing upon being started.

Returns:

true in case the queue has been started successfully.

stop

boolean stop()

Stop or release the queue. This is fully implementation specific. It could be that some implementations do nothing upon being stopped.

Returns:

true in case the queue has been stopped successfully, false otherwise.

isActive

boolean isActive()

Check whether the queue has been started successfully and is ready to receive enqueue and dequeue requests.

Returns:

true in case it is active, false otherwise.

enqueue

boolean enqueue(Command command)

Adds the specified command to the queue if it is possible, returning true upon success and false if this queue is full.

Parameters:

command - The command to en-queue. Cannot be null. Following fields cannot be null either: Command.getExecutionId(), Command.getVerbs(), Command.getAction(), Command.getBinaryIds()

Throws:

NullPointerException - if the specified command is null

IllegalArgumentException - if command's excecutionId/verb is null/empty

dequeue

Optional<Command> dequeue()

De-queue one command as an optional.

Returns:

The command de-queued.