public interface TaskStorage
CollectiveExecutor
and
can be exploited by other services as well.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
KEY_COMPLETION_TIMESTAMP
Timestamp (long) for the completion of a task.
|
static java.lang.String |
KEY_CONTROLLER_HOST
The hostname (String) of the Collective Controller.
|
static java.lang.String |
KEY_CONTROLLER_PORT
The https port (as a String) of the Collective Controller.
|
static java.lang.String |
KEY_CREATION_TIMESTAMP
Timestamp (long) for the creation of a task.
|
static java.lang.String |
KEY_DELETE_SOURCE
Kept for backwards compatibility.
|
static java.lang.String |
KEY_ENV_VARS
A Map
|
static java.lang.String |
KEY_FILE_TO_DELETE
The absolute location (String) of the file to be deleted.
|
static java.lang.String |
KEY_NEED_TO_DELETE_UPLOAD_SOURCE
A boolean flag indicating if the upload source needs to be deleted after uploaded.
|
static java.lang.String |
KEY_POST_TRANSFER_ACTION
The raw postTransferAction string from the request header.
|
static java.lang.String |
KEY_POST_TRANSFER_ACTION_ARRAY
The postTransferActions array is the array of actions to perform, as specified
by the postTransferAction header.
|
static java.lang.String |
KEY_POST_TRANSFER_ACTION_OPTIONS
The raw postTransferActionOptions string from the request header.
|
static java.lang.String |
KEY_POST_TRANSFER_ACTION_OPTIONS_ARRAY
The postTransferActionOptions array is the array of action options, as specified
by the postTransferActionOption header.
|
static java.lang.String |
KEY_PRE_TRANSFER_ACTION_ARRAY
The preTransferActions array is the array of actions to perform, as specified
by the preTransferAction header.
|
static java.lang.String |
KEY_PRE_TRANSFER_ACTION_OPTIONS_ARRAY
The preTransferActionOptions array is the array of action options, as specified
by the preTransferActionOption header.
|
static java.lang.String |
KEY_RECURSIVE_DELETE
A boolean flag indicating if the delete operation of the task should be recursive.
|
static java.lang.String |
KEY_STATUS
The current status (String) of the task.
|
static java.lang.String |
KEY_TRANSFER_CREDENTIALS
Transfer credentials is a Map
|
static java.lang.String |
KEY_UPLOAD_EXPANSION_FILENAME
The name (String) of the uploaded + expanded archive.
|
static java.lang.String |
KEY_UPLOAD_FROM_FILE
An absolute location (String) of the source file that will be uploaded.
|
static java.lang.String |
KEY_UPLOAD_TO_DIR
An absolute location (String) of the target upload directory.
|
static java.lang.String |
KEY_USER
The current user (String) of the task.
|
static java.lang.String |
STATUS_FAILED
The completion status of a task or a host is failed
|
static java.lang.String |
STATUS_IN_PROGRESS
The status of a task or host is in progress
|
static java.lang.String |
STATUS_PARTIAL_SUCCEEDED
The status of a task or host has some successful and failed steps
|
static java.lang.String |
STATUS_PENDING
The initial status of a task or a host
|
static java.lang.String |
STATUS_SUCCEEDED
The successful completion status of a task or a host
|
Modifier and Type | Method and Description |
---|---|
void |
addHostResult(java.lang.String token,
java.lang.String hostName,
CommandResult commandResult)
Add a result record to the specified task and host
|
java.lang.String |
createTask(java.lang.String[] hostNames,
java.util.Map<java.lang.String,java.lang.Object> properties)
Create a new task in the task storage
|
java.util.List<CommandResult> |
getHostResult(java.lang.String token,
java.lang.String hostName)
Get a list of CommandResult object from a given task and host
|
java.lang.String |
getHostStatus(java.lang.String token,
java.lang.String hostName)
Get the overall status of a host.
|
java.lang.String[] |
getTaskHostNames(java.lang.String token)
Get all the host names of a given task
|
java.util.Set<java.lang.String> |
getTaskPropertyKeys(java.lang.String token)
Get all the property keys of a given task
|
java.lang.Object |
getTaskPropertyValue(java.lang.String token,
java.lang.String key)
Get the property value of a given task and key
|
java.lang.String |
getTaskStatus(java.lang.String token)
Get the overall status of a task.
|
java.util.Set<java.lang.String> |
getTaskTokens(java.util.Set<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> filter)
Get all task identifiers in the task storage
|
void |
startWorking(java.lang.String token,
java.lang.String hostName)
Declare the start of work for a given task and host.
|
void |
stopWorking(java.lang.String token,
java.lang.String hostName)
Signal the completion of the work for a given task and host.
|
void |
stopWorking(java.lang.String token,
java.lang.String hostName,
java.lang.String status)
Signal the completion of the work for a given task and host.
|
static final java.lang.String STATUS_PENDING
static final java.lang.String STATUS_SUCCEEDED
static final java.lang.String STATUS_FAILED
static final java.lang.String STATUS_IN_PROGRESS
static final java.lang.String STATUS_PARTIAL_SUCCEEDED
static final java.lang.String KEY_TRANSFER_CREDENTIALS
null
.static final java.lang.String KEY_ENV_VARS
static final java.lang.String KEY_POST_TRANSFER_ACTION
static final java.lang.String KEY_PRE_TRANSFER_ACTION_ARRAY
static final java.lang.String KEY_POST_TRANSFER_ACTION_ARRAY
static final java.lang.String KEY_POST_TRANSFER_ACTION_OPTIONS
static final java.lang.String KEY_PRE_TRANSFER_ACTION_OPTIONS_ARRAY
null
.
If options are specified, the length will be validated.static final java.lang.String KEY_POST_TRANSFER_ACTION_OPTIONS_ARRAY
null
.
If options are specified, the length will be validated.static final java.lang.String KEY_CREATION_TIMESTAMP
static final java.lang.String KEY_COMPLETION_TIMESTAMP
static final java.lang.String KEY_UPLOAD_FROM_FILE
static final java.lang.String KEY_UPLOAD_TO_DIR
static final java.lang.String KEY_NEED_TO_DELETE_UPLOAD_SOURCE
static final java.lang.String KEY_UPLOAD_EXPANSION_FILENAME
static final java.lang.String KEY_CONTROLLER_HOST
static final java.lang.String KEY_CONTROLLER_PORT
static final java.lang.String KEY_USER
static final java.lang.String KEY_STATUS
static final java.lang.String KEY_RECURSIVE_DELETE
static final java.lang.String KEY_FILE_TO_DELETE
static final java.lang.String KEY_DELETE_SOURCE
KEY_NEED_TO_DELETE_UPLOAD_SOURCE
.java.lang.String createTask(java.lang.String[] hostNames, java.util.Map<java.lang.String,java.lang.Object> properties)
hostNames
- An array of host names to run this task onproperties
- Properties of the taskjava.util.Set<java.lang.String> getTaskTokens(java.util.Set<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> filter)
filter
- A set of filter entries, or null for no filtering.java.util.Set<java.lang.String> getTaskPropertyKeys(java.lang.String token)
token
- Task identifierjava.lang.String[] getTaskHostNames(java.lang.String token)
token
- Task identifierjava.lang.Object getTaskPropertyValue(java.lang.String token, java.lang.String key)
token
- Task identifierkey
- The key of the propertyjava.lang.String getTaskStatus(java.lang.String token)
token
- Task identifierjava.lang.String getHostStatus(java.lang.String token, java.lang.String hostName)
token
- Task identifierhostName
- Host namevoid addHostResult(java.lang.String token, java.lang.String hostName, CommandResult commandResult)
token
- Task identifierhostName
- Host namecommandResult
- The CommandResult object which holds the resultjava.util.List<CommandResult> getHostResult(java.lang.String token, java.lang.String hostName)
token
- Task identifierhostName
- Host namevoid startWorking(java.lang.String token, java.lang.String hostName)
token
- Task identifierhostName
- Host namevoid stopWorking(java.lang.String token, java.lang.String hostName)
token
- Task identifierhostName
- Host namevoid stopWorking(java.lang.String token, java.lang.String hostName, java.lang.String status)
token
- Task identifierhostName
- Host namestatus
- The completion status of the host. If null is specified, the status
will be changed to STATUS_SUCCEEDED.