public interface WSInterface
Modifier and Type | Method and Description |
---|---|
Alive |
alive()
Get information about the engine
|
boolean |
deleteBatch(String batchId)
Delete all jobs with the given batchId
|
boolean |
deleteClient(String clientId)
Delete a client
|
boolean |
deleteJob(String jobId)
Delete a single job
|
List<Job> |
getBatch(String batchId)
Get all jobs with the given batchId
|
Client |
getClient(String clientId)
Get a client
|
List<Client> |
getClients()
List all clients
|
DataType |
getDataType(String dataTypeId)
Get a single data type
|
Map<String,String> |
getDataTypes()
Get all data types
|
String |
getEndpoint()
Return which Pipeline 2 Web API endpoint is currently used
|
Job |
getJob(String jobId,
long msgSeq)
Get a single job
|
String |
getJobLog(String jobId)
Get the log file for a job
|
File |
getJobResultAsFile(String jobId,
String href)
Get results from a job as a File
|
InputStream |
getJobResultAsStream(String jobId,
String href)
Get results from a job as an InputStream
|
List<Job> |
getJobs()
Get all jobs
|
List<Property> |
getProperties()
Get the properties used in the Pipeline 2 engine
|
JobQueue |
getQueue()
Get the job queue
|
Script |
getScript(String scriptId)
Get a single script
|
List<Script> |
getScripts()
Get all scripts
|
String |
getShutDownKey()
Get the key meant to be used when invoking /admin/halt
|
JobSizes |
getSizes()
Get the size used to store each job
|
String |
getUsername()
Get the username used to authenticate with the Pipeline 2 Web API
|
boolean |
halt()
Stop the web service
|
JobQueue |
moveDownQueue(String jobId)
Move job down the queue
|
JobQueue |
moveUpQueue(String jobId)
Move job up the queue
|
Job |
postJob(Job job)
Submit a job to the engine
|
void |
setCredentials(String username,
String secret)
Set the credentials to use for the Pipeline 2 Web API
|
void |
setEndpoint(String endpoint)
Set which Pipeline 2 Web API endpoint to use.
|
void |
setShutDownKey(String key)
Set the key used when invoking /admin/halt to shut down the engine
|
void setEndpoint(String endpoint)
endpoint
- the endpoint to useString getEndpoint()
void setCredentials(String username, String secret)
username
- the username to usesecret
- the secret to useString getUsername()
void setShutDownKey(String key)
key
- the shutdown key to useString getShutDownKey()
Alive alive()
boolean halt()
List<Property> getProperties()
Script getScript(String scriptId)
scriptId
- the ID of the scriptDataType getDataType(String dataTypeId)
dataTypeId
- the ID of the datatypeJob getJob(String jobId, long msgSeq)
jobId
- the job IDmsgSeq
- the number of the first message to includeJob postJob(Job job)
job
- the job to postboolean deleteJob(String jobId)
jobId
- the job IDJobSizes getSizes()
List<Job> getBatch(String batchId)
batchId
- the batch IDboolean deleteBatch(String batchId)
batchId
- the batch IDString getJobLog(String jobId)
jobId
- the job IDInputStream getJobResultAsStream(String jobId, String href)
jobId
- the job IDhref
- the relative path to the desired job result fileFile getJobResultAsFile(String jobId, String href)
jobId
- the job IDhref
- the relative path to the desired job result fileJobQueue getQueue()
JobQueue moveUpQueue(String jobId)
jobId
- the job IDJobQueue moveDownQueue(String jobId)
jobId
- the job IDClient getClient(String clientId)
clientId
- the client IDboolean deleteClient(String clientId)
clientId
- the client IDCopyright © 2012–2022 The DAISY Consortium. All rights reserved.