ConfigAdminPropertiesFactoryBean

java.lang.Object
- org.eclipse.gemini.blueprint.compendium.cm.ConfigAdminPropertiesFactoryBean

All Implemented Interfaces:

BundleContextAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<java.util.Properties>, org.springframework.beans.factory.InitializingBean
```
public class ConfigAdminPropertiesFactoryBean
extends java.lang.Object
implements BundleContextAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<java.util.Properties>
```
FactoryBean returning the properties stored under a given persistent id in the ConfigurationAdmin service. Once retrieved, the properties will remain the same, even when the configuration object that it maps, changes. Note: This implementation performs a lazy initialization of the properties to receive the most up to date configuration.

See Also:

Configuration, ConfigurationAdmin, org.springframework.core.io.support.PropertiesFactoryBean

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class ConfigAdminPropertiesFactoryBean.ConfigurationWatcher

Nested Classes
Modifier and Type	Class and Description
`private class`	`ConfigAdminPropertiesFactoryBean.ConfigurationWatcher`

Field Summary

Fields
Modifier and Type	Field and Description
`private org.osgi.framework.BundleContext`	`bundleContext`
`private boolean`	`dynamic`
`private boolean`	`initLazy`
`private long`	`initTimeout`
`private boolean`	`localOverride`
`private java.util.Properties`	`localProperties`
`private static org.apache.commons.logging.Log`	`log` logger
`private java.lang.Object`	`monitor`
`private java.lang.String`	`persistentId`
`private java.util.Properties`	`properties`
`private org.osgi.framework.ServiceRegistration`	`registration`

Constructor Summary

Constructors
Constructor and Description

ConfigAdminPropertiesFactoryBean()

Constructors
Constructor and Description
`ConfigAdminPropertiesFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`private void`	`createProperties()`
`void`	`destroy()`
`java.util.Properties`	`getObject()`
`java.lang.Class<? extends java.util.Properties>`	`getObjectType()`
`java.lang.String`	`getPersistentId()` Returns the persistentId.
`boolean`	`isDynamic()` Indicates whether the returned properties object is dynamic or not.
`boolean`	`isSingleton()`
`void`	`setBundleContext(org.osgi.framework.BundleContext bundleContext)` Set the `BundleContext` that this bean runs in.
`void`	`setDynamic(boolean dynamic)` Indicates if the returned configuration is dynamic or static.
`void`	`setInitLazy(boolean initLazy)` Specifies whether the properties reflecting the Configuration Admin service entry will be initialized lazy or not.
`void`	`setInitTimeout(long initTimeout)` Specifies the amount of time (in milliseconds) the bean factory will wait for the Configuration Admin entry to be initialized (return a non-null value).
`void`	`setLocalOverride(boolean localOverride)` Sets whether local properties override properties from files.
`void`	`setPersistentId(java.lang.String persistentId)` Sets the ConfigurationAdmin persistent Id that the bean should read.
`void`	`setProperties(java.util.Properties properties)` Sets the local properties, e.g.

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

- Field Detail
  - log
```
private static final org.apache.commons.logging.Log log
```
    logger
  - persistentId
```
private volatile java.lang.String persistentId
```
  - properties
```
private volatile java.util.Properties properties
```
  - bundleContext
```
private org.osgi.framework.BundleContext bundleContext
```
  - localOverride
```
private boolean localOverride
```
  - localProperties
```
private java.util.Properties localProperties
```
  - dynamic
```
private volatile boolean dynamic
```
  - registration
```
private volatile org.osgi.framework.ServiceRegistration registration
```
  - initLazy
```
private boolean initLazy
```
  - initTimeout
```
private long initTimeout
```
  - monitor
```
private final java.lang.Object monitor
```
- Constructor Detail
  - ConfigAdminPropertiesFactoryBean
```
public ConfigAdminPropertiesFactoryBean()
```
- Method Detail
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    java.lang.Exception
  - destroy
```
public void destroy()
             throws java.lang.Exception
```
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean
    
    Throws:
    
    java.lang.Exception
  - createProperties
```
private void createProperties()
```
  - getObject
```
public java.util.Properties getObject()
                               throws java.lang.Exception
```
    Specified by:
    
    getObject in interface org.springframework.beans.factory.FactoryBean<java.util.Properties>
    
    Throws:
    
    java.lang.Exception
  - getObjectType
```
public java.lang.Class<? extends java.util.Properties> getObjectType()
```
    Specified by:
    
    getObjectType in interface org.springframework.beans.factory.FactoryBean<java.util.Properties>
  - isSingleton
```
public boolean isSingleton()
```
    Specified by:
    
    isSingleton in interface org.springframework.beans.factory.FactoryBean<java.util.Properties>
  - getPersistentId
```
public java.lang.String getPersistentId()
```
    Returns the persistentId.
    
    Returns:
    
    Returns the persistentId
  - setPersistentId
```
public void setPersistentId(java.lang.String persistentId)
```
    Sets the ConfigurationAdmin persistent Id that the bean should read.
    
    Parameters:
    
    persistentId - The persistentId to set.
  - setProperties
```
public void setProperties(java.util.Properties properties)
```
    Sets the local properties, e.g. via the nested tag in XML bean definitions. These can be considered defaults, to be overridden by properties loaded from the Configuration Admin.
  - setLocalOverride
```
public void setLocalOverride(boolean localOverride)
```
    Sets whether local properties override properties from files.
    Default is "false": Properties from the Configuration Admin override local defaults. Can be switched to "true" to let local properties override the Configuration Admin properties.
  - setBundleContext
```
public void setBundleContext(org.osgi.framework.BundleContext bundleContext)
```
    Description copied from interface: BundleContextAware
    
    Set the BundleContext that this bean runs in. Normally this can be used to initialize an object.
    
    Specified by:
    
    setBundleContext in interface BundleContextAware
    
    Parameters:
    
    bundleContext - the BundleContext object to be used by this object
  - isDynamic
```
public boolean isDynamic()
```
    Indicates whether the returned properties object is dynamic or not.
    
    Returns:
    
    boolean indicating if the configuration object is dynamic
  - setDynamic
```
public void setDynamic(boolean dynamic)
```
    Indicates if the returned configuration is dynamic or static. A static configuration (default) ignores any updates made to the configuration admin entry that it maps. A dynamic configuration on the other hand will reflect the changes in its content. Third parties can be notified through the ServicePropertiesChangeListener contract.
    
    Parameters:
    
    dynamic - whether the returned object reflects the changes in the configuration admin or not.
  - setInitLazy
```
public void setInitLazy(boolean initLazy)
```
    Specifies whether the properties reflecting the Configuration Admin service entry will be initialized lazy or not. Default is "true": meaning the properties will be initialized just before being requested (from the factory) for the first time. This is the common case as it allows the most recent entry to be used. If set to "false", the properties object will be initialized at startup, along with the bean factory.
    
    Parameters:
    
    initLazy - whether or not the bean is lazily initialized
  - setInitTimeout
```
public void setInitTimeout(long initTimeout)
```
    Specifies the amount of time (in milliseconds) the bean factory will wait for the Configuration Admin entry to be initialized (return a non-null value). If the entry is not null at startup, no waiting will be performed. Similar to the other timeout options, a value of '0' means no waiting. By default, no waiting (0) is performed.
    
    Parameters:
    
    initTimeout - the amount of time to wait for the entry to be initialized.

Class ConfigAdminPropertiesFactoryBean

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

persistentId

properties

bundleContext

localOverride

localProperties

dynamic

registration

initLazy

initTimeout

monitor

Constructor Detail

ConfigAdminPropertiesFactoryBean

Method Detail

afterPropertiesSet

destroy

createProperties

getObject

getObjectType

isSingleton

getPersistentId

setPersistentId

setProperties

setLocalOverride

setBundleContext

isDynamic

setDynamic

setInitLazy

setInitTimeout