ConfigurationWithPollingSource (archaius-core 0.4.1 API)

java.lang.Object
- com.netflix.config.ConfigurationWithPollingSource

All Implemented Interfaces:

org.apache.commons.configuration.Configuration
```
public class ConfigurationWithPollingSource
extends Object
implements org.apache.commons.configuration.Configuration
```
This class delegates property read/write to an another configuration but is also attached with a dynamic configuration source and polling scheduler so that its properties can be changed dynamically at runtime. In other words, if the same property is defined in both the original configuration and the dynamic configuration source, the value in the original configuration will be overridden.
This class can be served as a decorator to an existing configuration to make the property values dynamic.

Author:

awang

Constructor Summary

Constructors
Constructor and Description
`ConfigurationWithPollingSource(org.apache.commons.configuration.Configuration config, PolledConfigurationSource source, AbstractPollingScheduler scheduler)` Create an instance and start polling the configuration source

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addProperty(String key, Object value)` Delegates to the underlying configuration.
`void`	`clear()` Delegates to the underlying configuration.
`void`	`clearProperty(String key)` Delegates to the underlying configuration.
`boolean`	`containsKey(String arg0)` Delegates to the underlying configuration.
`BigDecimal`	`getBigDecimal(String key)` Delegates to the underlying configuration.
`BigDecimal`	`getBigDecimal(String key, BigDecimal defaultValue)` Delegates to the underlying configuration.
`BigInteger`	`getBigInteger(String key)` Delegates to the underlying configuration.
`BigInteger`	`getBigInteger(String key, BigInteger defaultValue)` Delegates to the underlying configuration.
`boolean`	`getBoolean(String key)` Delegates to the underlying configuration.
`boolean`	`getBoolean(String key, boolean defaultValue)` Delegates to the underlying configuration.
`Boolean`	`getBoolean(String key, Boolean defaultValue)` Delegates to the underlying configuration.
`byte`	`getByte(String key)` Delegates to the underlying configuration.
`byte`	`getByte(String key, byte defaultValue)` Delegates to the underlying configuration.
`Byte`	`getByte(String key, Byte defaultValue)` Delegates to the underlying configuration.
`org.apache.commons.configuration.Configuration`	`getConfiguration()`
`double`	`getDouble(String key)` Delegates to the underlying configuration.
`double`	`getDouble(String key, double defaultValue)` Delegates to the underlying configuration.
`Double`	`getDouble(String key, Double defaultValue)` Delegates to the underlying configuration.
`float`	`getFloat(String key)` Delegates to the underlying configuration.
`float`	`getFloat(String key, float defaultValue)` Delegates to the underlying configuration.
`Float`	`getFloat(String key, Float defaultValue)` Delegates to the underlying configuration.
`int`	`getInt(String key)` Delegates to the underlying configuration.
`int`	`getInt(String key, int defaultValue)` Delegates to the underlying configuration.
`Integer`	`getInteger(String key, Integer defaultValue)` Delegates to the underlying configuration.
`Iterator`	`getKeys()` Delegates to the underlying configuration.
`Iterator`	`getKeys(String prefix)` Delegates to the underlying configuration.
`List`	`getList(String key)` Delegates to the underlying configuration.
`List`	`getList(String key, List defaultValue)` Delegates to the underlying configuration.
`long`	`getLong(String key)` Delegates to the underlying configuration.
`long`	`getLong(String key, long defaultValue)` Delegates to the underlying configuration.
`Long`	`getLong(String key, Long defaultValue)` Delegates to the underlying configuration.
`Properties`	`getProperties(String key)` Delegates to the underlying configuration.
`Object`	`getProperty(String arg0)` Delegates to the underlying configuration.
`short`	`getShort(String key)` Delegates to the underlying configuration.
`short`	`getShort(String key, short defaultValue)` Delegates to the underlying configuration.
`Short`	`getShort(String key, Short defaultValue)` Delegates to the underlying configuration.
`String`	`getString(String key)` Delegates to the underlying configuration.
`String`	`getString(String key, String defaultValue)` Delegates to the underlying configuration.
`String[]`	`getStringArray(String key)` Delegates to the underlying configuration.
`boolean`	`isEmpty()` Delegates to the underlying configuration.
`void`	`setProperty(String key, Object value)` Delegates to the underlying configuration.
`void`	`stopPolling()`
`org.apache.commons.configuration.Configuration`	`subset(String prefix)` Delegates to the underlying configuration.

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

- Constructor Detail
  - ConfigurationWithPollingSource
```
public ConfigurationWithPollingSource(org.apache.commons.configuration.Configuration config,
                              PolledConfigurationSource source,
                              AbstractPollingScheduler scheduler)
```
    Create an instance and start polling the configuration source
    
    Parameters:
    config - Configuration to delegate to
    source - PolledConfigurationSource to poll get new/changed properties
    scheduler - AbstractPollingScheduler to provide the polling schedule
- Method Detail
  - getConfiguration
```
public final org.apache.commons.configuration.Configuration getConfiguration()
```
  - stopPolling
```
public final void stopPolling()
```
  - addProperty
```
public void addProperty(String key,
               Object value)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    addProperty in interface org.apache.commons.configuration.Configuration
  - clear
```
public void clear()
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    clear in interface org.apache.commons.configuration.Configuration
  - clearProperty
```
public void clearProperty(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    clearProperty in interface org.apache.commons.configuration.Configuration
  - containsKey
```
public boolean containsKey(String arg0)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    containsKey in interface org.apache.commons.configuration.Configuration
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key,
                       BigDecimal defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getBigDecimal in interface org.apache.commons.configuration.Configuration
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getBigDecimal in interface org.apache.commons.configuration.Configuration
  - getBigInteger
```
public BigInteger getBigInteger(String key,
                       BigInteger defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getBigInteger in interface org.apache.commons.configuration.Configuration
  - getBigInteger
```
public BigInteger getBigInteger(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getBigInteger in interface org.apache.commons.configuration.Configuration
  - getBoolean
```
public boolean getBoolean(String key,
                 boolean defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getBoolean in interface org.apache.commons.configuration.Configuration
  - getBoolean
```
public Boolean getBoolean(String key,
                 Boolean defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getBoolean in interface org.apache.commons.configuration.Configuration
  - getBoolean
```
public boolean getBoolean(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getBoolean in interface org.apache.commons.configuration.Configuration
  - getByte
```
public byte getByte(String key,
           byte defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getByte in interface org.apache.commons.configuration.Configuration
  - getByte
```
public Byte getByte(String key,
           Byte defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getByte in interface org.apache.commons.configuration.Configuration
  - getByte
```
public byte getByte(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getByte in interface org.apache.commons.configuration.Configuration
  - getDouble
```
public double getDouble(String key,
               double defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getDouble in interface org.apache.commons.configuration.Configuration
  - getDouble
```
public Double getDouble(String key,
               Double defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getDouble in interface org.apache.commons.configuration.Configuration
  - getDouble
```
public double getDouble(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getDouble in interface org.apache.commons.configuration.Configuration
  - getFloat
```
public float getFloat(String key,
             float defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getFloat in interface org.apache.commons.configuration.Configuration
  - getFloat
```
public Float getFloat(String key,
             Float defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getFloat in interface org.apache.commons.configuration.Configuration
  - getFloat
```
public float getFloat(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getFloat in interface org.apache.commons.configuration.Configuration
  - getInt
```
public int getInt(String key,
         int defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getInt in interface org.apache.commons.configuration.Configuration
  - getInt
```
public int getInt(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getInt in interface org.apache.commons.configuration.Configuration
  - getInteger
```
public Integer getInteger(String key,
                 Integer defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getInteger in interface org.apache.commons.configuration.Configuration
  - getKeys
```
public Iterator getKeys()
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getKeys in interface org.apache.commons.configuration.Configuration
  - getKeys
```
public Iterator getKeys(String prefix)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getKeys in interface org.apache.commons.configuration.Configuration
  - getList
```
public List getList(String key,
           List defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getList in interface org.apache.commons.configuration.Configuration
  - getList
```
public List getList(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getList in interface org.apache.commons.configuration.Configuration
  - getLong
```
public long getLong(String key,
           long defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getLong in interface org.apache.commons.configuration.Configuration
  - getLong
```
public Long getLong(String key,
           Long defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getLong in interface org.apache.commons.configuration.Configuration
  - getLong
```
public long getLong(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getLong in interface org.apache.commons.configuration.Configuration
  - getProperties
```
public Properties getProperties(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getProperties in interface org.apache.commons.configuration.Configuration
  - getProperty
```
public Object getProperty(String arg0)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getProperty in interface org.apache.commons.configuration.Configuration
  - getShort
```
public short getShort(String key,
             short defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getShort in interface org.apache.commons.configuration.Configuration
  - getShort
```
public Short getShort(String key,
             Short defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getShort in interface org.apache.commons.configuration.Configuration
  - getShort
```
public short getShort(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getShort in interface org.apache.commons.configuration.Configuration
  - getString
```
public String getString(String key,
               String defaultValue)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getString in interface org.apache.commons.configuration.Configuration
  - getString
```
public String getString(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getString in interface org.apache.commons.configuration.Configuration
  - getStringArray
```
public String[] getStringArray(String key)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    getStringArray in interface org.apache.commons.configuration.Configuration
  - isEmpty
```
public boolean isEmpty()
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    isEmpty in interface org.apache.commons.configuration.Configuration
  - setProperty
```
public void setProperty(String key,
               Object value)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    setProperty in interface org.apache.commons.configuration.Configuration
  - subset
```
public org.apache.commons.configuration.Configuration subset(String prefix)
```
    Delegates to the underlying configuration.
    
    Specified by:
    
    subset in interface org.apache.commons.configuration.Configuration

Class ConfigurationWithPollingSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigurationWithPollingSource

Method Detail

getConfiguration

stopPolling

addProperty

clear

clearProperty

containsKey

getBigDecimal

getBigDecimal

getBigInteger

getBigInteger

getBoolean

getBoolean

getBoolean

getByte

getByte

getByte

getDouble

getDouble

getDouble

getFloat

getFloat

getFloat

getInt

getInt

getInteger

getKeys

getKeys

getList

getList

getLong

getLong

getLong

getProperties

getProperty

getShort

getShort

getShort

getString

getString

getStringArray

isEmpty

setProperty

subset