com.jsunsoft.http

Interface HttpRequest<T>

Type Parameters:

T - Type of expected successful response

public interface HttpRequest<T>

Method Summary

Modifier and Type	Method and Description
com.jsunsoft.http.BasicHttpRequest<T>	addUriPostfix(String postfix)
default com.jsunsoft.http.BasicHttpRequest<T>	changeUri(String newUri)
com.jsunsoft.http.BasicHttpRequest<T>	changeUri(URI newUri)
default ResponseHandler<T>	execute() Sends request.
default ResponseHandler<T>	execute(Collection<? extends NameValuePair> params) Sends request
default ResponseHandler<T>	execute(Map<String,String> params) Sends request
ResponseHandler<T>	execute(NameValuePair... params) Sends request
default ResponseHandler<T>	execute(String... nameValues) Sends request as [nameValues[0]: nameValues[1], nameValues[2]: nameValues[3], ...
default ResponseHandler<T>	execute(String name, String value) Sends request with one parameter (name: value)
ResponseHandler<T>	executeWithBody(String payload) Sends request with body.
default ResponseHandler<T>	executeWithQuery(String queryString) Sends request by queryString of request.
ResponseHandler<T>	executeWithQuery(String queryString, String characterEncoding) Sends request by queryString of request.
HttpMethod	getHttpMethod()
URI	getUri()

Method Detail

executeWithBody

ResponseHandler<T> executeWithBody(String payload)

Sends request with body. (Without params). By default contentType is APPLICATION_JSON

Parameters:

payload - value of body

Returns:

Instance of ResponseHandler. If connection failure status code is a503. If failed deserialization of response body status code is a 502

Throws:

NullPointerException - when param payload is null

executeWithQuery

ResponseHandler<T> executeWithQuery(String queryString,
                                    String characterEncoding)

Sends request by queryString of request. httpServletRequest.getQueryString()

Parameters:

queryString - queryString

characterEncoding - characterEncoding

Returns:

Instance of ResponseHandler. If connection failure status code is a503. If failed deserialization of response body status code is a 502

Throws:

UnsupportedCharsetException - Unchecked exception thrown when no support is available for a requested charset.

NullPointerException - when one of arguments is null

execute

ResponseHandler<T> execute(NameValuePair... params)

Sends request

Parameters:

params - parameters to send

Returns:

Instance of ResponseHandler. If connection failure status code is a 503. If failed deserialization of response body status code is a 502

Throws:

NullPointerException - when param params is null

changeUri

com.jsunsoft.http.BasicHttpRequest<T> changeUri(URI newUri)

Parameters:

newUri - the new uri to request. Should not be null.

Returns:

Returns a copy of this BasicHttpRequest instance with the specified uri of newUri.

changeUri

default com.jsunsoft.http.BasicHttpRequest<T> changeUri(String newUri)

Parameters:

newUri - the new uri to request. Should not be null.

Returns:

Returns a copy of this BasicHttpRequest instance with the specified uri of newUri.

addUriPostfix

com.jsunsoft.http.BasicHttpRequest<T> addUriPostfix(String postfix)

Parameters:

postfix - postfix to add to uri. Should not be null.

Returns:

Returns a copy of this instance with the uri by added postfix.

getHttpMethod

HttpMethod getHttpMethod()

Returns:

http method of request

getUri

URI getUri()

Returns:

request uri

executeWithQuery

default ResponseHandler<T> executeWithQuery(String queryString)

Sends request by queryString of request. httpServletRequest.getQueryString(). Default Char encoding "UTF-8".

Parameters:

queryString - queryString

Returns:

Instance of ResponseHandler. If connection failure status code is a503. If failed deserialization of response body status code is a 502

Throws:

UnsupportedCharsetException - Unchecked exception thrown when no support is available for a requested charset.

execute

default ResponseHandler<T> execute(String name,
                                   String value)

Sends request with one parameter (name: value)

Parameters:

name - parameter key

value - parameter value

Returns:

Instance of ResponseHandler. If connection failure status code is a 503. If failed deserialization of response body 502

Throws:

NullPointerException - when param name is null

execute

default ResponseHandler<T> execute()

Sends request.

Returns:

Instance of ResponseHandler. If connection failure status code is a 503. If failed deserialization of response body 502

execute

default ResponseHandler<T> execute(String... nameValues)

Sends request as [nameValues[0]: nameValues[1], nameValues[2]: nameValues[3], ... e.t.c.]
So name1 = nameValues[0], value1 = nameValues[1]; name2 = nameValues[1], value2 = nameValues[2] ... e.t.c.

Parameters:

nameValues - array of nameValue

Returns:

Instance of ResponseHandler. If connection failure status code is a 503. If failed deserialization of response body 502

Throws:

IllegalArgumentException - When length of parameter nameValues is odd or ZERO.

NullPointerException - when param nameValues is null

execute

default ResponseHandler<T> execute(Collection<? extends NameValuePair> params)

Sends request

Parameters:

params - parameters to send

Returns:

Instance of ResponseHandler. If connection failure status code is a503. If failed deserialization of response body status code is a 502

Throws:

NullPointerException - when param params is null

execute

default ResponseHandler<T> execute(Map<String,String> params)

Sends request

Parameters:

params - parameters to send

Returns:

Instance of ResponseHandler. If connection failure status code is a503. If failed deserialization of response body status code is a 502

Throws:

NullPointerException - when param params is null