org.daisy.pipeline.tts.rest

Class Request<ContentType>

java.lang.Object

org.daisy.pipeline.tts.rest.Request<ContentType>

public class Request<ContentType>
extends Object

REST Request to communicate with remote services (mainly tts services like Google and Amazon).

Author:

Nicolas Pavie @ braillenet.org

Constructor Summary

Constructors

Constructor and Description
Request(String httpMethod, String url, HashMap<String,String> headers, ContentType content) Fully initialized request

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, String value) Add a new header field with specified value to the request
void	cancel() Cancel the request, disconnecting it from the server
HttpURLConnection	getConnection() Get the current connection object
InputStream	send() Send the request to the requested url and retrieve the server answer as an input stream.
void	setContent(ContentType content) Set the request content, to be sent through the request connection output stream
void	setMethod(String httpMethod) Set the HTTP method to use with the request
void	setRequestUrl(String url) Set the request URL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Request

public Request(String httpMethod,
               String url,
               HashMap<String,String> headers,
               ContentType content)
        throws Exception,
               MalformedURLException

Fully initialized request

Parameters:

httpMethod - possible values: "GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "TRACE", "PATCH"

url - a string of the complete request URL (including URL parameters like "?voice=smtg)"

headers - HTTP headers of the request

Use null to unset all headers.

content - content to send with the request (often associated with POST requests)

Use null for requests without content

Throws:

Exception - if the http method is not one of the list above

MalformedURLException - if the url is not valid

Method Detail

addHeader

public void addHeader(String name,
                      String value)

Add a new header field with specified value to the request

Parameters:

name - name of the header field

value - value set for the field

setContent

public void setContent(ContentType content)

Set the request content, to be sent through the request connection output stream

Parameters:

content - content of the request

setRequestUrl

public void setRequestUrl(String url)
                   throws MalformedURLException

Set the request URL.

If a previous connection was opened for the current request, close and destroy it.

Throws:

MalformedURLException

setMethod

public void setMethod(String httpMethod)
               throws Exception

Set the HTTP method to use with the request

Parameters:

httpMethod - one of the following values: "GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "TRACE", "PATCH"

Throws:

Exception - if the HTTP method value is not a valid one

send

public InputStream send()
                 throws IOException,
                        InterruptedException

Send the request to the requested url and retrieve the server answer as an input stream.

Returns:

the input stream, through which data are send back by the server

Throws:

IOException - if an error occured during the connection or while sending data to the server

InterruptedException - if the current thead is interrupted while getting the response from the server

getConnection

public HttpURLConnection getConnection()

Get the current connection object

cancel

public void cancel()

Cancel the request, disconnecting it from the server