net.obvj.jep.http

Class WebServiceUtils

java.lang.Object

net.obvj.jep.http.WebServiceUtils

public class WebServiceUtils
extends Object

This class contains methods for working with simple Web Services.

Author:

oswaldo.bapvic.jr

Method Summary

Modifier and Type	Method and Description
static String	generateBasicAuthorizationHeader(String username, String password) Generates a basic authorization header from the given credentials.
static WebServiceResponse	get(String url) Executes HTTP GET on a given URL.
static WebServiceResponse	get(String url, Map<String,String> headers) Executes HTTP GET on a given URL, with custom headers
static String	getAsString(String url) Executes HTTP GET on given URL.
static String	getAsString(String url, Map<String,String> headers) Executes HTTP GET on a given URL with custom headers.
static String	getResponseAsString(WebServiceResponse webServiceResponse) Returns the HTTP response body, as string, given an HTTP client response.
static int	getStatusCode(WebServiceResponse webServiceResponse) Returns the HTTP status code, given an HTTP response.
static WebServiceResponse	invoke(String method, String url, Object requestEntity) Executes the requested HTTP method on a given URL.
static WebServiceResponse	invoke(String method, String url, Object requestEntity, Map<String,String> headers) Executes the requested HTTP method on a given URL, with custom headers.

Methods inherited from class java.lang.Object

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

Method Detail

getAsString

public static String getAsString(String url)

Executes HTTP GET on given URL. Returns the HTTP content as a string, if the status code received from the Web Server is one of the class 2xx (success).

Parameters:

url - the URL of the resource

Returns:

a string with the content received from the Web server, if the request was successful; an empty string, otherwise

getAsString

public static String getAsString(String url,
                                 Map<String,String> headers)

Executes HTTP GET on a given URL with custom headers. Returns the HTTP content as a string, if the status code received from the Web Server is one of the class 2xx (success).

Parameters:

url - the URL of the resource

headers - a map of custom headers to be added to the request

Returns:

a string with the content received from the Web server, if the request was successful; an empty string, otherwise

getResponseAsString

public static String getResponseAsString(WebServiceResponse webServiceResponse)

Returns the HTTP response body, as string, given an HTTP client response.

Parameters:

webServiceResponse - the HTTP client response

Returns:

the response body, as string

get

public static WebServiceResponse get(String url)

Executes HTTP GET on a given URL.

Parameters:

url - the URL of the resource

Returns:

a WebServiceResponse object, which may contain the HTTP status code and the content returned from the Web Service

get

public static WebServiceResponse get(String url,
                                     Map<String,String> headers)

Executes HTTP GET on a given URL, with custom headers

Parameters:

url - the URL of the resource

headers - a map of custom headers to be added to the request; can be null

Returns:

a WebServiceResponse object, which may contain the HTTP status code and the content returned from the Web Service

invoke

public static WebServiceResponse invoke(String method,
                                        String url,
                                        Object requestEntity)

Executes the requested HTTP method on a given URL.

Parameters:

method - the HTTP method to be invoked

url - the URL of the resource

requestEntity - the request body entity/payload to be sent; can be null

Returns:

a WebServiceResponse object, which may contain the HTTP status code and the content returned from the Web Service

invoke

public static WebServiceResponse invoke(String method,
                                        String url,
                                        Object requestEntity,
                                        Map<String,String> headers)

Executes the requested HTTP method on a given URL, with custom headers.

Parameters:

method - the HTTP method to be invoked

url - the URL of the resource

requestEntity - the request body entity/payload to be sent; can be null

headers - a map of custom headers to be added to the request; can be null

Returns:

a WebServiceResponse object, which may contain the HTTP status code and the content returned from the Web Service

Throws:

IllegalArgumentException - if the HTTP method is null or empty

getStatusCode

public static int getStatusCode(WebServiceResponse webServiceResponse)

Returns the HTTP status code, given an HTTP response.

Parameters:

webServiceResponse - the HTTP client response

Returns:

the status code

generateBasicAuthorizationHeader

public static final String generateBasicAuthorizationHeader(String username,
                                                            String password)

Generates a basic authorization header from the given credentials.

Parameters:

username - the username to be encoded

password - the password to be encoded

Returns:

a String containing the generated the basic authorization header value