de.smartics.properties.impl.config.classpath
Class ClasspathConfigurationProperties

Package class diagram package ClasspathConfigurationProperties
java.lang.Object
  extended by de.smartics.properties.spi.config.support.AbstractConfigurationProperties
      extended by de.smartics.properties.spi.config.support.AbstractAdminModeConfigurationProperties
          extended by de.smartics.properties.spi.config.support.AbstractConfigurationPropertiesManagement
              extended by de.smartics.properties.spi.config.support.AbstractInMemoryConfigurationProperties
                  extended by de.smartics.properties.impl.config.classpath.ClasspathConfigurationProperties
All Implemented Interfaces:
ConfigurationProperties, ConfigurationPropertiesManagement, SerializableConfigurationProperties, SerializableConfigurationPropertiesManagement, ConfigurationPropertiesManagementSpi, ConfigurationPropertiesSpi, Serializable

@ThreadSafe
public final class ClasspathConfigurationProperties
     
     
extends AbstractInMemoryConfigurationProperties

Implementation based on Properties.

This implementation is not capable of tracking changes to properties after they have been added to this configuration.

See Also:
Serialized Form

Constructor Summary
ClasspathConfigurationProperties(boolean requiresDefaultOnClassPath, PropertyValueSecurity decrypter)
          Convenience constructor allowing to control the need of existing properties files on the classpath, using its own registry and an artificial key.
ClasspathConfigurationProperties(ConfigurationKey<?> key, PropertyDescriptorRegistry registry, PropertyValueSecurity decrypter)
          Default constructor.
ClasspathConfigurationProperties(ConfigurationKey<?> key, PropertyValueSecurity decrypter)
          Convenience constructor using its own registry.
ClasspathConfigurationProperties(PropertyValueSecurity decrypter)
          Convenience constructor using its own registry and an artificial key.
 
Method Summary
 SerializableConfigurationPropertiesManagement toSerializable()
          Creates a serializable variant of this implementation.
 
Methods inherited from class de.smartics.properties.spi.config.support.AbstractInMemoryConfigurationProperties
addClassPathProperties, addDefinitionsToStore, getPropertyStoreAccessor, setPropertiesToStore, toString
 
Methods inherited from class de.smartics.properties.spi.config.support.AbstractConfigurationPropertiesManagement
addDefinitions, addDescriptors, deletePropertyInStore, flush, getDescriptor, getDescriptor, getMandatoryPropertyDescriptors, getProperty, getProperty, getPropertyAsType, getPropertyCollectionFromStore, getPropertyFromStore, getValidatedProperty, setProperty, setPropertyToStore, unsetProperty, validate, validate, validate
 
Methods inherited from class de.smartics.properties.spi.config.support.AbstractAdminModeConfigurationProperties
isInAdminMode, setToAdminMode, toRepresentative
 
Methods inherited from class de.smartics.properties.spi.config.support.AbstractConfigurationProperties
addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, getContext, getContext, getKey, getProperties, getProperties, getProperty, getProperty, getProperty, getPropertyDescriptor, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueSecurity, getRegistry, getValidatedProperty, getValidatedProperty, removePropertyChangeListener, removePropertyChangeListener, resolveAndConvert, resolveAndConvertAndValidate, validate, validate, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface de.smartics.properties.api.config.domain.ConfigurationPropertiesManagement
addDefinitions, addDescriptors, flush, getDescriptor, getDescriptor, getMandatoryPropertyDescriptors, getPropertyValueSecurity, getRegistry, setProperty, setToAdminMode, toRepresentative, unsetProperty
 
Methods inherited from interface de.smartics.properties.api.config.domain.ConfigurationProperties
addPropertyChangeListener, addPropertyChangeListener, getContext, getContext, getKey, getProperties, getProperty, getProperty, getProperty, getProperty, getProperty, getPropertyAsType, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueAsString, getValidatedProperty, getValidatedProperty, getValidatedProperty, isInAdminMode, removePropertyChangeListener, removePropertyChangeListener, validate, validate, validate, validate, validate
 
Methods inherited from interface de.smartics.properties.spi.config.support.ConfigurationPropertiesSpi
getProperties
 

Constructor Detail

ClasspathConfigurationProperties

public ClasspathConfigurationProperties(PropertyValueSecurity decrypter)
                                 throws de.smartics.util.lang.NullArgumentException
Convenience constructor using its own registry and an artificial key.

Parameters:
decrypter - the helper to decrypt secured property values.
Throws:
de.smartics.util.lang.NullArgumentException - if decrypter is null.
de.smartics.util.lang.NullArgumentException - if decrypter is null.

ClasspathConfigurationProperties

public ClasspathConfigurationProperties(boolean requiresDefaultOnClassPath,
                                        PropertyValueSecurity decrypter)
                                 throws de.smartics.util.lang.NullArgumentException
Convenience constructor allowing to control the need of existing properties files on the classpath, using its own registry and an artificial key.

Parameters:
requiresDefaultOnClassPath - the flag controls the behavior on not finding default properties on the classpath. If the value is true not finding the properties file on the class path signals an exception, if set to false the properties are not required to exist. In the latter case the properties may be set purely programatically.
decrypter - the helper to decrypt secured property values.
Throws:
de.smartics.util.lang.NullArgumentException - if decrypter is null.

ClasspathConfigurationProperties

public ClasspathConfigurationProperties(ConfigurationKey<?> key,
                                        PropertyValueSecurity decrypter)
                                 throws de.smartics.util.lang.NullArgumentException
Convenience constructor using its own registry.

Parameters:
key - the key that identifies the configuration.
decrypter - the helper to decrypt secured property values.
Throws:
de.smartics.util.lang.NullArgumentException - if key or decrypter is null.

ClasspathConfigurationProperties

public ClasspathConfigurationProperties(ConfigurationKey<?> key,
                                        PropertyDescriptorRegistry registry,
                                        PropertyValueSecurity decrypter)
                                 throws de.smartics.util.lang.NullArgumentException
Default constructor.

Parameters:
key - the key that identifies the configuration.
registry - the registry to resolve property descriptors.
decrypter - the helper to decrypt secured property values.
Throws:
de.smartics.util.lang.NullArgumentException - if key, registry or decrypter is null.
Method Detail

toSerializable

public SerializableConfigurationPropertiesManagement toSerializable()
Description copied from interface: ConfigurationProperties
Creates a serializable variant of this implementation.

Returns:
a serializable variant of this implementation.
See Also:
ConfigurationPropertiesProxy, ConfigurationPropertiesManagementProxy


Copyright © 2012-2013 Kronseder & Reiner GmbH - smartics. All Rights Reserved.