Package org.ametys.core.util

Class HttpUtils

java.lang.Object

org.ametys.core.util.HttpUtils

All Implemented Interfaces:

Disposable, Initializable, Component

public class HttpUtils
extends Object
implements Component, Initializable, Disposable

Utility class for HTTP urls.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HttpUtils.HttpCheck	The status of HTTP check
static final record	HttpUtils.HttpCheckReport	Represent the result of a check and a potential message

Field Summary

Fields

Modifier and Type	Field	Description
static final int	HTTP_REDIRECT_PERM	HTTP Status-Code 308: Temporay Redirect
static final int	HTTP_REDIRECT_TEMP	HTTP Status-Code 307: Temporay Redirect
static final Pattern	HTTP_URL_VALIDATOR	Regexp for HTTP url
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
HttpUtils()

Method Summary

Modifier and Type	Method	Description
static org.apache.hc.core5.http.ClassicHttpRequest	buildRequest(URI uri, String userAgent, String method, int timeout, int readTimeOut, boolean followRedirects, int maxRedirects, Map<String,String> requestHeaders)	build a request to the remote URI
Map<String,Object>	checkHttpUrl(String httpUrl)	Method to check a HTTP url from client side.
static HttpUtils.HttpCheckReport	checkHttpUrl(String httpUrl, String userAgent, String method, int timeout, int readTimeOut, boolean followRedirects)	Check the HTTP url
static HttpUtils.HttpCheckReport	checkHttpUrl(String httpUrl, String userAgent, String method, int timeout, int readTimeOut, boolean followRedirects, Map<String,String> requestHeaders)	Check the HTTP url
static HttpUtils.HttpCheckReport	checkHttpUrl(URL url, String userAgent, String method, int timeout, int readTimeOut, boolean followRedirects, Map<String,String> requestHeaders)	Check the HTTP url
static org.apache.hc.client5.http.impl.classic.CloseableHttpClient	createHttpClient(int maxConnections, int timeout)	Create ands return a configured, ready to use, HttpClient. This method is well suited to create a client dedicated to a single route.
static org.apache.hc.client5.http.impl.classic.CloseableHttpClient	createHttpClient(int maxConnections, int timeout, boolean blockInternal)	Create ands return a configured, ready to use, HttpClient. This method is well suited to create a client dedicated to a single route.
void	dispose()
static <T> T	executeRequest(String httpUrl, String userAgent, String method, int timeout, int readTimeOut, boolean followRedirects, Map<String,String> requestHeaders, boolean ignoreRestriction, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler)	Prepare the connection to the remote URL
static <T> T	executeRequest(String httpUrl, String userAgent, String method, int timeout, int readTimeOut, boolean followRedirects, Map<String,String> requestHeaders, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler)	Prepare the connection to the remote URL
void	initialize()
static String	sanitize(String uri)	Strips the end of an uri to remove "*.html" ends and "/" ending characters

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The Avalon role

HTTP_URL_VALIDATOR

public static final Pattern HTTP_URL_VALIDATOR

Regexp for HTTP url

HTTP_REDIRECT_TEMP

public static final int HTTP_REDIRECT_TEMP

HTTP Status-Code 307: Temporay Redirect

See Also:

• Constant Field Values

HTTP_REDIRECT_PERM

public static final int HTTP_REDIRECT_PERM

HTTP Status-Code 308: Temporay Redirect

See Also:

• Constant Field Values

Constructor Details

HttpUtils

public HttpUtils()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

dispose

public void dispose()

Specified by:

dispose in interface Disposable

executeRequest

public static <T> T executeRequest(String httpUrl,
 String userAgent,
 String method,
 int timeout,
 int readTimeOut,
 boolean followRedirects,
 Map<String,String> requestHeaders,
 org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler)
                            throws IOException

Prepare the connection to the remote URL

Type Parameters:

T - The type of the value returned by the execution

Parameters:

httpUrl - The HTTP URL

userAgent - The user agent. Can be null.

method - The method for the URL request. Can be null.

timeout - The connection timeout in milliseconds. Set to -1 to not set a timeout.

readTimeOut - The read timeout in milliseconds. Set to -1 to not set a timeout.

followRedirects - Sets to true to follow HTTP redirects

requestHeaders - The request headers.

responseHandler - The handler that transform the HTTP response into the execution response

Returns:

The result obtained by the response handler

Throws:

IOException - if an I/O exception occurs or the URL is invalid

executeRequest

public static <T> T executeRequest(String httpUrl,
 String userAgent,
 String method,
 int timeout,
 int readTimeOut,
 boolean followRedirects,
 Map<String,String> requestHeaders,
 boolean ignoreRestriction,
 org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler)
                            throws IOException

Prepare the connection to the remote URL

Type Parameters:

T - The type of the value returned by the execution

Parameters:

httpUrl - The HTTP URL

userAgent - The user agent. Can be null.

method - The method for the URL request. Can be null.

timeout - The connection timeout in milliseconds. Set to -1 to not set a timeout.

readTimeOut - The read timeout in milliseconds. Set to -1 to not set a timeout.

followRedirects - Sets to true to follow HTTP redirects

requestHeaders - The request headers.

ignoreRestriction - true to bypass security restriction on HTTP client

responseHandler - The handler that transform the HTTP response into the execution response

Returns:

The result obtained by the response handler

Throws:

IOException - if an I/O exception occurs or the URL is invalid

buildRequest

public static org.apache.hc.core5.http.ClassicHttpRequest buildRequest(URI uri,
 String userAgent,
 String method,
 int timeout,
 int readTimeOut,
 boolean followRedirects,
 int maxRedirects,
 Map<String,String> requestHeaders)
                                                                throws IOException

build a request to the remote URI

Parameters:

uri - The URI to request

userAgent - The user agent. Can be null.

method - The method for the URL request. Can be null.

timeout - The connection timeout in milliseconds. Set to -1 to not set a timeout.

readTimeOut - The read timeout in milliseconds. Set to -1 to not set a timeout.

followRedirects - Sets to true to follow HTTP redirects

maxRedirects - The maximum number of redirects to follow

requestHeaders - The request headers.

Returns:

The HTTP request

Throws:

IOException - if an I/O exception occurs

checkHttpUrl

public static HttpUtils.HttpCheckReport checkHttpUrl(String httpUrl,
 String userAgent,
 String method,
 int timeout,
 int readTimeOut,
 boolean followRedirects)

Check the HTTP url

Parameters:

httpUrl - The HTTP url to test

userAgent - The user agent. Can be null.

method - The method for teh URL request. Can be null.

timeout - The connection timeout in milliseconds. Set to -1 to not set a timeout.

readTimeOut - The read timeout in milliseconds. Set to -1 to not set a timeout.

followRedirects - Sets to true to follow HTTP redirects

Returns:

The URL connection

checkHttpUrl

public static HttpUtils.HttpCheckReport checkHttpUrl(String httpUrl,
 String userAgent,
 String method,
 int timeout,
 int readTimeOut,
 boolean followRedirects,
 Map<String,String> requestHeaders)

Check the HTTP url

Parameters:

httpUrl - The url to test

userAgent - The user agent. Can be null.

method - The method for teh URL request. Can be null.

timeout - The connection timeout in milliseconds. Set to -1 to not set a timeout.

readTimeOut - The read timeout in milliseconds. Set to -1 to not set a timeout.

followRedirects - Sets to true to follow HTTP redirects

requestHeaders - The request headers.

Returns:

The URL connection

checkHttpUrl

public static HttpUtils.HttpCheckReport checkHttpUrl(URL url,
 String userAgent,
 String method,
 int timeout,
 int readTimeOut,
 boolean followRedirects,
 Map<String,String> requestHeaders)

Check the HTTP url

Parameters:

url - The url to test

userAgent - The user agent. Can be null.

method - The method for teh URL request. Can be null.

timeout - The connection timeout in milliseconds. Set to -1 to not set a timeout.

readTimeOut - The read timeout in milliseconds. Set to -1 to not set a timeout.

followRedirects - Sets to true to follow HTTP redirects

requestHeaders - The request headers.

Returns:

The URL connection

checkHttpUrl

public Map<String,Object> checkHttpUrl(String httpUrl)

Method to check a HTTP url from client side. The HTTP redirects will be followed.

Parameters:

httpUrl - the http url to check

Returns:

the result of the check

createHttpClient

public static org.apache.hc.client5.http.impl.classic.CloseableHttpClient createHttpClient(int maxConnections,
 int timeout)

Create ands return a configured, ready to use, HttpClient.
This method is well suited to create a client dedicated to a single route.

Parameters:

maxConnections - the maximum simultaneous connections. If zero or negative, defaults to HttpClient's default values.

timeout - the socket and connect timeout, in seconds. If zero or negative, defaults to HttpClient's default values.

Returns:

a configured HttpClient

createHttpClient

public static org.apache.hc.client5.http.impl.classic.CloseableHttpClient createHttpClient(int maxConnections,
 int timeout,
 boolean blockInternal)

Create ands return a configured, ready to use, HttpClient.
This method is well suited to create a client dedicated to a single route.

Parameters:

maxConnections - the maximum simultaneous connections. If zero or negative, defaults to HttpClient's default values.

timeout - the socket and connect timeout, in seconds. If zero or negative, defaults to HttpClient's default values.

blockInternal - true to prevent request to restricted IP address (as defined in configuration)

Returns:

a configured HttpClient

sanitize

public static String sanitize(String uri)

Strips the end of an uri to remove "*.html" ends and "/" ending characters

Parameters:

uri - The uri to edit

Returns:

The edited uri