org.jahia.services.notification

Class HttpClientService

java.lang.Object

org.jahia.services.notification.HttpClientService

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.web.context.ServletContextAware

public class HttpClientService
extends Object
implements org.springframework.web.context.ServletContextAware

Utility class for HTTP communication.
Parts of it are based on the code of the JSTL's <c:import> tag, for reading the content of the provided URL.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
HttpClientService()

Method Summary

Modifier and Type	Method and Description
String	executeGet(String url) Executes a request with GET method to the specified URL and reads the response content as a string.
String	executeGet(String url, Map<String,String> headers) Executes a request with GET method to the specified URL and reads the response content as a string.
String	executePost(String url, Map<String,String> parameters, Map<String,String> headers) Executes a request with POST method to the specified URL and reads the response content as a string.
String	executePost(String url, Map<String,String> parameters, Map<String,String> headers, org.apache.commons.httpclient.HttpState state) Executes a request with POST method to the specified URL and reads the response content as a string.
String	getAbsoluteResourceAsString(String url) Connects to the specified absolute URL and reads its content as a string.
String	getContextResourceAsString(String url) Retrieves the content of the resource, specified by the provided URL.
org.apache.commons.httpclient.HttpClient	getHttpClient() Deprecated. since 7.1.2.3 Please, use getHttpClient(String) instead which properly handles proxy server settings, if any
org.apache.commons.httpclient.HttpClient	getHttpClient(String url) Detects the instance of the HttpClient that is the most appropriate to handle the specified URL, considering proxy settings, if any.
String	getResourceAsString(String url) Retrieves the content of the specified resource as a string.
String	getResourceAsString(String url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves resource content, specified by the provided URL.
static boolean	isAbsoluteUrl(String url) Returns true if our current URL is absolute, false otherwise.
void	setHttpClient(org.apache.commons.httpclient.HttpClient httpClient) Injects an instance of the HttpClient.
void	setServletContext(javax.servlet.ServletContext servletContext)
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientService

public HttpClientService()

Method Detail

isAbsoluteUrl

public static boolean isAbsoluteUrl(String url)

Returns true if our current URL is absolute, false otherwise.

See Also:

ImportSupport.isAbsoluteUrl(String)

executeGet

public String executeGet(String url)
                  throws IllegalArgumentException

Executes a request with GET method to the specified URL and reads the response content as a string.

Parameters:

url - a URL to connect to

Returns:

the string representation of the URL connection response

Throws:

{@link - IllegalArgumentException} in case of a malformed URL

IllegalArgumentException

executeGet

public String executeGet(String url,
                         Map<String,String> headers)
                  throws IllegalArgumentException

Executes a request with GET method to the specified URL and reads the response content as a string.

Parameters:

url - a URL to connect to

headers - request headers to be set for connection; null if no additional headers needs to be set

Returns:

the string representation of the URL connection response

Throws:

{@link - IllegalArgumentException} in case of a malformed URL

IllegalArgumentException

executePost

public String executePost(String url,
                          Map<String,String> parameters,
                          Map<String,String> headers)
                   throws IllegalArgumentException

Executes a request with POST method to the specified URL and reads the response content as a string.

Parameters:

url - a URL to connect to

parameters - the request parameter to submit; null if no parameters are passed

headers - request headers to be set for connection; null if no additional headers needs to be set

Returns:

the string representation of the URL connection response

Throws:

{@link - IllegalArgumentException} in case of a malformed URL

IllegalArgumentException

executePost

public String executePost(String url,
                          Map<String,String> parameters,
                          Map<String,String> headers,
                          org.apache.commons.httpclient.HttpState state)
                   throws IllegalArgumentException

Executes a request with POST method to the specified URL and reads the response content as a string.

Parameters:

url - a URL to connect to

parameters - the request parameter to submit; null if no parameters are passed

headers - request headers to be set for connection; null if no additional headers needs to be set

state - the HTTP state object if additional state options, e.g. credentials, needs to be specified; otherwise can be null

Returns:

the string representation of the URL connection response

Throws:

{@link - IllegalArgumentException} in case of a malformed URL

IllegalArgumentException

getAbsoluteResourceAsString

public String getAbsoluteResourceAsString(String url)
                                   throws IllegalArgumentException

Connects to the specified absolute URL and reads its content as a string.

Parameters:

url - the absolute URL to connect to

Returns:

the string representation of the URL connection response

Throws:

{@link - IllegalArgumentException} in case of a malformed URL

IllegalArgumentException

getContextResourceAsString

public String getContextResourceAsString(String url)
                                  throws IllegalArgumentException

Retrieves the content of the resource, specified by the provided URL. The resource should be available in the current servlet context.

Parameters:

url - the URL of the resource to be retrieved

Returns:

the string content of the resource

Throws:

{@link - IllegalArgumentException} in case of a malformed URL

IllegalArgumentException

See Also:

ServletContext.getResourceAsStream(String)

getHttpClient

@Deprecated
public org.apache.commons.httpclient.HttpClient getHttpClient()

Deprecated. since 7.1.2.3 Please, use getHttpClient(String) instead which properly handles proxy server settings, if any

Returns:

the httpClient

getHttpClient

public org.apache.commons.httpclient.HttpClient getHttpClient(String url)

Detects the instance of the HttpClient that is the most appropriate to handle the specified URL, considering proxy settings, if any.

Parameters:

url - the target URL to be used for the HTTP client request

Returns:

an instance of the HttpClient that is the most appropriate to handle the specified URL, considering proxy settings, if any

getResourceAsString

public String getResourceAsString(String url)
                           throws IllegalArgumentException

Retrieves the content of the specified resource as a string. If the absolute URL is provided, an HTTP connection is used to get the response. Otherwise the resource is considered to be current context resource and is retrieved using ServletContext.getResource(String) method.

Parameters:

url - the resource URL

Returns:

the string representation of the resource content

Throws:

{@link - IllegalArgumentException} in case of a malformed URL

IllegalArgumentException

getResourceAsString

public String getResourceAsString(String url,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws IllegalArgumentException

Retrieves resource content, specified by the provided URL.

Parameters:

url - the URL of the resource to be retrieved

Returns:

the string content of the resource

Throws:

{@link - IllegalArgumentException} in case of a malformed URL

IllegalArgumentException

setHttpClient

public void setHttpClient(org.apache.commons.httpclient.HttpClient httpClient)

Injects an instance of the HttpClient.

Parameters:

httpClient - an instance of the HttpClient

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

shutdown

public void shutdown()