WS (DAISY Pipeline 2 :: Java Client Library :: HTTP Client Implementation 2.1.2 API)

java.lang.Object
- org.daisy.pipeline.client.http.WS

All Implemented Interfaces:

WSInterface
```
public class WS
extends Object
implements WSInterface
```
Methods for communicating with the Pipeline 2 API.

See Also:

http://code.google.com/p/daisy-pipeline/wiki/WebServiceAPI

Constructor Summary

Constructors
Constructor and Description

WS()

Constructors
Constructor and Description
`WS()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Alive`	`alive()` Get information about the engine
`void`	`checkIfLocal()`
`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 shutDownKey)` Set the key used when invoking /admin/halt to shut down the engine.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WS
```
public WS()
```
- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Set which Pipeline 2 Web API endpoint to use. Defaults to: "http://localhost:8181/ws"
    
    Specified by:
    
    setEndpoint in interface WSInterface
    
    Parameters:
    
    endpoint - the endpoint to use
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: WSInterface
    
    Return which Pipeline 2 Web API endpoint is currently used
    
    Specified by:
    
    getEndpoint in interface WSInterface
    
    Returns:
    
    the endpoint used
  - setCredentials
```
public void setCredentials(String username,
                           String secret)
```
    Set the credentials to use for the Pipeline 2 Web API. Defaults to "clientid" and "supersecret".
    
    Specified by:
    
    setCredentials in interface WSInterface
    
    Parameters:
    
    username - the username to use
    
    secret - the secret to use
  - getUsername
```
public String getUsername()
```
    Description copied from interface: WSInterface
    
    Get the username used to authenticate with the Pipeline 2 Web API
    
    Specified by:
    
    getUsername in interface WSInterface
    
    Returns:
    
    the username
  - setShutDownKey
```
public void setShutDownKey(String shutDownKey)
```
    Set the key used when invoking /admin/halt to shut down the engine. Defaults to the first line if the "dp2key.txt" file in the systems temporary directory.
    
    Specified by:
    
    setShutDownKey in interface WSInterface
    
    Parameters:
    
    shutDownKey - the shutdown key to use
  - getShutDownKey
```
public String getShutDownKey()
```
    Description copied from interface: WSInterface
    
    Get the key meant to be used when invoking /admin/halt
    
    Specified by:
    
    getShutDownKey in interface WSInterface
    
    Returns:
    
    the shutdown key in use
  - alive
```
public Alive alive()
```
    Description copied from interface: WSInterface
    
    Get information about the engine
    
    Specified by:
    
    alive in interface WSInterface
    
    Returns:
    
    information about the engine
  - halt
```
public boolean halt()
```
    Description copied from interface: WSInterface
    
    Stop the web service
    
    Specified by:
    
    halt in interface WSInterface
    
    Returns:
    
    whether or not halting the engine succeeded
  - getProperties
```
public List<Property> getProperties()
```
    Description copied from interface: WSInterface
    
    Get the properties used in the Pipeline 2 engine
    
    Specified by:
    
    getProperties in interface WSInterface
    
    Returns:
    
    the list of properties
  - getScripts
```
public List<Script> getScripts()
```
    Description copied from interface: WSInterface
    
    Get all scripts
    
    Specified by:
    
    getScripts in interface WSInterface
    
    Returns:
    
    the list of scripts
  - getScript
```
public Script getScript(String scriptId)
```
    Description copied from interface: WSInterface
    
    Get a single script
    
    Specified by:
    
    getScript in interface WSInterface
    
    Parameters:
    
    scriptId - the ID of the script
    
    Returns:
    
    the script
  - getDataTypes
```
public Map<String,String> getDataTypes()
```
    Description copied from interface: WSInterface
    
    Get all data types
    
    Specified by:
    
    getDataTypes in interface WSInterface
    
    Returns:
    
    a map of all datatypes
  - getDataType
```
public DataType getDataType(String dataTypeId)
```
    Description copied from interface: WSInterface
    
    Get a single data type
    
    Specified by:
    
    getDataType in interface WSInterface
    
    Parameters:
    
    dataTypeId - the ID of the datatype
    
    Returns:
    
    the datatype
  - getJobs
```
public List<Job> getJobs()
```
    Description copied from interface: WSInterface
    
    Get all jobs
    
    Specified by:
    
    getJobs in interface WSInterface
    
    Returns:
    
    the list of all jobs
  - getJob
```
public Job getJob(String jobId,
                  long msgSeq)
```
    Description copied from interface: WSInterface
    
    Get a single job
    
    Specified by:
    
    getJob in interface WSInterface
    
    Parameters:
    
    jobId - the job ID
    
    msgSeq - the number of the first message to include
    
    Returns:
    
    the job
  - postJob
```
public Job postJob(Job job)
```
    Description copied from interface: WSInterface
    
    Submit a job to the engine
    
    Specified by:
    
    postJob in interface WSInterface
    
    Parameters:
    
    job - the job to post
    
    Returns:
    
    the posted job
  - deleteJob
```
public boolean deleteJob(String jobId)
```
    Description copied from interface: WSInterface
    
    Delete a single job
    
    Specified by:
    
    deleteJob in interface WSInterface
    
    Parameters:
    
    jobId - the job ID
    
    Returns:
    
    whether or not the job was deleted
  - getSizes
```
public JobSizes getSizes()
```
    Description copied from interface: WSInterface
    
    Get the size used to store each job
    
    Specified by:
    
    getSizes in interface WSInterface
    
    Returns:
    
    the job sizes
  - getBatch
```
public List<Job> getBatch(String batchId)
```
    Description copied from interface: WSInterface
    
    Get all jobs with the given batchId
    
    Specified by:
    
    getBatch in interface WSInterface
    
    Parameters:
    
    batchId - the batch ID
    
    Returns:
    
    the list of jobs for the given batch ID
  - deleteBatch
```
public boolean deleteBatch(String batchId)
```
    Description copied from interface: WSInterface
    
    Delete all jobs with the given batchId
    
    Specified by:
    
    deleteBatch in interface WSInterface
    
    Parameters:
    
    batchId - the batch ID
    
    Returns:
    
    whether or not all jobs were successfully deleted
  - getJobLog
```
public String getJobLog(String jobId)
```
    Description copied from interface: WSInterface
    
    Get the log file for a job
    
    Specified by:
    
    getJobLog in interface WSInterface
    
    Parameters:
    
    jobId - the job ID
    
    Returns:
    
    the log
  - getJobResultAsStream
```
public InputStream getJobResultAsStream(String jobId,
                                        String href)
```
    Description copied from interface: WSInterface
    
    Get results from a job as an InputStream
    
    Specified by:
    
    getJobResultAsStream in interface WSInterface
    
    Parameters:
    
    jobId - the job ID
    
    href - the relative path to the desired job result file
    
    Returns:
    
    the file as an InputStream
  - getJobResultAsFile
```
public File getJobResultAsFile(String jobId,
                               String href)
```
    Description copied from interface: WSInterface
    
    Get results from a job as a File
    
    Specified by:
    
    getJobResultAsFile in interface WSInterface
    
    Parameters:
    
    jobId - the job ID
    
    href - the relative path to the desired job result file
    
    Returns:
    
    the file as a File
  - getQueue
```
public JobQueue getQueue()
```
    Description copied from interface: WSInterface
    
    Get the job queue
    
    Specified by:
    
    getQueue in interface WSInterface
    
    Returns:
    
    the job queue
  - moveUpQueue
```
public JobQueue moveUpQueue(String jobId)
```
    Description copied from interface: WSInterface
    
    Move job up the queue
    
    Specified by:
    
    moveUpQueue in interface WSInterface
    
    Parameters:
    
    jobId - the job ID
    
    Returns:
    
    the job queue
  - moveDownQueue
```
public JobQueue moveDownQueue(String jobId)
```
    Description copied from interface: WSInterface
    
    Move job down the queue
    
    Specified by:
    
    moveDownQueue in interface WSInterface
    
    Parameters:
    
    jobId - the job ID
    
    Returns:
    
    the job queue
  - getClients
```
public List<Client> getClients()
```
    Description copied from interface: WSInterface
    
    List all clients
    
    Specified by:
    
    getClients in interface WSInterface
    
    Returns:
    
    the list of clients
  - getClient
```
public Client getClient(String clientId)
```
    Description copied from interface: WSInterface
    
    Get a client
    
    Specified by:
    
    getClient in interface WSInterface
    
    Parameters:
    
    clientId - the client ID
    
    Returns:
    
    the client
  - deleteClient
```
public boolean deleteClient(String clientId)
```
    Description copied from interface: WSInterface
    
    Delete a client
    
    Specified by:
    
    deleteClient in interface WSInterface
    
    Parameters:
    
    clientId - the client ID
    
    Returns:
    
    whether or not the client were successfully deleted
  - checkIfLocal
```
public void checkIfLocal()
```

Class WS

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WS

Method Detail

setEndpoint

getEndpoint

setCredentials

getUsername

setShutDownKey

getShutDownKey

alive

halt

getProperties

getScripts

getScript

getDataTypes

getDataType

getJobs

getJob

postJob

deleteJob

getSizes

getBatch

deleteBatch

getJobLog

getJobResultAsStream

getJobResultAsFile

getQueue

moveUpQueue

moveDownQueue

getClients

getClient

deleteClient

checkIfLocal