com.yahoo.bard.webservice.config

Class ConfigResourceLoader

java.lang.Object

com.yahoo.bard.webservice.config.ConfigResourceLoader

public class ConfigResourceLoader
extends Object

Utilities to help load resources for the system configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	RESOURCE_LOADER_PREFIX

Constructor Summary

Constructors

Constructor and Description
ConfigResourceLoader()

Method Summary

Modifier and Type	Method and Description
boolean	isResourceNotAJar(org.springframework.core.io.Resource resource) A simple predicate that is true if a resource is not from a jar.
org.apache.commons.configuration.Configuration	loadConfigFromResource(org.springframework.core.io.Resource resource) Build a configuration object from a resource, processing it as a properties file.
List<org.apache.commons.configuration.Configuration>	loadConfigurations(String name) Use a string pattern to load configurations matching a resource name from the class path and parse into Configuration objects.
List<org.apache.commons.configuration.Configuration>	loadConfigurationsNoJars(String name) Use a string path to load configurations matching a resource name from the class path which are not from jars into Configuration objects.
Stream<org.springframework.core.io.Resource>	loadResourcesWithName(String name) Use a string to load a stream of all resources from the class path which match a given name.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_LOADER_PREFIX

protected static final String RESOURCE_LOADER_PREFIX

See Also:

Constant Field Values

Constructor Detail

ConfigResourceLoader

public ConfigResourceLoader()

Method Detail

loadConfigurations

public List<org.apache.commons.configuration.Configuration> loadConfigurations(String name)
                                                                        throws IOException

Use a string pattern to load configurations matching a resource name from the class path and parse into Configuration objects.

Parameters:

name - The class path address of a resource ('/foo' means a resource named foo in the default package)

Returns:

A list of configurations corresponding to the matching class path resource

Throws:

IOException - if any resources cannot be read from the class path successfully.

loadConfigurationsNoJars

public List<org.apache.commons.configuration.Configuration> loadConfigurationsNoJars(String name)
                                                                              throws IOException

Use a string path to load configurations matching a resource name from the class path which are not from jars into Configuration objects.

This differentiation generally provides for only the local src directories to supply the resource instances, preventing injection of unwanted resources from class path entries.

Parameters:

name - The class path address of a resource ('/foo' means a resource named foo in the default package)

Returns:

A list of configurations corresponding to the matching class path resource

Throws:

IOException - if any resources cannot be read from the class path successfully.

loadResourcesWithName

public Stream<org.springframework.core.io.Resource> loadResourcesWithName(String name)
                                                                   throws IOException

Use a string to load a stream of all resources from the class path which match a given name.

Parameters:

name - The class path address of a resource ('/foo' means a resource named foo in the default package)

Returns:

A stream of all class path resources corresponding to a particular name

Throws:

IOException - if any resources cannot be read from the class path successfully.

loadConfigFromResource

public org.apache.commons.configuration.Configuration loadConfigFromResource(org.springframework.core.io.Resource resource)

Build a configuration object from a resource, processing it as a properties file.

Parameters:

resource - The resource referring to a properties file

Returns:

a Configuration object containing a properties configuration

isResourceNotAJar

public boolean isResourceNotAJar(org.springframework.core.io.Resource resource)

A simple predicate that is true if a resource is not from a jar.

Parameters:

resource - the Resource under test

Returns:

true if the resource is not from a jar