DynaBeanACRParameter (ESAPI 2.2.0.0 API)

java.lang.Object
- org.owasp.esapi.reference.accesscontrol.DynaBeanACRParameter

All Implemented Interfaces:

PolicyParameters
```
public class DynaBeanACRParameter
extends Object
implements PolicyParameters
```
A DynaBean comes from the apache bean utils. It is basically a convenient way to dynamically assign getters and setters. Essentially, the way we use DynaBean is a HashMap that can be set to read only.

Author:

Mike H. Fauzy

Field Summary

Fields
Modifier and Type Field and Description

protected org.apache.commons.beanutils.LazyDynaMap policyProperties

Fields
Modifier and Type	Field and Description
`protected org.apache.commons.beanutils.LazyDynaMap`	`policyProperties`

Constructor Summary

Constructors
Constructor and Description

DynaBeanACRParameter()

Constructors
Constructor and Description
`DynaBeanACRParameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`get(String key)` Follows the contract for java.util.Map;
`BigDecimal`	`getBigDecimal(String key)` Convenience method to avoid common casts.
`BigInteger`	`getBigInteger(String key)` Convenience method to avoid common casts.
`boolean`	`getBoolean(String key)` Convenience method to avoid common casts.
`byte`	`getByte(String key)` Convenience method to avoid common casts.
`char`	`getChar(String key)` Convenience method to avoid common casts.
`Date`	`getDate(String key)` Convenience method to avoid common casts.
`double`	`getDouble(String key)` Convenience method to avoid common casts.
`float`	`getFloat(String key)` Convenience method to avoid common casts.
`int`	`getInt(String key)` Convenience method to avoid common casts.
`long`	`getLong(String key)` Convenience method to avoid common casts.
`Object`	`getObject(String key)` Convenience method to avoid common casts.
`String`	`getString(String key)` Convenience method to avoid common casts.
`String`	`getString(String key, String defaultValue)` Convenience method to avoid common casts.
`String[]`	`getStringArray(String key)` Convenience method to avoid common casts.
`Date`	`getTime(String key)` Convenience method to avoid common casts.
`void`	`lock()` This makes the map itself read only, but the mutability of objects that this map contains is not affected.
`void`	`put(String key, Object value)` This is a convenience method for developers that prefer to think of this as a map instead of being bean-like.
`void`	`set(String key, Object value)` This works just like a Map, except it will throw an exception if lock() has been called.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - policyProperties
```
protected org.apache.commons.beanutils.LazyDynaMap policyProperties
```
- Constructor Detail
  - DynaBeanACRParameter
```
public DynaBeanACRParameter()
```
- Method Detail
  - get
```
public Object get(String key)
```
    Description copied from interface: PolicyParameters
    
    Follows the contract for java.util.Map;
    
    Specified by:
    
    get in interface PolicyParameters
    
    Returns:
    
    The Object referred to by this key, if it exists.
    
    See Also:
    
    Map
  - getBoolean
```
public boolean getBoolean(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The true/false value of the specified key. False if not found.
  - getByte
```
public byte getByte(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The byte value of the specified key.
  - getChar
```
public char getChar(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The char value of the specified key.
  - getInt
```
public int getInt(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The int value of the specified key.
  - getLong
```
public long getLong(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The long value of the specified key.
  - getFloat
```
public float getFloat(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The float value of the specified key.
  - getDouble
```
public double getDouble(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The double value of the specified key.
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The BigDecimal value of the specified key.
  - getBigInteger
```
public BigInteger getBigInteger(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The BigInteger value of the specified key.
  - getDate
```
public Date getDate(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The Date value of the specified key.
  - getTime
```
public Date getTime(String key)
```
    Convenience method to avoid common casts. Note that the time object is the same as a date object
    
    Parameters:
    
    key -
    
    Returns:
    
    The Date value of the specified key.
  - getString
```
public String getString(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The String value of the specified key. null if the key is not defined.
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The String value of the specified key. If the key is not defined, the default value is returned instead.
  - getStringArray
```
public String[] getStringArray(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The String[] value of the specified key.
  - getObject
```
public Object getObject(String key)
```
    Convenience method to avoid common casts.
    
    Parameters:
    
    key -
    
    Returns:
    
    The value of the specified key, returned generically as an Object.
  - set
```
public void set(String key,
                Object value)
         throws IllegalArgumentException
```
    Description copied from interface: PolicyParameters
    
    This works just like a Map, except it will throw an exception if lock() has been called.
    
    Specified by:
    
    set in interface PolicyParameters
    
    Throws:
    
    IllegalArgumentException - if this DynaBeanACRParameter instance has already been locked.
  - put
```
public void put(String key,
                Object value)
         throws IllegalArgumentException
```
    Description copied from interface: PolicyParameters
    
    This is a convenience method for developers that prefer to think of this as a map instead of being bean-like.
    
    Specified by:
    
    put in interface PolicyParameters
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PolicyParameters.set(String, Object)
  - lock
```
public void lock()
```
    This makes the map itself read only, but the mutability of objects that this map contains is not affected. Specifically, properties cannot be added or removed and the reference cannot be changed to a different object, but this does not change whether the values that the object contains can be changed.
    
    Specified by:
    
    lock in interface PolicyParameters
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DynaBeanACRParameter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

policyProperties

Constructor Detail

DynaBeanACRParameter

Method Detail

get

getBoolean

getByte

getChar

getInt

getLong

getFloat

getDouble

getBigDecimal

getBigInteger

getDate

getTime

getString

getString

getStringArray

getObject

set

put

lock

toString