org.dstadler.commons.net

Class UrlUtils

java.lang.Object

org.dstadler.commons.net.UrlUtils

public class UrlUtils
extends java.lang.Object

Collection of simple utility-methods for accessing network resources. For more sophisticated access use HttpClientWrapper.

Constructor Summary

Constructors

Constructor and Description
UrlUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAccessError(java.lang.String destinationUrl, boolean fireRequest, boolean ignoreHTTPSHostCheck, int timeout)
static java.lang.String	getAccessError(java.lang.String destinationUrl, boolean fireRequest, boolean ignoreHTTPSHostCheck, int timeout, javax.net.ssl.SSLSocketFactory sslFactory)
static boolean	isAvailable(java.lang.String destinationUrl, boolean fireRequest, boolean ignoreHTTPSHostCheck, int timeout) Check if the HTTP resource specified by the destination URL is available.
static boolean	isAvailable(java.lang.String destinationUrl, boolean fireRequest, boolean ignoreHTTPSHostCheck, int timeout, javax.net.ssl.SSLSocketFactory sslFactory) Check if the HTTP resource specified by the destination URL is available.
static boolean	isAvailable(java.lang.String destinationUrl, boolean fireRequest, int timeout) Check if the HTTP resource specified by the destination URL is available.
static java.lang.String	retrieveData(java.lang.String sUrl, int timeout) Download data from an URL.
static java.lang.String	retrieveData(java.lang.String sUrl, java.lang.String encoding, int timeout) Download data from an URL, if necessary converting from a character encoding.
static java.lang.String	retrieveData(java.lang.String sUrl, java.lang.String encoding, int timeout, javax.net.ssl.SSLSocketFactory sslFactory) Download data from an URL, if necessary converting from a character encoding.
static java.lang.String	retrieveDataPost(java.lang.String sUrl, java.lang.String encoding, java.lang.String postRequestBody, java.lang.String contentType, int timeout) Download data from an URL with a POST request, if necessary converting from a character encoding.
static java.lang.String	retrieveDataPost(java.lang.String sUrl, java.lang.String encoding, java.lang.String postRequestBody, java.lang.String contentType, int timeout, javax.net.ssl.SSLSocketFactory sslFactory) Download data from an URL with a POST request, if necessary converting from a character encoding.
static byte[]	retrieveRawData(java.lang.String sUrl, int timeout) Download data from an URL and return the raw bytes.
static byte[]	retrieveRawData(java.lang.String sUrl, int timeout, javax.net.ssl.SSLSocketFactory sslFactory) Download data from an URL and return the raw bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlUtils

public UrlUtils()

Method Detail

retrieveData

public static java.lang.String retrieveData(java.lang.String sUrl,
                                            int timeout)
                                     throws java.io.IOException

Download data from an URL.

Parameters:

sUrl - The full URL used to download the content.

Returns:

The resulting data, e.g. a HTML string.

Throws:

java.io.IOException - If accessing the resource fails.

retrieveData

public static java.lang.String retrieveData(java.lang.String sUrl,
                                            java.lang.String encoding,
                                            int timeout)
                                     throws java.io.IOException

Download data from an URL, if necessary converting from a character encoding.

Parameters:

sUrl - The full URL used to download the content.

encoding - An encoding, e.g. UTF-8, ISO-8859-15. Can be null.

timeout - The timeout in milliseconds that is used for both connection timeout and read timeout.

Returns:

The resulting data, e.g. a HTML string.

Throws:

java.io.IOException - If accessing the resource fails.

retrieveData

public static java.lang.String retrieveData(java.lang.String sUrl,
                                            java.lang.String encoding,
                                            int timeout,
                                            javax.net.ssl.SSLSocketFactory sslFactory)
                                     throws java.io.IOException

Download data from an URL, if necessary converting from a character encoding.

Parameters:

sUrl - The full URL used to download the content.

encoding - An encoding, e.g. UTF-8, ISO-8859-15. Can be null.

timeout - The timeout in milliseconds that is used for both connection timeout and read timeout.

sslFactory - The SSLFactory to use for the connection, this allows to support custom SSL certificates

Returns:

The resulting data, e.g. a HTML string.

Throws:

java.io.IOException - If accessing the resource fails.

retrieveRawData

public static byte[] retrieveRawData(java.lang.String sUrl,
                                     int timeout)
                              throws java.io.IOException

Download data from an URL and return the raw bytes.

Parameters:

sUrl - The full URL used to download the content.

timeout - The timeout in milliseconds that is used for both connection timeout and read timeout.

Returns:

The resulting data, e.g. a HTML string as byte array.

Throws:

java.io.IOException - If accessing the resource fails.

retrieveRawData

public static byte[] retrieveRawData(java.lang.String sUrl,
                                     int timeout,
                                     javax.net.ssl.SSLSocketFactory sslFactory)
                              throws java.io.IOException

Download data from an URL and return the raw bytes.

Parameters:

sUrl - The full URL used to download the content.

timeout - The timeout in milliseconds that is used for both connection timeout and read timeout.

sslFactory - The SSLFactory to use for the connection, this allows to support custom SSL certificates

Returns:

The resulting data, e.g. a HTML string as byte array.

Throws:

java.io.IOException - If accessing the resource fails.

retrieveDataPost

public static java.lang.String retrieveDataPost(java.lang.String sUrl,
                                                java.lang.String encoding,
                                                java.lang.String postRequestBody,
                                                java.lang.String contentType,
                                                int timeout)
                                         throws java.io.IOException

Download data from an URL with a POST request, if necessary converting from a character encoding.

Parameters:

sUrl - The full URL used to download the content.

encoding - An encoding, e.g. UTF-8, ISO-8859-15. Can be null.

postRequestBody - the body of the POST request, e.g. request parameters; must not be null

contentType - the content-type of the POST request; may be null

timeout - The timeout in milliseconds that is used for both connection timeout and read timeout.

Returns:

The response from the HTTP POST call.

Throws:

java.io.IOException - If accessing the resource fails.

retrieveDataPost

public static java.lang.String retrieveDataPost(java.lang.String sUrl,
                                                java.lang.String encoding,
                                                java.lang.String postRequestBody,
                                                java.lang.String contentType,
                                                int timeout,
                                                javax.net.ssl.SSLSocketFactory sslFactory)
                                         throws java.io.IOException

Download data from an URL with a POST request, if necessary converting from a character encoding.

Parameters:

sUrl - The full URL used to download the content.

encoding - An encoding, e.g. UTF-8, ISO-8859-15. Can be null.

postRequestBody - the body of the POST request, e.g. request parameters; must not be null

contentType - the content-type of the POST request; may be null

timeout - The timeout in milliseconds that is used for both connection timeout and read timeout.

sslFactory - The SSLFactory to use for the connection, this allows to support custom SSL certificates

Returns:

The response from the HTTP POST call.

Throws:

java.io.IOException - If accessing the resource fails.

isAvailable

public static boolean isAvailable(java.lang.String destinationUrl,
                                  boolean fireRequest,
                                  int timeout)
                           throws java.lang.IllegalArgumentException

Check if the HTTP resource specified by the destination URL is available.

Parameters:

destinationUrl - the destination URL to check for availability

fireRequest - if true a request will be sent to the given URL in addition to opening the connection

timeout - Timeout in milliseconds after which the call fails because of timeout.

Returns:

true if a connection could be set up and the response was received

Throws:

java.lang.IllegalArgumentException - if the destination URL is invalid

isAvailable

public static boolean isAvailable(java.lang.String destinationUrl,
                                  boolean fireRequest,
                                  boolean ignoreHTTPSHostCheck,
                                  int timeout)
                           throws java.lang.IllegalArgumentException

Check if the HTTP resource specified by the destination URL is available.

Parameters:

destinationUrl - the destination URL to check for availability

fireRequest - if true a request will be sent to the given URL in addition to opening the connection

timeout - Timeout in milliseconds after which the call fails because of timeout.

Returns:

true if a connection could be set up and the response was received

Throws:

java.lang.IllegalArgumentException - if the destination URL is invalid

isAvailable

public static boolean isAvailable(java.lang.String destinationUrl,
                                  boolean fireRequest,
                                  boolean ignoreHTTPSHostCheck,
                                  int timeout,
                                  javax.net.ssl.SSLSocketFactory sslFactory)
                           throws java.lang.IllegalArgumentException

Check if the HTTP resource specified by the destination URL is available.

Parameters:

destinationUrl - the destination URL to check for availability

fireRequest - if true a request will be sent to the given URL in addition to opening the connection

timeout - Timeout in milliseconds after which the call fails because of timeout.

sslFactory - The SSLFactory to use for the connection, this allows to support custom SSL certificates

Returns:

true if a connection could be set up and the response was received

Throws:

java.lang.IllegalArgumentException - if the destination URL is invalid

getAccessError

public static java.lang.String getAccessError(java.lang.String destinationUrl,
                                              boolean fireRequest,
                                              boolean ignoreHTTPSHostCheck,
                                              int timeout)
                                       throws java.lang.IllegalArgumentException

Parameters:

destinationUrl - the destination URL to check for availability

fireRequest - if true a request will be sent to the given URL in addition to opening the connection

ignoreHTTPSHostCheck - if specified true, a HostnameVerifier is registered which accepts all hostnames during SSL handshake

timeout - Timeout in milliseconds after which the call fails because of timeout.

Returns:

null if connection works, an error message if some problem happens.

Throws:

java.lang.IllegalArgumentException - if the destination URL is invalid

getAccessError

public static java.lang.String getAccessError(java.lang.String destinationUrl,
                                              boolean fireRequest,
                                              boolean ignoreHTTPSHostCheck,
                                              int timeout,
                                              javax.net.ssl.SSLSocketFactory sslFactory)
                                       throws java.lang.IllegalArgumentException

Parameters:

destinationUrl - the destination URL to check for availability

fireRequest - if true a request will be sent to the given URL in addition to opening the connection

ignoreHTTPSHostCheck - if specified true, a HostnameVerifier is registered which accepts all hostnames during SSL handshake

timeout - Timeout in milliseconds after which the call fails because of timeout.

sslFactory - The SSLFactory to use for the connection, this allows to support custom SSL certificates

Returns:

null if connection works, an error message if some problem happens.

Throws:

java.lang.IllegalArgumentException - if the destination URL is invalid