Package edu.cornell.mannlib.vitro.webapp.config

Class ConfigurationProperties

java.lang.Object

edu.cornell.mannlib.vitro.webapp.config.ConfigurationProperties

Direct Known Subclasses:

ConfigurationPropertiesImpl

public abstract class ConfigurationProperties
extends Object

Provides an mechanism for modules to read the configuration properties that are attached to the servlet context. The customary behavior is for ConfigurationPropertiesSetup to create a ConfigurationPropertiesImpl, which will obtain the properties from the build.properties file and the runtime.properties file.

Constructor Summary

Constructors

Constructor	Description
ConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
static ConfigurationProperties	getBean(javax.servlet.http.HttpServlet servlet)
static ConfigurationProperties	getBean(javax.servlet.http.HttpSession session)
static ConfigurationProperties	getBean(javax.servlet.ServletConfig servletConfig)
static ConfigurationProperties	getBean(javax.servlet.ServletContext context)
static ConfigurationProperties	getBean(javax.servlet.ServletContextEvent sce)
static ConfigurationProperties	getBean(javax.servlet.ServletRequest request)
abstract String	getProperty(String key)	Get the value of the property, or null if the property has not been assigned a value.
abstract String	getProperty(String key, String defaultValue)	Get the value of the property, or use the default value if the property has not been assigned a value.
abstract Map<String,String>	getPropertyMap()	Get a copy of the map of the configuration properties and their settings.
protected static void	setBean(javax.servlet.ServletContext context, ConfigurationProperties bean)	Protected access, so the Stub class can call it for unit tests.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationProperties

public ConfigurationProperties()

Method Detail

getBean

public static ConfigurationProperties getBean(javax.servlet.ServletRequest request)

getBean

public static ConfigurationProperties getBean(javax.servlet.http.HttpSession session)

getBean

public static ConfigurationProperties getBean(javax.servlet.http.HttpServlet servlet)

getBean

public static ConfigurationProperties getBean(javax.servlet.ServletContextEvent sce)

getBean

public static ConfigurationProperties getBean(javax.servlet.ServletConfig servletConfig)

getBean

public static ConfigurationProperties getBean(javax.servlet.ServletContext context)

setBean

protected static void setBean(javax.servlet.ServletContext context,
                              ConfigurationProperties bean)

Protected access, so the Stub class can call it for unit tests. Otherwise, this should only be called by ConfigurationPropertiesSetup.

getProperty

public abstract String getProperty(String key)

Get the value of the property, or null if the property has not been assigned a value.

getProperty

public abstract String getProperty(String key,
                                   String defaultValue)

Get the value of the property, or use the default value if the property has not been assigned a value.

getPropertyMap

public abstract Map<String,String> getPropertyMap()

Get a copy of the map of the configuration properties and their settings. Because this is a copy, it cannot be used to modify the settings.