org.apache.brooklyn.util.core

Class ResourceUtils

java.lang.Object

org.apache.brooklyn.util.core.ResourceUtils

public class ResourceUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ResourceUtils(BrooklynClassLoadingContext loader, java.lang.Object contextObject, java.lang.String contextMessage)
ResourceUtils(java.lang.ClassLoader loader, java.lang.Object contextObject, java.lang.String contextMessage)
ResourceUtils(java.lang.Object contextObject)
ResourceUtils(java.lang.Object contextObject, java.lang.String contextMessage)

Method Summary

Modifier and Type	Method and Description
static void	addClassLoaderProvider(<any> provider) used to register custom mechanisms for getting classloaders given an object
java.lang.String	checkUrlExists(java.lang.String url)
java.lang.String	checkUrlExists(java.lang.String url, java.lang.String message) Throws if the given URL cannot be read.
static ResourceUtils	create() Creates a ResourceUtils object with itself as the context.
static ResourceUtils	create(BrooklynClassLoadingContext loader, java.lang.Object contextObject, java.lang.String contextMessage) Creates a ResourceUtils object with a specific class loader and context.
static ResourceUtils	create(java.lang.ClassLoader loader, java.lang.Object contextObject, java.lang.String contextMessage) Creates a ResourceUtils object with a specific class loader and context.
static ResourceUtils	create(java.lang.Object contextObject) Creates a ResourceUtils object with the given context.
static ResourceUtils	create(java.lang.Object contextObject, java.lang.String contextMessage) Creates a ResourceUtils object with the given context.
boolean	doesUrlExist(java.lang.String url)
<any>	firstAvailableUrl(java.lang.String... urls) returns the first available URL
java.lang.String	getClassLoaderDir() returns the base directory or JAR from which the context is class-loaded, if possible; throws exception if not found
java.lang.String	getClassLoaderDir(java.lang.String resourceInThatDir)
static java.net.URL	getContainerUrl(java.net.URL url, java.lang.String resourceInThatDir)
java.lang.String	getResourceAsString(java.lang.String url) takes getResourceFromUrl(String) and reads fully, into a string
java.io.InputStream	getResourceFromUrl(java.lang.String url) Takes a string which is treated as a URL (with some extended "schemes" also expected), or as a path to something either on the classpath (absolute only) or the local filesystem (relative or absolute, depending on leading slash)
java.io.InputStream	getResourceFromUrl(java.lang.String url, Credentials credentials)
java.lang.Iterable<java.net.URL>	getResources(java.lang.String name)
static java.net.URL	tidy(java.net.URL url)
static java.lang.String	tidyFileUrl(java.lang.String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceUtils

public ResourceUtils(java.lang.ClassLoader loader,
                     java.lang.Object contextObject,
                     java.lang.String contextMessage)

ResourceUtils

public ResourceUtils(BrooklynClassLoadingContext loader,
                     java.lang.Object contextObject,
                     java.lang.String contextMessage)

ResourceUtils

public ResourceUtils(java.lang.Object contextObject,
                     java.lang.String contextMessage)

ResourceUtils

public ResourceUtils(java.lang.Object contextObject)

Method Detail

create

public static final ResourceUtils create(java.lang.ClassLoader loader,
                                         java.lang.Object contextObject,
                                         java.lang.String contextMessage)

Creates a ResourceUtils object with a specific class loader and context.

Use the provided ClassLoader object for class loading with the contextObject for context and the contextMessage string for error messages.

See Also:

create(Object, String), create(Object)

create

public static final ResourceUtils create(BrooklynClassLoadingContext loader,
                                         java.lang.Object contextObject,
                                         java.lang.String contextMessage)

Creates a ResourceUtils object with a specific class loader and context.

Use the provided BrooklynClassLoadingContext object for class loading with the contextObject for context and the contextMessage string for error messages.

See Also:

create(Object, String), create(Object)

create

public static final ResourceUtils create(java.lang.Object contextObject,
                                         java.lang.String contextMessage)

Creates a ResourceUtils object with the given context.

Uses the ClassLoader of the given contextObject for class loading and the contextMessage string for error messages.

See Also:

create(ClassLoader, Object, String), create(Object)

create

public static final ResourceUtils create(java.lang.Object contextObject)

Creates a ResourceUtils object with the given context.

Uses the ClassLoader of the given contextObject for class loading and its Object.toString() (preceded by the word 'for') as the string used in error messages.

See Also:

create(ClassLoader, Object, String), create(Object)

create

public static final ResourceUtils create()

Creates a ResourceUtils object with itself as the context.

See Also:

create(Object)

addClassLoaderProvider

public static void addClassLoaderProvider(<any> provider)

used to register custom mechanisms for getting classloaders given an object

getResources

public java.lang.Iterable<java.net.URL> getResources(java.lang.String name)

Returns:

all resources in Brooklyn's BrooklynClassLoadingContext with the given name.

getResourceFromUrl

public java.io.InputStream getResourceFromUrl(java.lang.String url,
                                              @Nullable
                                              Credentials credentials)

getResourceFromUrl

public java.io.InputStream getResourceFromUrl(java.lang.String url)

Takes a string which is treated as a URL (with some extended "schemes" also expected), or as a path to something either on the classpath (absolute only) or the local filesystem (relative or absolute, depending on leading slash)

URLs can be of the form classpath://com/acme/Foo.properties as well as file:///home/... and http://acme.com/....

Throws exception if not found, using the context parameter passed into the constructor.

TODO may want OSGi, or typed object; should consider pax url

Returns:

a stream, or throws exception (never returns null)

tidy

public static java.net.URL tidy(java.net.URL url)

tidyFileUrl

public static java.lang.String tidyFileUrl(java.lang.String url)

getResourceAsString

public java.lang.String getResourceAsString(java.lang.String url)

takes getResourceFromUrl(String) and reads fully, into a string

checkUrlExists

public java.lang.String checkUrlExists(java.lang.String url)

See Also:

checkUrlExists(String, String)

checkUrlExists

public java.lang.String checkUrlExists(java.lang.String url,
                                       java.lang.String message)

Throws if the given URL cannot be read.

Parameters:

url - The URL to test

message - An optional message to use for the exception thrown.

Returns:

The URL argument

See Also:

getResourceFromUrl(String)

doesUrlExist

public boolean doesUrlExist(java.lang.String url)

Returns:

True if the given URL can be read, false otherwise.

See Also:

getResourceFromUrl(String)

firstAvailableUrl

public <any> firstAvailableUrl(java.lang.String... urls)

returns the first available URL

getClassLoaderDir

public java.lang.String getClassLoaderDir()

returns the base directory or JAR from which the context is class-loaded, if possible; throws exception if not found

getClassLoaderDir

public java.lang.String getClassLoaderDir(java.lang.String resourceInThatDir)

getContainerUrl

public static java.net.URL getContainerUrl(java.net.URL url,
                                           java.lang.String resourceInThatDir)