Package com.articulate.sigma

Class ClientHttpRequest

java.lang.Object

com.articulate.sigma.ClientHttpRequest

public class ClientHttpRequest
extends Object

Title: Client HTTP Request class

Description: this class helps to send POST HTTP requests with various form data, including files. Cookies can be added to be included in the request.

Version:

1.0 Copyright 2007 Vlad Patryshev Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Author:

Vlad Patryshev

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	connect()
protected void	newline()
InputStream	post()	posts the requests to the server, with all the cookies and parameters that were added
InputStream	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
InputStream	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
InputStream	post(String name, Object value)	post the POST request to the server, with the specified parameter
InputStream	post(String name1, Object value1, String name2, Object value2)	post the POST request to the server, with the specified parameters
InputStream	post(String name1, Object value1, String name2, Object value2, String name3, Object value3)	post the POST request to the server, with the specified parameters
InputStream	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 InputStream	post(URL url, Object[] parameters)	posts a new request to specified URL, with parameters that are passed in the argument
static InputStream	post(URL url, String[] cookies, Object[] parameters)	posts a new request to specified URL, with cookies and parameters that are passed in the argument
static InputStream	post(URL url, String name1, Object value1)	post the POST request specified URL, with the specified parameter
static InputStream	post(URL url, String name1, Object value1, String name2, Object value2)	post the POST request to specified URL, with the specified parameters
static InputStream	post(URL url, String name1, Object value1, String name2, Object value2, String name3, Object value3)	post the POST request to specified URL, with the specified parameters
static InputStream	post(URL url, 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 InputStream	post(URL url, Map parameters)	posts a new request to specified URL, with parameters that are passed in the argument
static InputStream	post(URL url, Map<String,String> cookies, Map parameters)	posts a new request to specified URL, with cookies and parameters that are passed in the argument
InputStream	post(Map 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
InputStream	post(Map<String,String> cookies, Map 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
protected static String	randomString()
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
void	setParameter(String name, File file)	adds a file parameter to the request
void	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
void	setParameter(String name, String value)	adds a string parameter to the request
void	setParameter(String name, String filename, InputStream is)	adds a file parameter to the request
void	setParameters(Object[] parameters)	adds parameters to the request
void	setParameters(Map parameters)	adds parameters to the request
protected void	write(char c)
protected void	write(String s)
protected void	writeln(String s)

Methods inherited from class java.lang.Object

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

Constructor Details

ClientHttpRequest

public ClientHttpRequest(URLConnection connection)
                  throws IOException

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

Parameters:

connection - an already open URL connection

Throws:

IOException

ClientHttpRequest

public ClientHttpRequest(URL url)
                  throws IOException

Creates a new multipart POST HTTP request for a specified URL

Parameters:

url - the URL to send request to

Throws:

IOException

ClientHttpRequest

public ClientHttpRequest(String urlString)
                  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

Throws:

IOException

Method Details

connect

protected void connect()
                throws IOException

Throws:

IOException

write

protected void write(char c)
              throws IOException

Throws:

IOException

write

protected void write(String s)
              throws IOException

Throws:

IOException

newline

protected void newline()
                throws IOException

Throws:

IOException

writeln

protected void writeln(String s)
                throws IOException

Throws:

IOException

randomString

protected static String randomString()

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

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

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

setParameter

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

adds a string parameter to the request

Parameters:

name - parameter name

value - parameter value

Throws:

IOException

setParameter

public void 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

Throws:

IOException

setParameter

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

adds a file parameter to the request

Parameters:

name - parameter name

file - the file to upload

Throws:

IOException

setParameter

public void 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

Throws:

IOException

setParameters

public void setParameters(Map 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

Throws:

IOException

setParameters

public void 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

Throws:

IOException

post

public InputStream 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

post

public InputStream post(Map 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

See Also:

• setParameters(java.util.Map)

post

public InputStream 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

See Also:

• setParameters(java.util.Map)

post

public InputStream post(Map<String,String> cookies,
 Map 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

See Also:

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

post

public InputStream 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

See Also:

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

post

public InputStream 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

See Also:

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

post

public InputStream 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

See Also:

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

post

public InputStream 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

See Also:

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

post

public InputStream 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

See Also:

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

post

public static InputStream post(URL url,
 Map parameters)
                        throws IOException

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

Parameters:

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException

See Also:

• setParameters(java.util.Map)

post

public static InputStream post(URL url,
 Object[] parameters)
                        throws IOException

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

Parameters:

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException

See Also:

• setParameters(java.util.Map)

post

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

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

Parameters:

cookies - request cookies

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException

See Also:

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

post

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

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

Parameters:

cookies - request cookies

parameters - request parameters

Returns:

input stream with the server response

Throws:

IOException

See Also:

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

post

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

post the POST request specified URL, with the specified parameter

Parameters:

name1 - parameter name

value1 - parameter value

Returns:

input stream with the server response

Throws:

IOException

See Also:

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

post

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

post the POST request to specified URL, 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

See Also:

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

post

public static InputStream post(URL url,
 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:

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

See Also:

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

post

public static InputStream post(URL url,
 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:

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

See Also:

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