public interface DeployerQueue
Command
.
Note: this is write-only queue, intended to be used on endpoint side, where we do not need ability to dequeue.Modifier and Type | Field and Description |
---|---|
static String |
CONFIG_VALUE_QUEUE_ID
Configuration value that holds the Queue Id in a Queue configuration.
|
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.
|
static final String CONFIG_VALUE_QUEUE_ID
String getId()
boolean start()
true
in case the queue has been started successfully.boolean stop()
true
in case the queue has been stopped successfully, false
otherwise.boolean isActive()
true
in case it is active, false
otherwise.boolean enqueue(Command command)
true
upon success and false
if this queue is full.command
- The command to en-queue. Cannot be null
. Following fields cannot be null
either:
Command.getExecutionId(), Command.getVerbs(),
Command.getAction(), Command.getBinaryIds()NullPointerException
- if the specified command
is null
IllegalArgumentException
- if command's excecutionId/verb
is null/empty
Copyright (c) 2014-2021 All Rights Reserved by the RWS Group for and on behalf of its affiliates and subsidiaries