org.libj.net

Class HTTP

java.lang.Object

org.libj.net.HTTP

public final class HTTP
extends Object

Utility functions pertaining to the HTTP protocol.

Method Summary

Modifier and Type	Method and Description
static String	createQuery(Map<String,String[]> parameters, String charset) Create a query string based on the specified parameter map and the provided charset encoding.
static InputStream	doGet(String url, Map<String,String[]> parameters) Invoke a GET request on the specified URL with the provided parameter map which will be encoded as UTF-8.
static InputStream	doGet(String url, Map<String,String[]> parameters, String charset) Invoke a GET request on the specified URL with the provided parameter map and charset encoding.
static InputStream	doPost(URL url, Map<String,String[]> parameters) Invoke a POST request on the specified URL with the provided parameter map which will be encoded as UTF-8.
static InputStream	doPost(URL url, Map<String,String[]> parameters, Properties properties) Invoke a POST request on the specified URL with the provided parameter map which will be encoded as UTF-8.
static InputStream	doPost(URL url, Map<String,String[]> parameters, Properties properties, List<String> cookies) Invoke a POST request on the specified URL with the provided parameter map which will be encoded as UTF-8.

Methods inherited from class java.lang.Object

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

Method Detail

doGet

public static InputStream doGet(String url,
                                Map<String,String[]> parameters)
                         throws IOException

Invoke a GET request on the specified URL with the provided parameter map which will be encoded as UTF-8. It is highly recommended to close the obtained InputStream after processing.

Parameters:

url - The URL to be invoked.

parameters - The parameters to be processed as query parameters.

Returns:

The result of the GET request as an InputStream.

Throws:

MalformedURLException - If the specified URL is invalid.

IOException - If an I/O error has occurred.

NullPointerException - If url is null.

doGet

public static InputStream doGet(String url,
                                Map<String,String[]> parameters,
                                String charset)
                         throws IOException,
                                UnsupportedEncodingException

Invoke a GET request on the specified URL with the provided parameter map and charset encoding. It is highly recommended to close the obtained InputStream after processing.

Parameters:

url - The URL to be invoked.

parameters - The parameters to be processed as query parameters.

charset - The encoding to be applied.

Returns:

The result of the GET request as an InputStream.

Throws:

MalformedURLException - If the specified URL is invalid.

IOException - If an I/O error has occurred.

UnsupportedEncodingException - If the provided charset is not supported.

NullPointerException - If url is null.

doPost

public static InputStream doPost(URL url,
                                 Map<String,String[]> parameters)
                          throws IOException

Invoke a POST request on the specified URL with the provided parameter map which will be encoded as UTF-8. It is highly recommended to close the obtained InputStream after processing.

Parameters:

url - The URL to be invoked.

parameters - The parameters to be processed as query parameters.

Returns:

The result of the POST request as an InputStream.

Throws:

MalformedURLException - If the specified URL is invalid.

IOException - If an I/O error has occurred.

NullPointerException - If url is null.

doPost

public static InputStream doPost(URL url,
                                 Map<String,String[]> parameters,
                                 Properties properties)
                          throws IOException

Invoke a POST request on the specified URL with the provided parameter map which will be encoded as UTF-8. It is highly recommended to close the obtained InputStream after processing.

Parameters:

url - The URL to be invoked.

parameters - The parameters to be processed as query parameters.

properties - The request properties to be processed as header properties.

Returns:

The result of the POST request as an InputStream.

Throws:

MalformedURLException - If the specified URL is invalid.

IOException - If an I/O error has occurred.

NullPointerException - If url is null.

doPost

public static InputStream doPost(URL url,
                                 Map<String,String[]> parameters,
                                 Properties properties,
                                 List<String> cookies)
                          throws IOException

Invoke a POST request on the specified URL with the provided parameter map which will be encoded as UTF-8. It is highly recommended to close the obtained InputStream after processing.

Parameters:

url - The URL to be invoked.

parameters - The parameters to be processed as query parameters.

properties - The request properties to be processed as header properties.

cookies - The cookies to be injected into the header.

Returns:

The result of the POST request as an InputStream.

Throws:

MalformedURLException - If the specified URL is invalid.

IOException - If an I/O error has occurred.

NullPointerException - If url is null.

createQuery

public static String createQuery(Map<String,String[]> parameters,
                                 String charset)
                          throws UnsupportedEncodingException

Create a query string based on the specified parameter map and the provided charset encoding.

Parameters:

parameters - The parameter map to be processed as query parameters.

charset - The encoding to be applied.

Returns:

The parameter map as query string.

Throws:

UnsupportedEncodingException - If the provided charset is not supported.