de.florianmichael.rclasses.common

Class WebUtils

java.lang.Object

de.florianmichael.rclasses.common.WebUtils

public class WebUtils
extends java.lang.Object

Utility class for web requests.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCEPT_METHOD
static WebUtils	DEFAULT Creates a new instance of WebUtils with the default user agent and accept method.
static java.lang.String	DEFAULT_AGENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebUtils(java.lang.String userAgent, java.lang.String acceptMethod) Creates a new instance of WebUtils with the given user agent and accept method.

Method Summary

Modifier and Type	Method and Description
static WebUtils	create() Performs a POST request to the given URL with the given input.
static WebUtils	create(java.lang.String userAgent) Performs a POST request to the given URL with the given input.
static WebUtils	create(java.lang.String userAgent, java.lang.String acceptMethod) Performs a POST request to the given URL with the given input.
java.lang.String	get(java.lang.String url) Performs a GET request to the given URL.
static java.lang.String	performGet(java.lang.String userAgent, java.lang.String acceptMethod, java.lang.String url) Performs a POST request to the given URL with the given input.
static java.lang.String	performGet(java.lang.String userAgent, java.lang.String acceptMethod, java.lang.String url, java.util.Map<java.lang.String,java.lang.String> optionalHeaders) Performs a GET request to the given URL with the given input.
static java.lang.String	performPost(java.lang.String userAgent, java.lang.String acceptMethod, java.lang.String url, java.util.Map<java.lang.String,java.lang.String> optionalHeaders, java.lang.String... input) Performs a POST request to the given URL with the given input.
static java.lang.String	performPost(java.lang.String userAgent, java.lang.String acceptMethod, java.lang.String url, java.lang.String... input) Performs a POST request to the given URL with the given input.
java.lang.String	post(java.lang.String url, java.lang.String... input) Performs a POST request to the given URL with the given input.
WebUtils	removeHeader(java.lang.String key) Removes an optional header from the request.
WebUtils	withHeader(java.lang.String key, java.lang.String value) Adds an optional header to the request.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final WebUtils DEFAULT

Creates a new instance of WebUtils with the default user agent and accept method.

DEFAULT_AGENT

public static final java.lang.String DEFAULT_AGENT

See Also:

Constant Field Values

ACCEPT_METHOD

public static final java.lang.String ACCEPT_METHOD

See Also:

Constant Field Values

Constructor Detail

WebUtils

protected WebUtils(java.lang.String userAgent,
                   java.lang.String acceptMethod)

Creates a new instance of WebUtils with the given user agent and accept method.

Parameters:

userAgent - the user agent

acceptMethod - the accept method

Method Detail

withHeader

public WebUtils withHeader(java.lang.String key,
                           java.lang.String value)

Adds an optional header to the request.

Parameters:

key - header key

value - header value

Returns:

this

removeHeader

public WebUtils removeHeader(java.lang.String key)

Removes an optional header from the request.

Parameters:

key - header key

Returns:

this

get

public java.lang.String get(java.lang.String url)
                     throws java.io.IOException

Performs a GET request to the given URL.

Parameters:

url - the url

Returns:

the response

Throws:

java.io.IOException - if an error occurs

post

public java.lang.String post(java.lang.String url,
                             java.lang.String... input)
                      throws java.io.IOException

Performs a POST request to the given URL with the given input.

Parameters:

url - the url

input - the input

Returns:

the response

Throws:

java.io.IOException - if an error occurs

create

public static WebUtils create()

Performs a POST request to the given URL with the given input.

Returns:

the response

create

public static WebUtils create(java.lang.String userAgent)

Performs a POST request to the given URL with the given input.

Parameters:

userAgent - the user agent

Returns:

the response

create

public static WebUtils create(java.lang.String userAgent,
                              java.lang.String acceptMethod)

Performs a POST request to the given URL with the given input.

Parameters:

userAgent - the user agent

acceptMethod - the accept method

Returns:

the response

performGet

public static java.lang.String performGet(java.lang.String userAgent,
                                          java.lang.String acceptMethod,
                                          java.lang.String url)
                                   throws java.io.IOException

Performs a POST request to the given URL with the given input.

Parameters:

userAgent - the user agent

acceptMethod - the accept method

url - the url

Returns:

the response

Throws:

java.io.IOException - if an error occurs

performGet

public static java.lang.String performGet(java.lang.String userAgent,
                                          java.lang.String acceptMethod,
                                          java.lang.String url,
                                          java.util.Map<java.lang.String,java.lang.String> optionalHeaders)
                                   throws java.io.IOException

Performs a GET request to the given URL with the given input.

Parameters:

userAgent - the user agent

acceptMethod - the accept method

url - the url

optionalHeaders - the optional headers

Returns:

the response

Throws:

java.io.IOException - if an error occurs

performPost

public static java.lang.String performPost(java.lang.String userAgent,
                                           java.lang.String acceptMethod,
                                           java.lang.String url,
                                           java.lang.String... input)
                                    throws java.io.IOException

Performs a POST request to the given URL with the given input.

Parameters:

userAgent - the user agent

acceptMethod - the accept method

url - the url

input - the input

Returns:

the response

Throws:

java.io.IOException - if an error occurs

performPost

public static java.lang.String performPost(java.lang.String userAgent,
                                           java.lang.String acceptMethod,
                                           java.lang.String url,
                                           java.util.Map<java.lang.String,java.lang.String> optionalHeaders,
                                           java.lang.String... input)
                                    throws java.io.IOException

Performs a POST request to the given URL with the given input.

Parameters:

userAgent - the user agent

acceptMethod - the accept method

url - the url

optionalHeaders - the optional headers

input - the input

Returns:

the response

Throws:

java.io.IOException - if an error occurs