Package nzilbb.labbcat.http

Class HttpRequestPostMultipart

java.lang.Object

nzilbb.labbcat.http.HttpRequestPostMultipart

public class HttpRequestPostMultipart
extends Object

Multpart POST HTTP Request class

Originally com.myjavatools.web.ClientHttpRequest (version 1.0) by Vlad Patryshev

Adapted for LaBB-CAT by Robert Fromont

Constructor Summary

Constructors

Constructor	Description
HttpRequestPostMultipart(String urlString, String sAuthorization)	Creates a new multipart POST HTTP request for a specified URL string
HttpRequestPostMultipart(HttpURLConnection connection, String sAuthorization)	Creates a new multipart POST HTTP request on a freshly opened URLConnection
HttpRequestPostMultipart(URL url, String sAuthorization)	Creates a new multipart POST HTTP request for a specified URL

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancel the current request
boolean	isCancelling()	Determines whether or not the request is being cancelled.
HttpURLConnection	post()	posts the requests to the server, with all the cookies and parameters that were added
HttpURLConnection	post(Object[] parameters)	posts the requests to the server, with all the cookies and parameters that were added before (if any), and with parameters that are passed in the argument
HttpURLConnection	post(String[] cookies, Object[] parameters)	posts the requests to the server, with all the cookies and parameters that were added before (if any), and with cookies and parameters that are passed in the arguments
HttpURLConnection	post(String name, Object value)	post the POST request to the server, with the specified parameter
HttpURLConnection	post(String name1, Object value1, String name2, Object value2)	post the POST request to the server, with the specified parameters
HttpURLConnection	post(String name1, Object value1, String name2, Object value2, String name3, Object value3)	post the POST request to the server, with the specified parameters
HttpURLConnection	post(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)	post the POST request to the server, with the specified parameters
static HttpURLConnection	post(URL url, String sAuthorization, Object[] parameters)	posts a new request to specified URL, with parameters that are passed in the argument
static HttpURLConnection	post(URL url, String sAuthorization, String[] cookies, Object[] parameters)	posts a new request to specified URL, with cookies and parameters that are passed in the argument
static HttpURLConnection	post(URL url, String sAuthorization, String name1, Object value1)	post the POST request specified URL, with the specified parameter
static HttpURLConnection	post(URL url, String sAuthorization, String name1, Object value1, String name2, Object value2)	post the POST request to specified URL, with the specified parameters
static HttpURLConnection	post(URL url, String sAuthorization, String name1, Object value1, String name2, Object value2, String name3, Object value3)	post the POST request to specified URL, with the specified parameters
static HttpURLConnection	post(URL url, String sAuthorization, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)	post the POST request to specified URL, with the specified parameters
static HttpURLConnection	post(URL url, String sAuthorization, Map<String,String> parameters)	posts a new request to specified URL, with parameters that are passed in the argument
static HttpURLConnection	post(URL url, String sAuthorization, Map<String,String> cookies, Map<String,String> parameters)	posts a new request to specified URL, with cookies and parameters that are passed in the argument
HttpURLConnection	post(Map<String,String> parameters)	posts the requests to the server, with all the cookies and parameters that were added before (if any), and with parameters that are passed in the argument
HttpURLConnection	post(Map<String,String> cookies, Map<String,String> parameters)	posts the requests to the server, with all the cookies and parameters that were added before (if any), and with cookies and parameters that are passed in the arguments
void	setCookie(String name, String value)	adds a cookie to the requst
void	setCookies(String[] cookies)	adds cookies to the request
void	setCookies(Map<String,String> cookies)	adds cookies to the request
HttpRequestPostMultipart	setHeader(String sKey, String sValue)	Sets a request parameter value
HttpRequestPostMultipart	setLanguage(String language)	Set the Accept-Language header with the given language code, if any.,
HttpRequestPostMultipart	setParameter(String name, File file)	adds a file parameter to the request
HttpRequestPostMultipart	setParameter(String name, Object object)	adds a parameter to the request; if the parameter is a File, the file is uploaded, otherwise the string value of the parameter is passed in the request
HttpRequestPostMultipart	setParameter(String name, String value)	adds a string parameter to the request
HttpRequestPostMultipart	setParameter(String name, String filename, InputStream is)	adds a file parameter to the request
HttpRequestPostMultipart	setParameters(Object[] parameters)	adds parameters to the request
HttpRequestPostMultipart	setParameters(Map<String,String> parameters)	adds parameters to the request
HttpRequestPostMultipart	setUserAgent()	Sets the user-agent header to indicate the name/version of the library.
String	toString()	String representation of the request, for logging.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpRequestPostMultipart

public HttpRequestPostMultipart(HttpURLConnection connection,
                                String sAuthorization)
                         throws IOException

Creates a new multipart POST HTTP request on a freshly opened URLConnection

Parameters:

connection - an already open URL connection

sAuthorization - Authorisation string or null if none is required

Throws:

IOException - If an IO error occurs.

HttpRequestPostMultipart

public HttpRequestPostMultipart(URL url,
                                String sAuthorization)
                         throws IOException

Creates a new multipart POST HTTP request for a specified URL

Parameters:

url - the URL to send request to

sAuthorization - Authorisation string or null if none is required

Throws:

IOException - If an IO error occurs.

HttpRequestPostMultipart

public HttpRequestPostMultipart(String urlString,
                                String sAuthorization)
                         throws IOException

Creates a new multipart POST HTTP request for a specified URL string

Parameters:

urlString - the string representation of the URL to send request to

sAuthorization - Authoriztion header to use.

Throws:

IOException - If an IO error occurs.

Method Detail

setHeader

public HttpRequestPostMultipart setHeader(String sKey,
                                          String sValue)

Sets a request parameter value

Parameters:

sKey - The header name.

sValue - The header value.

Returns:

A reference to this object, so that setters can be chained.

isCancelling

public boolean isCancelling()

Determines whether or not the request is being cancelled.

Returns:

true, if the last request has been asked to cancel, false otherwise

cancel

public void cancel()

Cancel the current request

setUserAgent

public HttpRequestPostMultipart setUserAgent()

Sets the user-agent header to indicate the name/version of the library.

Returns:

A reference to this object, so that setters can be chained.

setLanguage

public HttpRequestPostMultipart setLanguage(String language)

Set the Accept-Language header with the given language code, if any.,

Parameters:

language - The language code, e.g. "es-AR", or null.

Returns:

A reference to this object.

setCookie

public void setCookie(String name,
                      String value)
               throws IOException

adds a cookie to the requst

Parameters:

name - cookie name

value - cookie value

Throws:

IOException - If an IO error occurs.

setCookies

public void setCookies(Map<String,String> cookies)
                throws IOException

adds cookies to the request

Parameters:

cookies - the cookie "name-to-value" map

Throws:

IOException - If an IO error occurs.

setCookies

public void setCookies(String[] cookies)
                throws IOException

adds cookies to the request

Parameters:

cookies - array of cookie names and values (cookies[2*i] is a name, cookies[2*i + 1] is a value)

Throws:

IOException - If an IO error occurs.

setParameter

public HttpRequestPostMultipart setParameter(String name,
                                             String value)
                                      throws IOException

adds a string parameter to the request

Parameters:

name - parameter name

value - parameter value

Returns:

A reference to this object, so that setters can be chained.

Throws:

IOException - If an IO error occurs.

setParameter

public HttpRequestPostMultipart setParameter(String name,
                                             String filename,
                                             InputStream is)
                                      throws IOException

adds a file parameter to the request

Parameters:

name - parameter name

filename - the name of the file

is - input stream to read the contents of the file from

Returns:

A reference to this object, so that setters can be chained.

Throws:

IOException - If an IO error occurs.

setParameter

public HttpRequestPostMultipart setParameter(String name,
                                             File file)
                                      throws IOException

adds a file parameter to the request

Parameters:

name - parameter name

file - the file to upload

Returns:

A reference to this object, so that setters can be chained.

Throws:

IOException - If an IO error occurs.

setParameter

public HttpRequestPostMultipart setParameter(String name,
                                             Object object)
                                      throws IOException

adds a parameter to the request; if the parameter is a File, the file is uploaded, otherwise the string value of the parameter is passed in the request

Parameters:

name - parameter name

object - parameter value, a File or anything else that can be stringified

Returns:

A reference to this object, so that setters can be chained.

Throws:

IOException - If an IO error occurs.

setParameters

public HttpRequestPostMultipart setParameters(Map<String,String> parameters)
                                       throws IOException

adds parameters to the request

Parameters:

parameters - "name-to-value" map of parameters; if a value is a file, the file is uploaded, otherwise it is stringified and sent in the request

Returns:

A reference to this object, so that setters can be chained.

Throws:

IOException - If an IO error occurs.

setParameters

public HttpRequestPostMultipart setParameters(Object[] parameters)
                                       throws IOException

adds parameters to the request

Parameters:

parameters - array of parameter names and values (parameters[2*i] is a name, parameters[2*i + 1] is a value); if a value is a file, the file is uploaded, otherwise it is stringified and sent in the request

Returns:

A reference to this object, so that setters can be chained.

Throws:

IOException - If an IO error occurs.

post

public HttpURLConnection post()
                       throws IOException

posts the requests to the server, with all the cookies and parameters that were added

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

post

public HttpURLConnection post(Map<String,String> parameters)
                       throws IOException

posts the requests to the server, with all the cookies and parameters that were added before (if any), and with parameters that are passed in the argument

Parameters:

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameters(java.util.Map<java.lang.String, java.lang.String>)

post

public HttpURLConnection post(Object[] parameters)
                       throws IOException

posts the requests to the server, with all the cookies and parameters that were added before (if any), and with parameters that are passed in the argument

Parameters:

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameters(java.util.Map<java.lang.String, java.lang.String>)

post

public HttpURLConnection post(Map<String,String> cookies,
                              Map<String,String> parameters)
                       throws IOException

posts the requests to the server, with all the cookies and parameters that were added before (if any), and with cookies and parameters that are passed in the arguments

Parameters:

cookies - request cookies

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameters(java.util.Map<java.lang.String, java.lang.String>), setCookies(java.util.Map<java.lang.String, java.lang.String>)

post

public HttpURLConnection post(String[] cookies,
                              Object[] parameters)
                       throws IOException

posts the requests to the server, with all the cookies and parameters that were added before (if any), and with cookies and parameters that are passed in the arguments

Parameters:

cookies - request cookies

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameters(java.util.Map<java.lang.String, java.lang.String>), setCookies(java.util.Map<java.lang.String, java.lang.String>)

post

public HttpURLConnection post(String name,
                              Object value)
                       throws IOException

post the POST request to the server, with the specified parameter

Parameters:

name - parameter name

value - parameter value

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameter(java.lang.String, java.lang.String)

post

public HttpURLConnection post(String name1,
                              Object value1,
                              String name2,
                              Object value2)
                       throws IOException

post the POST request to the server, with the specified parameters

Parameters:

name1 - first parameter name

value1 - first parameter value

name2 - second parameter name

value2 - second parameter value

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameter(java.lang.String, java.lang.String)

post

public HttpURLConnection post(String name1,
                              Object value1,
                              String name2,
                              Object value2,
                              String name3,
                              Object value3)
                       throws IOException

post the POST request to the server, with the specified parameters

Parameters:

name1 - first parameter name

value1 - first parameter value

name2 - second parameter name

value2 - second parameter value

name3 - third parameter name

value3 - third parameter value

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameter(java.lang.String, java.lang.String)

post

public HttpURLConnection post(String name1,
                              Object value1,
                              String name2,
                              Object value2,
                              String name3,
                              Object value3,
                              String name4,
                              Object value4)
                       throws IOException

post the POST request to the server, with the specified parameters

Parameters:

name1 - first parameter name

value1 - first parameter value

name2 - second parameter name

value2 - second parameter value

name3 - third parameter name

value3 - third parameter value

name4 - fourth parameter name

value4 - fourth parameter value

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameter(java.lang.String, java.lang.String)

post

public static HttpURLConnection post(URL url,
                                     String sAuthorization,
                                     Map<String,String> parameters)
                              throws IOException

posts a new request to specified URL, with parameters that are passed in the argument

Parameters:

url - URL to post to.

sAuthorization - Authoriztion header to use.

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameters(java.util.Map<java.lang.String, java.lang.String>)

post

public static HttpURLConnection post(URL url,
                                     String sAuthorization,
                                     Object[] parameters)
                              throws IOException

posts a new request to specified URL, with parameters that are passed in the argument

Parameters:

url - URL to post to.

sAuthorization - Authoriztion header to use.

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameters(java.util.Map<java.lang.String, java.lang.String>)

post

public static HttpURLConnection post(URL url,
                                     String sAuthorization,
                                     Map<String,String> cookies,
                                     Map<String,String> parameters)
                              throws IOException

posts a new request to specified URL, with cookies and parameters that are passed in the argument

Parameters:

url - URL to post to.

sAuthorization - Authoriztion header to use.

cookies - request cookies

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurd.

See Also:

setCookies(java.util.Map<java.lang.String, java.lang.String>), setParameters(java.util.Map<java.lang.String, java.lang.String>)

post

public static HttpURLConnection post(URL url,
                                     String sAuthorization,
                                     String[] cookies,
                                     Object[] parameters)
                              throws IOException

posts a new request to specified URL, with cookies and parameters that are passed in the argument

Parameters:

url - URL to post to.

sAuthorization - Authoriztion header to use.

cookies - request cookies

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setCookies(java.util.Map<java.lang.String, java.lang.String>), setParameters(java.util.Map<java.lang.String, java.lang.String>)

post

public static HttpURLConnection post(URL url,
                                     String sAuthorization,
                                     String name1,
                                     Object value1)
                              throws IOException

post the POST request specified URL, with the specified parameter

Parameters:

url - URL to post to.

sAuthorization - Authoriztion header to use.

name1 - parameter name

value1 - parameter value

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameter(java.lang.String, java.lang.String)

post

public static HttpURLConnection post(URL url,
                                     String sAuthorization,
                                     String name1,
                                     Object value1,
                                     String name2,
                                     Object value2)
                              throws IOException

post the POST request to specified URL, with the specified parameters

Parameters:

url - URL to post to.

sAuthorization - Authoriztion header to use.

name1 - first parameter name

value1 - first parameter value

name2 - second parameter name

value2 - second parameter value

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameter(java.lang.String, java.lang.String)

post

public static HttpURLConnection post(URL url,
                                     String sAuthorization,
                                     String name1,
                                     Object value1,
                                     String name2,
                                     Object value2,
                                     String name3,
                                     Object value3)
                              throws IOException

post the POST request to specified URL, with the specified parameters

Parameters:

url - URL to post to.

sAuthorization - Authoriztion header to use.

name1 - first parameter name

value1 - first parameter value

name2 - second parameter name

value2 - second parameter value

name3 - third parameter name

value3 - third parameter value

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameter(java.lang.String, java.lang.String)

post

public static HttpURLConnection post(URL url,
                                     String sAuthorization,
                                     String name1,
                                     Object value1,
                                     String name2,
                                     Object value2,
                                     String name3,
                                     Object value3,
                                     String name4,
                                     Object value4)
                              throws IOException

post the POST request to specified URL, with the specified parameters

Parameters:

url - URL to post to.

sAuthorization - Authoriztion header to use.

name1 - first parameter name

value1 - first parameter value

name2 - second parameter name

value2 - second parameter value

name3 - third parameter name

value3 - third parameter value

name4 - fourth parameter name

value4 - fourth parameter value

Returns:

input stream with the server response

Throws:

IOException - If an IO error occurs.

See Also:

setParameter(java.lang.String, java.lang.String)

toString

public String toString()

String representation of the request, for logging.

Overrides:

toString in class Object

Returns:

A String representation of the request, for logging.