org.thales.punch.libraries.utils.api

Class UtilHttp

java.lang.Object

org.thales.punch.libraries.utils.api.UtilHttp

public class UtilHttp
extends Object

Simple and safe method to execute http remote calls.

Author:

dimi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UtilHttp.Callback

Constructor Summary

Constructors

Constructor and Description
UtilHttp()

Method Summary

Modifier and Type	Method and Description
static String	applyPrefix(String host, String prefix) Apply a prefix for a host path Eg : http://host:port -> http://host:port/prefix manage '/' char concatenation
static List<org.apache.http.HttpHost>	applyScheme(List<org.apache.http.HttpHost> hosts, String scheme) Apply a scheme on all hosts in list
static org.apache.http.Header[]	authenticate(String user, String password, String token, String tokenType) Add required headers for token authentication
static ISettingsMap	getAuthenticationFromHeader(String header) Parse an header to generate map containing all credentials information (token type, token, username, password)
static String	getBodyAsTextLines(String resourceUrl) Fetch a remote HTTP resource.
static org.apache.http.HttpHost[]	getHttpHosts(ISettingsList settingsList) Takes as arguments a list of ISettingsMap where each of them contains two fields:
static List<org.apache.http.HttpHost>	getHttpHosts(List<String> hosts)
static List<org.apache.http.HttpHost>	getHttpHosts(List<String> hosts, String scheme) Build a list of HttpHost from a string list of http hosts The http host list can be : - http://server1:9200 - http://server2:9201 If no scheme is provided with hosts like : - server1:9200 - server2:9201 The default 'http' scheme is applied on each host Providing a scheme in this method will only override hosts with no scheme yet.
static void	getTextFileResourceByLine(String resourceUrl, UtilHttp.Callback cb)
static List<URI>	getURIs(List<String> hosts)
static List<URI>	getURIs(List<String> hosts, String scheme) Build a list of URIs from a string list of http hosts The http host list can be : - http://server1:9200 - http://server2:9201 If no scheme is provided with hosts like : - server1:9200 - server2:9201 The default 'http' scheme is applied on each host Providing a scheme in this method will only override hosts with no scheme yet.

Methods inherited from class java.lang.Object

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

Constructor Detail

UtilHttp

public UtilHttp()

Method Detail

getBodyAsTextLines

public static String getBodyAsTextLines(String resourceUrl)
                                 throws org.apache.http.client.ClientProtocolException,
                                        IOException

Fetch a remote HTTP resource. Beware this one sends you back the complete body. Do not use for big files.

Parameters:

resourceUrl - resource url

Returns:

the body as a String

Throws:

IOException

org.apache.http.client.ClientProtocolException

getTextFileResourceByLine

public static void getTextFileResourceByLine(String resourceUrl,
                                             UtilHttp.Callback cb)
                                      throws org.apache.http.client.ClientProtocolException,
                                             IOException

Parameters:

resourceUrl - the target http resource url

cb -

Throws:

IOException

org.apache.http.client.ClientProtocolException

authenticate

public static org.apache.http.Header[] authenticate(String user,
                                                    String password,
                                                    String token,
                                                    String tokenType)

Add required headers for token authentication

Parameters:

user - user

password - password

token - token

tokenType - tokenType

Returns:

header list

getAuthenticationFromHeader

public static ISettingsMap getAuthenticationFromHeader(String header)

Parse an header to generate map containing all credentials information (token type, token, username, password)

Parameters:

header - Header to parse

Returns:

Map with credentials information

getHttpHosts

public static org.apache.http.HttpHost[] getHttpHosts(ISettingsList settingsList)

Takes as arguments a list of ISettingsMap where each of them contains two fields:

 - host
 - port
 

Host field is mandatory whereas port will default to 9200 if not set

Parameters:

settingsList -

Returns:

HttpHost list that can be used to initialize a client

getURIs

public static List<URI> getURIs(List<String> hosts,
                                String scheme)
                         throws URISyntaxException

Build a list of URIs from a string list of http hosts The http host list can be : - http://server1:9200 - http://server2:9201 If no scheme is provided with hosts like : - server1:9200 - server2:9201 The default 'http' scheme is applied on each host Providing a scheme in this method will only override hosts with no scheme yet. The hosts with a scheme are not overwritten.

Parameters:

hosts - String list of http hosts like

scheme - To apply on hosts without a scheme

Returns:

a list of uris

Throws:

URISyntaxException - if a host is malformed

getURIs

public static List<URI> getURIs(List<String> hosts)
                         throws URISyntaxException

Throws:

URISyntaxException

getHttpHosts

public static List<org.apache.http.HttpHost> getHttpHosts(List<String> hosts,
                                                          String scheme)
                                                   throws URISyntaxException

Build a list of HttpHost from a string list of http hosts The http host list can be : - http://server1:9200 - http://server2:9201 If no scheme is provided with hosts like : - server1:9200 - server2:9201 The default 'http' scheme is applied on each host Providing a scheme in this method will only override hosts with no scheme yet. The hosts with a scheme are not overwritten.

Parameters:

hosts - String list of http hosts like

scheme - To apply on hosts without a scheme

Returns:

a list of uris

Throws:

URISyntaxException - if a host is malformed

getHttpHosts

public static List<org.apache.http.HttpHost> getHttpHosts(List<String> hosts)
                                                   throws URISyntaxException

Throws:

URISyntaxException

applyScheme

public static List<org.apache.http.HttpHost> applyScheme(List<org.apache.http.HttpHost> hosts,
                                                         String scheme)

Apply a scheme on all hosts in list

Parameters:

hosts - hosts list

scheme - scheme to apply on all hosts. MUST be 'http' or 'https'

Returns:

the new list with the proper scheme

applyPrefix

public static String applyPrefix(String host,
                                 String prefix)

Apply a prefix for a host path Eg : http://host:port -> http://host:port/prefix manage '/' char concatenation

Parameters:

host - host String

prefix - path prefix to apply on host. Can be null

Returns:

the new host with prefix