org.codehaus.mojo.license.utils

Class UrlRequester

java.lang.Object

org.codehaus.mojo.license.utils.UrlRequester

public class UrlRequester
extends Object

This class should be used to load the content from a URL.

Supported URL protocols are those standards plus classpath protocol.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSPATH_PROTOCOL

Constructor Summary

Constructors

Constructor and Description
UrlRequester()

Method Summary

Modifier and Type	Method and Description
static List<String>	downloadList(String url) will download a external resource and read the content of the file that will then be translated into a new list.
static String	getFromUrl(String url) Returns the content of the resource pointed by the given URL as a string.
static String	getFromUrl(String url, String encoding) Returns the content of the resource pointed by the given URL as a string.
static boolean	isStringUrl(String data) Checks if the given input is a URL value.

Methods inherited from class java.lang.Object

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

Field Detail

CLASSPATH_PROTOCOL

public static final String CLASSPATH_PROTOCOL

See Also:

Constant Field Values

Constructor Detail

UrlRequester

public UrlRequester()

Method Detail

isStringUrl

public static boolean isStringUrl(String data)

Checks if the given input is a URL value.

Parameters:

data - the license string or a URL

Returns:

true if URL, false else

getFromUrl

public static String getFromUrl(String url)
                         throws IOException

Returns the content of the resource pointed by the given URL as a string.

Parameters:

url - the resource destination that is expected to contain pure text

Returns:

the string representation of the resource at the given URL

Throws:

IOException - If an I/O error occurs when retrieve of the content URL

getFromUrl

public static String getFromUrl(String url,
                                String encoding)
                         throws IOException

Returns the content of the resource pointed by the given URL as a string.

Parameters:

url - the resource destination that is expected to contain pure text

encoding - the resource content encoding

Returns:

the string representation of the resource at the given URL

Throws:

IOException - If an I/O error occurs when retrieve of the content URL

downloadList

public static List<String> downloadList(String url)
                                 throws org.apache.maven.plugin.MojoExecutionException

will download a external resource and read the content of the file that will then be translated into a new list.
Lines starting with the character '#' will be omitted from the list

NOTE:
certificate checking for this request will be disabled because some resources might be present on some local servers in the internal network that do not use a safe connection

Parameters:

url - the URL to the external resource

Returns:

a new list with all license entries from the remote resource

Throws:

org.apache.maven.plugin.MojoExecutionException