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

A C D G H I J M O P S U W

A

alive() - Method in class org.daisy.pipeline.client.http.WS
alive() - Method in interface org.daisy.pipeline.client.http.WSInterface: Get information about the engine
asFile() - Method in class org.daisy.pipeline.client.http.WSResponse: Returns the response body as a File.
asStream() - Method in class org.daisy.pipeline.client.http.WSResponse: Returns the response body as a InputStream.
asText() - Method in class org.daisy.pipeline.client.http.WSResponse: Returns the response body as a String.
asXml() - Method in class org.daisy.pipeline.client.http.WSResponse: Returns the response body as an XML Document.

C

checkIfLocal() - Method in class org.daisy.pipeline.client.http.WS
contentType - Variable in class org.daisy.pipeline.client.http.WSResponse

D

delete(String, String, String, String, Map<String, String>) - Static method in class org.daisy.pipeline.client.http.Pipeline2HttpClient: Send a DELETE request.
deleteBatch(String) - Method in class org.daisy.pipeline.client.http.WS
deleteBatch(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Delete all jobs with the given batchId
deleteClient(String) - Method in class org.daisy.pipeline.client.http.WS
deleteClient(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Delete a client
deleteJob(String) - Method in class org.daisy.pipeline.client.http.WS
deleteJob(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Delete a single job

G

get(String, String, String, String, Map<String, String>) - Static method in class org.daisy.pipeline.client.http.Pipeline2HttpClient: Send a GET request.
getBatch(String) - Method in class org.daisy.pipeline.client.http.WS
getBatch(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Get all jobs with the given batchId
getClient(String) - Method in class org.daisy.pipeline.client.http.WS
getClient(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Get a client
getClients() - Method in class org.daisy.pipeline.client.http.WS
getClients() - Method in interface org.daisy.pipeline.client.http.WSInterface: List all clients
getDataType(String) - Method in class org.daisy.pipeline.client.http.WS
getDataType(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Get a single data type
getDataTypes() - Method in class org.daisy.pipeline.client.http.WS
getDataTypes() - Method in interface org.daisy.pipeline.client.http.WSInterface: Get all data types
getEndpoint() - Method in class org.daisy.pipeline.client.http.WS
getEndpoint() - Method in interface org.daisy.pipeline.client.http.WSInterface: Return which Pipeline 2 Web API endpoint is currently used
getJob(String, long) - Method in class org.daisy.pipeline.client.http.WS
getJob(String, long) - Method in interface org.daisy.pipeline.client.http.WSInterface: Get a single job
getJobLog(String) - Method in class org.daisy.pipeline.client.http.WS
getJobLog(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Get the log file for a job
getJobResultAsFile(String, String) - Method in class org.daisy.pipeline.client.http.WS
getJobResultAsFile(String, String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Get results from a job as a File
getJobResultAsStream(String, String) - Method in class org.daisy.pipeline.client.http.WS
getJobResultAsStream(String, String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Get results from a job as an InputStream
getJobs() - Method in class org.daisy.pipeline.client.http.WS
getJobs() - Method in interface org.daisy.pipeline.client.http.WSInterface: Get all jobs
getProperties() - Method in class org.daisy.pipeline.client.http.WS
getProperties() - Method in interface org.daisy.pipeline.client.http.WSInterface: Get the properties used in the Pipeline 2 engine
getQueue() - Method in class org.daisy.pipeline.client.http.WS
getQueue() - Method in interface org.daisy.pipeline.client.http.WSInterface: Get the job queue
getScript(String) - Method in class org.daisy.pipeline.client.http.WS
getScript(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Get a single script
getScripts() - Method in class org.daisy.pipeline.client.http.WS
getScripts() - Method in interface org.daisy.pipeline.client.http.WSInterface: Get all scripts
getShutDownKey() - Method in class org.daisy.pipeline.client.http.WS
getShutDownKey() - Method in interface org.daisy.pipeline.client.http.WSInterface: Get the key meant to be used when invoking /admin/halt
getSizes() - Method in class org.daisy.pipeline.client.http.WS
getSizes() - Method in interface org.daisy.pipeline.client.http.WSInterface: Get the size used to store each job
getUsername() - Method in class org.daisy.pipeline.client.http.WS
getUsername() - Method in interface org.daisy.pipeline.client.http.WSInterface: Get the username used to authenticate with the Pipeline 2 Web API

H

halt() - Method in class org.daisy.pipeline.client.http.WS
halt() - Method in interface org.daisy.pipeline.client.http.WSInterface: Stop the web service

I

iso8601 - Static variable in class org.daisy.pipeline.client.http.Pipeline2HttpClient

J

jobMessages(List<Message>) - Method in interface org.daisy.pipeline.client.http.WSCallbackHandler: Handle job message callbacks.
jobStatus(Job.Status) - Method in interface org.daisy.pipeline.client.http.WSCallbackHandler: Handle job status update callbacks.

M

moveDownQueue(String) - Method in class org.daisy.pipeline.client.http.WS
moveDownQueue(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Move job down the queue
moveUpQueue(String) - Method in class org.daisy.pipeline.client.http.WS
moveUpQueue(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Move job up the queue

O

org.daisy.pipeline.client.http - package org.daisy.pipeline.client.http

P

Pipeline2HttpClient - Class in org.daisy.pipeline.client.http: Implementation of DP2HttpClient that uses Apache HTTP Client as the underlying HTTP client.
Pipeline2HttpClient() - Constructor for class org.daisy.pipeline.client.http.Pipeline2HttpClient
postJob(Job) - Method in class org.daisy.pipeline.client.http.WS
postJob(Job) - Method in interface org.daisy.pipeline.client.http.WSInterface: Submit a job to the engine
postMultipart(String, String, String, String, Map<String, File>) - Static method in class org.daisy.pipeline.client.http.Pipeline2HttpClient: POST a multipart request.
postXml(String, String, String, String, Document) - Static method in class org.daisy.pipeline.client.http.Pipeline2HttpClient: POST an XML document.

S

setCredentials(String, String) - Method in class org.daisy.pipeline.client.http.WS: Set the credentials to use for the Pipeline 2 Web API.
setCredentials(String, String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Set the credentials to use for the Pipeline 2 Web API
setEndpoint(String) - Method in class org.daisy.pipeline.client.http.WS: Set which Pipeline 2 Web API endpoint to use.
setEndpoint(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Set which Pipeline 2 Web API endpoint to use.
setShutDownKey(String) - Method in class org.daisy.pipeline.client.http.WS: Set the key used when invoking /admin/halt to shut down the engine.
setShutDownKey(String) - Method in interface org.daisy.pipeline.client.http.WSInterface: Set the key used when invoking /admin/halt to shut down the engine
size - Variable in class org.daisy.pipeline.client.http.WSResponse
status - Variable in class org.daisy.pipeline.client.http.WSResponse
statusDescription - Variable in class org.daisy.pipeline.client.http.WSResponse
statusName - Variable in class org.daisy.pipeline.client.http.WSResponse

U

url(String, String, String, String, Map<String, String>) - Static method in class org.daisy.pipeline.client.http.Pipeline2HttpClient: Sign a URL for communication with a Pipeline 2 Web Service running in authenticated mode.
url - Variable in class org.daisy.pipeline.client.http.WSResponse

W

WS - Class in org.daisy.pipeline.client.http: Methods for communicating with the Pipeline 2 API.
WS() - Constructor for class org.daisy.pipeline.client.http.WS
WSCallbackHandler - Interface in org.daisy.pipeline.client.http
WSInterface - Interface in org.daisy.pipeline.client.http: Methods for communicating with the Pipeline 2 API.
WSResponse - Class in org.daisy.pipeline.client.http
WSResponse(String, int, String, String, String, Long, InputStream) - Constructor for class org.daisy.pipeline.client.http.WSResponse: Creates a new Pipeline2WSResponse with the given HTTP status code, status name, status description and content body.

A C D G H I J M O P S U W