Package org.owasp.esapi.configuration

Class EsapiPropertyManager

java.lang.Object

org.owasp.esapi.configuration.EsapiPropertyManager

All Implemented Interfaces:

EsapiPropertyLoader

public class EsapiPropertyManager
extends java.lang.Object
implements EsapiPropertyLoader

Manager used for loading security configuration properties. Does all the logic to obtain the correct property from correct source. Uses following system properties to find configuration files:

 - org.owasp.esapi.devteam - lower priority dev file path
 - org.owasp.esapi.opsteam - higher priority ops file path
 

Since:

2.2

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.TreeSet<AbstractPrioritizedPropertyLoader>	loaders

Constructor Summary

Constructors

Constructor	Description
EsapiPropertyManager()

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	getBooleanProp(java.lang.String propertyName)	Get any Boolean type property from security configuration.
byte[]	getByteArrayProp(java.lang.String propertyName)	Get any byte array type property from security configuration.
int	getIntProp(java.lang.String propertyName)	Get any int type property from security configuration.
java.lang.String	getStringProp(java.lang.String propertyName)	Get any property from security configuration.

Methods inherited from class java.lang.Object

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

Field Detail

loaders

protected java.util.TreeSet<AbstractPrioritizedPropertyLoader> loaders

Constructor Detail

EsapiPropertyManager

public EsapiPropertyManager()
                     throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getIntProp

public int getIntProp(java.lang.String propertyName)
               throws ConfigurationException

Get any int type property from security configuration.

Specified by:

getIntProp in interface EsapiPropertyLoader

Returns:

property value.

Throws:

ConfigurationException - when property does not exist in configuration or has incorrect type.

getByteArrayProp

public byte[] getByteArrayProp(java.lang.String propertyName)
                        throws ConfigurationException

Get any byte array type property from security configuration.

Specified by:

getByteArrayProp in interface EsapiPropertyLoader

Returns:

property value.

Throws:

ConfigurationException - when property does not exist in configuration or has incorrect type.

getBooleanProp

public java.lang.Boolean getBooleanProp(java.lang.String propertyName)
                                 throws ConfigurationException

Get any Boolean type property from security configuration.

Specified by:

getBooleanProp in interface EsapiPropertyLoader

Returns:

property value.

Throws:

ConfigurationException - when property does not exist in configuration or has incorrect type.

getStringProp

public java.lang.String getStringProp(java.lang.String propertyName)
                               throws ConfigurationException

Get any property from security configuration. As every property can be returned as string, this method throws exception only when property does not exist.

Specified by:

getStringProp in interface EsapiPropertyLoader

Returns:

property value.

Throws:

ConfigurationException - when property does not exist in configuration.