org.deventropy.shared.utils

Class UrlResourceUtil

java.lang.Object

org.deventropy.shared.utils.UrlResourceUtil

public final class UrlResourceUtil
extends Object

A utility class to provide uniform resource loading capability from real and pseudo URLs, like classpath.

This utility can be used to allow consumers the same interface to load resources from classpaths, file system, HTTP, etc. This class is inspired by the Spring Framework DefaultResourceLoader.

Supported formats or URLs by this util:

• Classpath Example: classpath:/org/deventropy/junithelper/utils/file.ext
• File Example: file:/path/to/file/file.ext
• HTTP Example: http://example.com/file.ext
• HTTPS Example: https://example.com/file.ext

Author:

Bindul Bhowmik

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	KNOWN_PROTOCOLS known protocols.
static String	URL_PROTOCOL_CLASSPATH Classpath URL prefix.
static String	URL_PROTOCOL_FILE File url prefix.
static String	URL_PROTOCOL_HTTP HTTP url prefix.
static String	URL_PROTOCOL_HTTPS HTTPS url prefix.

Method Summary

Modifier and Type	Method and Description
static File	getFileForWrite(String resource)
static URL	getUrl(String resource)
static URL	getUrl(String resource, ClassLoader cl)
static boolean	isFile(String resource)

Methods inherited from class java.lang.Object

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

Field Detail

URL_PROTOCOL_CLASSPATH

public static final String URL_PROTOCOL_CLASSPATH

Classpath URL prefix.

See Also:

Constant Field Values

URL_PROTOCOL_FILE

public static final String URL_PROTOCOL_FILE

File url prefix.

See Also:

Constant Field Values

URL_PROTOCOL_HTTP

public static final String URL_PROTOCOL_HTTP

HTTP url prefix.

See Also:

Constant Field Values

URL_PROTOCOL_HTTPS

public static final String URL_PROTOCOL_HTTPS

HTTPS url prefix.

See Also:

Constant Field Values

KNOWN_PROTOCOLS

public static final Set<String> KNOWN_PROTOCOLS

known protocols.

Method Detail

getUrl

public static URL getUrl(String resource,
                         ClassLoader cl)
                  throws MalformedURLException,
                         IOException

Parameters:

resource - Resource to checkl

cl - Classpath to use

Returns:

A URL format

Throws:

MalformedURLException - Malformed URL

IOException - Resource not found

getUrl

public static URL getUrl(String resource)
                  throws IOException

Parameters:

resource - Resource to check

Returns:

URL format

Throws:

IOException - Exception getting the URL

isFile

public static boolean isFile(String resource)

Parameters:

resource - If the resource is a file

Returns:

true if file on mounted drive

getFileForWrite

public static File getFileForWrite(String resource)
                            throws IOException

Parameters:

resource - OPen resource as a file to write

Returns:

File if the resource is a file and can write

Throws:

IOException - Exception trying to open a file