de.samply.common.http

Class HttpConnector

java.lang.Object

de.samply.common.http.HttpConnector

public class HttpConnector
extends Object

Connector class to provide apache http connectors and jersey http connectors includes http and https proxy support.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROXY_BYPASS_PRIVATE_NETWORKS
static String	PROXY_HTTP_HOST The hostname of the http proxy.
static String	PROXY_HTTP_PASSWORD The password for the http proxy.
static String	PROXY_HTTP_PORT The port of the http proxy.
static String	PROXY_HTTP_USERNAME The username for the http proxy.
static String	PROXY_HTTPS_HOST The hostname of the https proxy.
static String	PROXY_HTTPS_PASSWORD The password for the https proxy.
static String	PROXY_HTTPS_PORT The port of the https proxy.
static String	PROXY_HTTPS_USERNAME The username for the https proxy.
static String	USER_AGENT The hostname of the http proxy.

Constructor Summary

Constructors

Constructor and Description
HttpConnector() Instantiates a new http connector.
HttpConnector(org.apache.commons.configuration.Configuration config) Instantiates a new http connector.
HttpConnector(de.samply.common.config.Configuration config) Instantiates new http connector with samply configuration.
HttpConnector(de.samply.common.config.Configuration config, boolean followRedirects) Instantiates new http connector with samply configuration.
HttpConnector(HashMap<String,String> config) Instantiates a new http connector.
HttpConnector(HashMap<String,String> config, org.apache.http.client.CredentialsProvider credentialsProvider) Instantiates a new http connector with provided Credentials Provider.
HttpConnector(HashMap<String,String> config, org.apache.http.client.CredentialsProvider credentialsProvider, int timeout) Instantiates a new http connector with provided Credentials Provider and a timeout.
HttpConnector(de.samply.common.config.Proxy config) Instantiates new http connector with samply proxy configuration.

Method Summary

Modifier and Type	Method and Description
void	addCredentials(org.apache.http.auth.AuthScope authScope, org.apache.http.auth.Credentials credentials) Add Credentials for a given Auth Scope.
void	addCustomHeader(org.apache.http.Header customHeader) Add custom Header and init client.
void	addCustomHeader(String key, String value)
void	addHttpAuth(String url, String username, String password) Adds the http auth.
String	addTrailingSlash(String in) Adds the trailing slash.
void	closeClients() Closes the clients.
org.apache.http.client.methods.CloseableHttpResponse	doAction(String action, String url, HashMap<String,String> headers, HashMap<String,String> params, String mediaType, String request, Boolean preemptiveAuth, Boolean preemptiveProxyAuthentication) Returns the result of a request submitted as ClosableHttpResponse NB: Do not forget to close the Response when done with it.
org.apache.http.client.methods.CloseableHttpResponse	doAction(String action, String url, HashMap<String,String> headers, HashMap<String,String> params, String mediaType, String request, Boolean preemptiveAuth, Boolean preemptiveProxyAuthentication, int retryCount) Returns the result of a request submitted as ClosableHttpResponse NB: Do not forget to close the Response when done with it.
HashMap<String,Object>	doActionHashMap(String action, String url, HashMap<String,String> headers, HashMap<String,String> params, String contentType, String request, Boolean preemptiveAuth, Boolean preemptiveProxy) Returns the result of a request submitted as a HashMap with the fields: body: The Response body as String statuscode: The Response statuscode as int headers: The Response headers as Header[].
HashMap<String,Object>	doActionHashMap(String action, String url, HashMap<String,String> headers, HashMap<String,String> params, String contentType, String request, Boolean preemptiveAuth, Boolean preemptiveProxy, int retryCount) Returns the result of a request submitted as a HashMap with the fields: body: The Response body as String statuscode: The Response statuscode as int headers: The Response headers as Header[].
com.sun.jersey.api.client.Client	getClient(org.apache.http.impl.client.CloseableHttpClient httpClient) Get an Jersey Client.
com.sun.jersey.api.client.Client	getClient(org.apache.http.impl.client.CloseableHttpClient httpClient, Boolean failOnUnknownProperties) Transforms a apache httpclient to a jersey client also enables POJO MAPPING as feature.
org.apache.http.client.CredentialsProvider	getCp() Gets the Credentials Provider.
List<org.apache.http.Header>	getCustomHeaders()
org.apache.http.impl.client.CloseableHttpClient	getHttpc() Deprecated.
org.apache.http.impl.client.CloseableHttpClient	getHttpClient(org.apache.http.HttpHost target) Returns the CloseableHttpClient based on a HttpHost.
org.apache.http.impl.client.CloseableHttpClient	getHttpClient(String urlOrScheme) Returns the CloseableHttpClient based on a given url or scheme.
org.apache.http.impl.client.CloseableHttpClient	getHttpClient(URL url) Returns the CloseableHttpClient based on a given URL.
org.apache.http.impl.client.CloseableHttpClient	getHttpClientForHttp() Returns the CloseableHttpClient (with http proxy if proxy is used).
org.apache.http.impl.client.CloseableHttpClient	getHttpClientForHttps() Returns the CloseableHttpClient (with https proxy if proxy is used).
org.apache.http.impl.client.CloseableHttpClient	getHttpsc() Deprecated.
javax.ws.rs.client.Client	getJaxRsClient(String urlOrScheme) Return a JAX-RS Client build with org.glassfish.jersey and ApacheConnectorProvider.
javax.ws.rs.client.Client	getJaxRsClient(String urlOrScheme, Boolean failOnUnknownProperties) Returns a JAX-RS Client build with org.glassfish.jersey and ApacheConnectorProvider.
javax.ws.rs.client.Client	getJaxRsClient(URL url) Return a JAX-RS Client build with org.glassfish.jersey and ApacheConnectorProvider.
javax.ws.rs.client.Client	getJaxRsClient(URL url, Boolean failOnUnknownProperties) Return a JAX-RS Client build with org.glassfish.jersey and ApacheConnectorProvider.
com.sun.jersey.api.client.Client	getJerseyClient(org.apache.http.HttpHost target) Returns a jersey client for a given httphost.
com.sun.jersey.api.client.Client	getJerseyClient(org.apache.http.HttpHost target, Boolean failOnUnknownProperties) Returns a jersey client for a given httphost.
com.sun.jersey.api.client.Client	getJerseyClient(String urlOrScheme) Returns a jersey client for a given url or Scheme.
com.sun.jersey.api.client.Client	getJerseyClient(String urlOrScheme, Boolean failOnUnknownProperties) Returns a jersey client for a given url or Scheme.
com.sun.jersey.api.client.Client	getJerseyClient(URL url) Returns a jersey client for a given java.net.URL This client will fail on unknown properties.
com.sun.jersey.api.client.Client	getJerseyClient(URL url, Boolean failOnUnknownProperties) Returns a jersey client for a given java.net.URL
com.sun.jersey.api.client.Client	getJerseyClientForHttp() Returns a jersey client for http connections.
com.sun.jersey.api.client.Client	getJerseyClientForHttp(Boolean failOnUnknownProperties) Returns a jersey client for http connections.
com.sun.jersey.api.client.Client	getJerseyClientForHttps() Returns a jersey client for https connections.
com.sun.jersey.api.client.Client	getJerseyClientForHttps(Boolean failOnUnknownProperties) Returns a jersey client for https connections.
org.apache.http.HttpHost	getProxy(String target) Returns the proxy needed for the given target.
String	getUserAgent() Get the current User Agent.
String	removeDuplicateSlashes(String in) Removes the duplicate slashes.
void	setCp(org.apache.http.client.CredentialsProvider credentialsProvider) Sets the Credentials Provider and reinitialized the clients.
void	setCustomHeaders(List<org.apache.http.Header> customHeaders)
void	setUserAgent(String userAgent) Set the User Agent.

Methods inherited from class java.lang.Object

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

Field Detail

PROXY_HTTPS_PASSWORD

public static final String PROXY_HTTPS_PASSWORD

The password for the https proxy.

See Also:

Constant Field Values

PROXY_HTTPS_USERNAME

public static final String PROXY_HTTPS_USERNAME

The username for the https proxy.

See Also:

Constant Field Values

PROXY_HTTP_PASSWORD

public static final String PROXY_HTTP_PASSWORD

The password for the http proxy.

See Also:

Constant Field Values

PROXY_HTTP_USERNAME

public static final String PROXY_HTTP_USERNAME

The username for the http proxy.

See Also:

Constant Field Values

PROXY_HTTPS_PORT

public static final String PROXY_HTTPS_PORT

The port of the https proxy.

See Also:

Constant Field Values

PROXY_HTTPS_HOST

public static final String PROXY_HTTPS_HOST

The hostname of the https proxy.

See Also:

Constant Field Values

PROXY_HTTP_PORT

public static final String PROXY_HTTP_PORT

The port of the http proxy.

See Also:

Constant Field Values

PROXY_HTTP_HOST

public static final String PROXY_HTTP_HOST

The hostname of the http proxy.

See Also:

Constant Field Values

USER_AGENT

public static final String USER_AGENT

The hostname of the http proxy.

See Also:

Constant Field Values

PROXY_BYPASS_PRIVATE_NETWORKS

public static final String PROXY_BYPASS_PRIVATE_NETWORKS

See Also:

Constant Field Values

Constructor Detail

HttpConnector

public HttpConnector()

Instantiates a new http connector.

HttpConnector

public HttpConnector(org.apache.commons.configuration.Configuration config)

Instantiates a new http connector.

Parameters:

config - the config

HttpConnector

public HttpConnector(HashMap<String,String> config)

Instantiates a new http connector.

Parameters:

config - the config

HttpConnector

public HttpConnector(HashMap<String,String> config,
                     org.apache.http.client.CredentialsProvider credentialsProvider)

Instantiates a new http connector with provided Credentials Provider.

Parameters:

config - the config

credentialsProvider - the preconfigured Credentials Provider

HttpConnector

public HttpConnector(HashMap<String,String> config,
                     org.apache.http.client.CredentialsProvider credentialsProvider,
                     int timeout)

Instantiates a new http connector with provided Credentials Provider and a timeout.

Parameters:

config - the config

credentialsProvider - the preconfigured Credentials Provider

timeout - timeout in seconds

HttpConnector

public HttpConnector(de.samply.common.config.Configuration config)

Instantiates new http connector with samply configuration.

Parameters:

config - Samply Configuration

HttpConnector

public HttpConnector(de.samply.common.config.Configuration config,
                     boolean followRedirects)

Instantiates new http connector with samply configuration.

Parameters:

config - Samply Configuration

followRedirects - if redirect must be performed or not

HttpConnector

public HttpConnector(de.samply.common.config.Proxy config)

Instantiates new http connector with samply proxy configuration.

Parameters:

config - Samply Proxy (no keystore settings!)

Method Detail

closeClients

public void closeClients()
                  throws IOException

Closes the clients.

Throws:

IOException - ioException

doAction

public org.apache.http.client.methods.CloseableHttpResponse doAction(String action,
                                                                     String url,
                                                                     HashMap<String,String> headers,
                                                                     HashMap<String,String> params,
                                                                     String mediaType,
                                                                     String request,
                                                                     Boolean preemptiveAuth,
                                                                     Boolean preemptiveProxyAuthentication)
                                                              throws HttpConnectorException

Returns the result of a request submitted as ClosableHttpResponse NB: Do not forget to close the Response when done with it.

Parameters:

action - action method as string: get, post

url - The target URL

headers - HashMap<String,String> of headers to be added

params - HashMap<String,String> of params to be added to the URL

mediaType - Content-type of the request (defaults to application/json)

request - Request string

preemptiveAuth - Whether or not to send preemptive web authorization

preemptiveProxyAuthentication - Whether or not to send preemptive proxy authorization

Returns:

HashMap<String, Object> Hashmap of: String body, Header[] headers, int statuscode

Throws:

HttpConnectorException - the http connector exception

doAction

public org.apache.http.client.methods.CloseableHttpResponse doAction(String action,
                                                                     String url,
                                                                     HashMap<String,String> headers,
                                                                     HashMap<String,String> params,
                                                                     String mediaType,
                                                                     String request,
                                                                     Boolean preemptiveAuth,
                                                                     Boolean preemptiveProxyAuthentication,
                                                                     int retryCount)
                                                              throws HttpConnectorException

Returns the result of a request submitted as ClosableHttpResponse NB: Do not forget to close the Response when done with it.

Parameters:

action - action method as string: get, post

url - The target URL

headers - HashMap<String,String> of headers to be added

params - HashMap<String,String> of params to be added to the URL

mediaType - Content-type of the request (defaults to application/json)

request - Request string

preemptiveAuth - Whether or not to send preemptive web authorization

preemptiveProxyAuthentication - Whether or not to send preemptive proxy authorization

retryCount - how many times to retry; 0 means no retries

Returns:

HashMap<String, Object> Hashmap of: String body, Header[] headers, int statuscode

Throws:

HttpConnectorException - the http connector exception

doActionHashMap

public HashMap<String,Object> doActionHashMap(String action,
                                              String url,
                                              HashMap<String,String> headers,
                                              HashMap<String,String> params,
                                              String contentType,
                                              String request,
                                              Boolean preemptiveAuth,
                                              Boolean preemptiveProxy)
                                       throws HttpConnectorException

Returns the result of a request submitted as a HashMap with the fields: body: The Response body as String statuscode: The Response statuscode as int headers: The Response headers as Header[].

Parameters:

action - action method as string: get, post

url - The target url

headers - HashMap<String,String> of headers to be added

params - HashMap<String,String> of params to be added to the url

contentType - Content-type of the request (defaults to application/json)

request - Request string

preemptiveAuth - Whether or not to send preemptive web authorization

preemptiveProxy - Whether or not to send preemptive proxy authorization

Returns:

HashMap<String, Object> Hashmap of: String body, Header[] headers, int statuscode

Throws:

HttpConnectorException - the http connector exception

doActionHashMap

public HashMap<String,Object> doActionHashMap(String action,
                                              String url,
                                              HashMap<String,String> headers,
                                              HashMap<String,String> params,
                                              String contentType,
                                              String request,
                                              Boolean preemptiveAuth,
                                              Boolean preemptiveProxy,
                                              int retryCount)
                                       throws HttpConnectorException

Returns the result of a request submitted as a HashMap with the fields: body: The Response body as String statuscode: The Response statuscode as int headers: The Response headers as Header[].

Parameters:

action - action method as string: get, post

url - The target url

headers - HashMap<String,String> of headers to be added

params - HashMap<String,String> of params to be added to the url

contentType - Content-type of the request (defaults to application/json)

request - Request string

preemptiveAuth - Whether or not to send preemptive web authorization

preemptiveProxy - Whether or not to send preemptive proxy authorization

retryCount - how many times to retry; 0 means no retries

Returns:

HashMap<String, Object> Hashmap of: String body, Header[] headers, int statuscode

Throws:

HttpConnectorException - the http connector exception

addTrailingSlash

public String addTrailingSlash(String in)

Adds the trailing slash.

Parameters:

in - the in

Returns:

the string

removeDuplicateSlashes

public String removeDuplicateSlashes(String in)

Removes the duplicate slashes.

Parameters:

in - the in

Returns:

the string

getClient

public com.sun.jersey.api.client.Client getClient(org.apache.http.impl.client.CloseableHttpClient httpClient,
                                                  Boolean failOnUnknownProperties)

Transforms a apache httpclient to a jersey client also enables POJO MAPPING as feature.

Parameters:

httpClient - the http client

failOnUnknownProperties - if the client shall fail on deserialisation on unknown or unignorable properties

Returns:

com.sun.jersey.api.client.Client

getClient

public com.sun.jersey.api.client.Client getClient(org.apache.http.impl.client.CloseableHttpClient httpClient)

Get an Jersey Client.

Parameters:

httpClient - the httpclient

Returns:

httpclient

See Also:

This client will fail on unknown properties.

getJerseyClientForHttp

public com.sun.jersey.api.client.Client getJerseyClientForHttp()

Returns a jersey client for http connections. This client will fail on unknown properties.

Returns:

com.sun.jersey.api.client.Client jersey client

getJerseyClientForHttp

public com.sun.jersey.api.client.Client getJerseyClientForHttp(Boolean failOnUnknownProperties)

Returns a jersey client for http connections.

Parameters:

failOnUnknownProperties - if or not to fail on unknown properties

Returns:

com.sun.jersey.api.client.Client jersey client

getJerseyClientForHttps

public com.sun.jersey.api.client.Client getJerseyClientForHttps()

Returns a jersey client for https connections. This client will fail on unknown properties.

Returns:

com.sun.jersey.api.client.Client jersey client

getJerseyClientForHttps

public com.sun.jersey.api.client.Client getJerseyClientForHttps(Boolean failOnUnknownProperties)

Returns a jersey client for https connections.

Parameters:

failOnUnknownProperties - if or not to fail on unknown properties

Returns:

com.sun.jersey.api.client.Client jersey client

getJerseyClient

public com.sun.jersey.api.client.Client getJerseyClient(org.apache.http.HttpHost target,
                                                        Boolean failOnUnknownProperties)

Returns a jersey client for a given httphost.

Parameters:

target - the target

failOnUnknownProperties - if or not to fail on unknown properties

Returns:

com.sun.jersey.api.client.Client jersey client

getJerseyClient

public com.sun.jersey.api.client.Client getJerseyClient(org.apache.http.HttpHost target)

Returns a jersey client for a given httphost. This client will fail on unknown properties

Parameters:

target - the target

Returns:

com.sun.jersey.api.client.Client jersey client

getJerseyClient

public com.sun.jersey.api.client.Client getJerseyClient(String urlOrScheme)

Returns a jersey client for a given url or Scheme. This client will fail on unknown properties

Parameters:

urlOrScheme - the url or scheme

Returns:

com.sun.jersey.api.client.Client jersey client

getJerseyClient

public com.sun.jersey.api.client.Client getJerseyClient(String urlOrScheme,
                                                        Boolean failOnUnknownProperties)

Returns a jersey client for a given url or Scheme.

Parameters:

urlOrScheme - the url or scheme

failOnUnknownProperties - if or not to fail on unknown properties

Returns:

com.sun.jersey.api.client.Client jersey client

getJerseyClient

public com.sun.jersey.api.client.Client getJerseyClient(URL url)

Returns a jersey client for a given java.net.URL This client will fail on unknown properties.

Parameters:

url - the url

Returns:

com.sun.jersey.api.client.Client jersey client

getJerseyClient

public com.sun.jersey.api.client.Client getJerseyClient(URL url,
                                                        Boolean failOnUnknownProperties)

Returns a jersey client for a given java.net.URL

Parameters:

url - the url

failOnUnknownProperties - if or not to fail on unknown properties

Returns:

the jersey client

getJaxRsClient

public javax.ws.rs.client.Client getJaxRsClient(URL url)

Return a JAX-RS Client build with org.glassfish.jersey and ApacheConnectorProvider. The client will fail then receiving unknown properties in result

Parameters:

url - The url which the client should connect to

Returns:

the JAX-RS Client

getJaxRsClient

public javax.ws.rs.client.Client getJaxRsClient(URL url,
                                                Boolean failOnUnknownProperties)

Return a JAX-RS Client build with org.glassfish.jersey and ApacheConnectorProvider.

Parameters:

url - The url which the client should connect to.

failOnUnknownProperties - Wether to fail or ignore unknown properties in the result.

Returns:

the JAX-RS Client

getJaxRsClient

public javax.ws.rs.client.Client getJaxRsClient(String urlOrScheme)

Return a JAX-RS Client build with org.glassfish.jersey and ApacheConnectorProvider. The client will fail then receiving unknown properties in result

Parameters:

urlOrScheme - either the protocol or the url for which the client will be used

Returns:

the JAX-RS Client

getJaxRsClient

public javax.ws.rs.client.Client getJaxRsClient(String urlOrScheme,
                                                Boolean failOnUnknownProperties)

Returns a JAX-RS Client build with org.glassfish.jersey and ApacheConnectorProvider.

Parameters:

urlOrScheme - either the protocol or the url for which the client will be used

failOnUnknownProperties - if or not to fail on unknown properties

Returns:

the JAX-RS Client

getProxy

public org.apache.http.HttpHost getProxy(String target)
                                  throws MalformedURLException

Returns the proxy needed for the given target.

Parameters:

target - A web-url / link

Returns:

HttpHost The proxy to be used

Throws:

MalformedURLException - string not well formed

getCp

public org.apache.http.client.CredentialsProvider getCp()

Gets the Credentials Provider.

Returns:

the Credentials Provider

setCp

public void setCp(org.apache.http.client.CredentialsProvider credentialsProvider)

Sets the Credentials Provider and reinitialized the clients.

Parameters:

credentialsProvider - the new Credentials Provider.

getUserAgent

public String getUserAgent()

Get the current User Agent.

Returns:

the userAgent

setUserAgent

public void setUserAgent(String userAgent)

Set the User Agent.

Parameters:

userAgent - the userAgent to set

getHttpClient

public org.apache.http.impl.client.CloseableHttpClient getHttpClient(org.apache.http.HttpHost target)

Returns the CloseableHttpClient based on a HttpHost.

Parameters:

target - HttpHost

Returns:

CloseableHttpClient

getHttpClient

public org.apache.http.impl.client.CloseableHttpClient getHttpClient(URL url)

Returns the CloseableHttpClient based on a given URL.

Parameters:

url - URL

Returns:

CloseableHttpClient

getHttpClient

public org.apache.http.impl.client.CloseableHttpClient getHttpClient(String urlOrScheme)

Returns the CloseableHttpClient based on a given url or scheme.

Parameters:

urlOrScheme - The web-link or scheme (http, https)

Returns:

CloseableHttpClient

getHttpc

@Deprecated
public org.apache.http.impl.client.CloseableHttpClient getHttpc()

Deprecated.

Returns the CloseableHttpClient (with http proxy if proxy is used).

Returns:

CloseableHttpClient

getHttpClientForHttp

public org.apache.http.impl.client.CloseableHttpClient getHttpClientForHttp()

Returns the CloseableHttpClient (with http proxy if proxy is used).

Returns:

CloseableHttpClient

getHttpsc

@Deprecated
public org.apache.http.impl.client.CloseableHttpClient getHttpsc()

Deprecated.

Returns the CloseableHttpClient (with https proxy if proxy is used).

Returns:

CloseableHttpClient

getHttpClientForHttps

public org.apache.http.impl.client.CloseableHttpClient getHttpClientForHttps()

Returns the CloseableHttpClient (with https proxy if proxy is used).

Returns:

CloseableHttpClient

addHttpAuth

public void addHttpAuth(String url,
                        String username,
                        String password)
                 throws MalformedURLException

Adds the http auth.

Parameters:

url - the url

username - the username

password - the password

Throws:

MalformedURLException - the malformed url exception

addCredentials

public void addCredentials(org.apache.http.auth.AuthScope authScope,
                           org.apache.http.auth.Credentials credentials)

Add Credentials for a given Auth Scope.

Parameters:

authScope - the auth scope

credentials - the credentials

getCustomHeaders

public List<org.apache.http.Header> getCustomHeaders()

setCustomHeaders

public void setCustomHeaders(List<org.apache.http.Header> customHeaders)

addCustomHeader

public void addCustomHeader(org.apache.http.Header customHeader)

Add custom Header and init client.

Parameters:

customHeader - the custom header

addCustomHeader

public void addCustomHeader(String key,
                            String value)