Serialized Form

Package de.smartics.properties.api.config.app

Class de.smartics.properties.api.config.app.ConfigurationFactoryException extends PropertyRootException implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.api.config.app.FactoryConfiguration extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

addDefaultRootLocations

boolean addDefaultRootLocations

The flag to tell whether ( true) or not ( false) the URLs of the context class loader should be added.

skipClassPathPropertyLoading

boolean skipClassPathPropertyLoading

The flag indicates that loading properties form the class path is to be skipped.

useCache

boolean useCache

The flag indicates that a cache should be provided, if supported.

Package de.smartics.properties.api.config.domain

Class de.smartics.properties.api.config.domain.CompoundConfigurationException extends ConfigurationException implements Serializable

serialVersionUID: 1L

Serialized Fields

exceptions

List<E> exceptions

The list of encountered exceptions.

Class de.smartics.properties.api.config.domain.ConfigurationException extends PropertyRootException implements Serializable

serialVersionUID: 1L

Serialized Fields

key

ConfigurationKey key

The key to the configuration that signaled problems.

Class de.smartics.properties.api.config.domain.ConfigurationLoadingException extends ConfigurationException implements Serializable

serialVersionUID: 1L

Serialized Fields

resourceId

String resourceId

The string representation of the path of the properties resource that cannot be loaded. This may be an URL, a file name or whatever seems appropriate.

Class de.smartics.properties.api.config.domain.ConfigurationNotFoundException extends ConfigurationLoadingException implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.api.config.domain.ConfigurationValidationException extends ConfigurationException implements Serializable

serialVersionUID: 1L

Serialized Fields

propertyViolations

List<E> propertyViolations

The list of violations.

mandatoryProperties

List<E> mandatoryProperties

The list of mandatory properties for which no value has been provided.

unknownProperties

UnknownProperties unknownProperties

The list of unknown properties.

Class de.smartics.properties.api.config.domain.DuplicateConfigurationException extends ConfigurationException implements Serializable

serialVersionUID: 1L

Serialized Fields

currentConfigurationProperties

ConfigurationPropertiesManagement currentConfigurationProperties

The configuration that has been registered and is currently active.

duplicateConfigurationProperties

ConfigurationPropertiesManagement duplicateConfigurationProperties

The configuration that is a duplication of the current configuration and has been rejected from being registered with the given key.

Class de.smartics.properties.api.config.domain.DuplicatePropertyDefinitionException extends ConfigurationException implements Serializable

serialVersionUID: 1L

Serialized Fields

currentDefinition

PropertyDefinition currentDefinition

The previously encountered and currently active property.

newDefinition

PropertyDefinition newDefinition

The new encountered property descriptor with the same key.

Class de.smartics.properties.api.config.domain.DuplicatePropertyException extends ConfigurationException implements Serializable

serialVersionUID: 1L

Serialized Fields

currentProperty

Property currentProperty

The currently active property.

newProperty

Property newProperty

The new encountered property with the same key.

Class de.smartics.properties.api.config.domain.MissingConfigurationException extends ConfigurationException implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.api.config.domain.Property extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

source

PropertyLocation source

The optional source where the property value has been defined. This is an arbitrary name that defines the origin in its context.

name

String name

The name of the property. Must not blank.

value

String value

The value of the property. May be null.

Class de.smartics.properties.api.config.domain.PropertyDefinition extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

descriptor

PropertyDescriptor descriptor

The descriptor of the property.

property

Property property

The value and location information of the property.

Class de.smartics.properties.api.config.domain.PropertyIndex extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

configurationKey

ConfigurationKey configurationKey

The key to the configuration the properties are part of.

properties

Map<K,V> properties

The index of properties.

Class de.smartics.properties.api.config.domain.PropertyLocation extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

applicationId

ApplicationId applicationId

The identifier of the application archive that contains the property. The value may be null if no archive contains the information. This is e.g. the case if the property is provided by a data source or other external information system.

path

String path

The identifier of the property location within the application. The path may serve as an ID like a JNDI name or name the path to a properties file within the archive.

This value must not be null.

Class de.smartics.properties.api.config.domain.PropertyValidationWithSourceException extends PropertyValidationException implements Serializable

serialVersionUID: 1L

Serialized Fields

source

PropertyLocation source

The source where the property value has been defined.

Class de.smartics.properties.api.config.domain.PropertyValueConversionWithSourceException extends PropertyValueConversionException implements Serializable

serialVersionUID: 1L

Serialized Fields

source

PropertyLocation source

The source where the property value has been defined.

Class de.smartics.properties.api.config.domain.PropertyValueResolveWithSourceException extends PropertyValueResolveException implements Serializable

serialVersionUID: 1L

Serialized Fields

source

PropertyLocation source

The source where the property value has been defined.

Class de.smartics.properties.api.config.domain.ResolvedProperty extends Property implements Serializable

serialVersionUID: 1L

Serialized Fields

expression

String expression

The property expression. May be null. If the property value is null, the expression is checked for default values.

resolvedValue

Object resolvedValue

The resolved value. The property value is resolved and converted to this value. May be null.

Class de.smartics.properties.api.config.domain.UnknownProperties extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

properties

List<E> properties

The list of unknown properties.

Class de.smartics.properties.api.config.domain.UnknownPropertyException extends ConfigurationException implements Serializable

serialVersionUID: 1L

Serialized Fields

propertyKey

String propertyKey

The key to the unknown property.

Package de.smartics.properties.api.config.domain.key

Class de.smartics.properties.api.config.domain.key.ApplicationId extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

groupId

String groupId

The group the application belongs to.

artifactId

String artifactId

The name of the application.

version

String version

The version of the application.

Class de.smartics.properties.api.config.domain.key.ConfigurationKey extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

environmentId

EnvironmentId environmentId

The identifier of the environment the application is deployed in.

applicationId

ApplicationId applicationId

The identifier of the application whose configuration is requested.

hashCodeValue

int hashCodeValue

The pre-calculated hash code of this instance.

Class de.smartics.properties.api.config.domain.key.ConfigurationKeyHelper extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

preferEarManifest

boolean preferEarManifest

The flag to signal that the manifest of a EAR file (with the extension ear) is preferred if present.

Class de.smartics.properties.api.config.domain.key.EnvironmentId extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

name

String name

The name of the environment.

node

String node

The optional identifier of the node within the given environment.

Package de.smartics.properties.api.core.app

Class de.smartics.properties.api.core.app.PropertyRootException extends RuntimeException implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.api.core.context.alias

Class de.smartics.properties.api.core.context.alias.AliasException extends RuntimeException implements Serializable

serialVersionUID: 1L

Serialized Fields

alias

String alias

The alias that signals a problem.

Class de.smartics.properties.api.core.context.alias.DuplicateAliasException extends AliasException implements Serializable

serialVersionUID: 1L

Serialized Fields

oldTarget

String oldTarget

The physical value stored with the alias.

newTarget

String newTarget

The new physical value that differs from the previously stored.

Class de.smartics.properties.api.core.context.alias.PropertyAliasMapping extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

aliasMapping

Map<K,V> aliasMapping

The mapping of alias names of property reports to their physical names. The physical names are those file names that are stored in the META-INF folder or on the server in the case of HTML reports. The alias names are alternative, unique naming schemes that refer to the same files.

The key is the name of the alias, the value is the physical resource. There is only one physical for each alias, but different aliases may point to the same resource.

Class de.smartics.properties.api.core.context.alias.UnknownAliasException extends AliasException implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.api.core.domain

Class de.smartics.properties.api.core.domain.ConfigException extends RuntimeException implements Serializable

serialVersionUID: 1L

Serialized Fields

systemId

String systemId

The resource that cannot be read.

Class de.smartics.properties.api.core.domain.DuplicatePropertyDeclarationException extends PropertyException implements Serializable

serialVersionUID: 1L

Serialized Fields

currentDescriptor

PropertyDescriptor currentDescriptor

The previously encountered and currently active property.

newDescriptor

PropertyDescriptor newDescriptor

The new encountered property descriptor with the same key.

Class de.smartics.properties.api.core.domain.DuplicatePropertyDeclarationsException extends PropertyRootException implements Serializable

serialVersionUID: 1L

Serialized Fields

exceptions

List<E> exceptions

The list of property declarations of declaration collisions. This is where two interfaces declare properties with identical keys.

Class de.smartics.properties.api.core.domain.PropertiesContext extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

locales

List<E> locales

The list of supported locales. The list contains locales the context provides localized information for.

homePageUrl

String homePageUrl

The URL to the home page of the project. May be null.

propertiesReportUrl

String propertiesReportUrl

The URL to the root directory of smartics properties reports. May be null.

aliasMapping

PropertyAliasMapping aliasMapping

The mapping of alias names of property reports to their physical names.

Implementation Notes:

Although PropertyAliasMapping is not thread-safe, this instance provides no write-access to it.

Class de.smartics.properties.api.core.domain.PropertyComment extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

text

String text

The text of the comment.

valueComment

PropertyValueComment valueComment

The comment of the property values.

Class de.smartics.properties.api.core.domain.PropertyDescriptorException extends PropertyException implements Serializable

serialVersionUID: 1L

Serialized Fields

propertyDescriptor

PropertyDescriptor propertyDescriptor

The descriptor of the property raising the exception.

Class de.smartics.properties.api.core.domain.PropertyException extends PropertyRootException implements Serializable

serialVersionUID: 1L

Serialized Fields

propertyKey

PropertyKey propertyKey

The key of the property raising the exception.

Class de.smartics.properties.api.core.domain.PropertyExpression extends Object implements Serializable

serialVersionUID: 1L

Serialization Methods

readResolve

private Object readResolve()
                    throws ObjectStreamException

Special treatment for serializable singletons.

Throws:

ObjectStreamException

Serialized Fields

expression

String expression

The expression string. May be null.

Class de.smartics.properties.api.core.domain.PropertyKey extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

propertySet

String propertySet

The name of the set the property belongs to. This is the scope within the name is unique. It may be null (which indicates that the scope is global), but is must not be blank.

name

String name

The name of the property.

This value must not be blank.

Class de.smartics.properties.api.core.domain.PropertyType extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

type

Class<T> type

The Java type of the property.

elementType

Class<T> elementType

The Java type of the elements of the property if the type is a collection type. The value is derived from the value specified as PropertyElementType.

Class de.smartics.properties.api.core.domain.PropertyValidationException extends PropertyDescriptorException implements Serializable

serialVersionUID: 1L

Serialized Fields

constraints

List<E> constraints

The property constraints that failed to be met.

value

Serializable value

The value of the property that does not meet the constraints.

Class de.smartics.properties.api.core.domain.PropertyValueComment extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

summary

String summary

The optional summary of the type of the values. May be null.

valueCommentMap

Map<K,V> valueCommentMap

The map of values of the type to their comments.

Class de.smartics.properties.api.core.domain.PropertyValueConversionException extends PropertyDescriptorException implements Serializable

serialVersionUID: 1L

Serialized Fields

value

Serializable value

The value of the property that does not meet the constraints.

Class de.smartics.properties.api.core.domain.PropertyValueResolveException extends PropertyDescriptorException implements Serializable

serialVersionUID: 1L

Serialized Fields

expression

String expression

The expression that failed to be resolved.

Class de.smartics.properties.api.core.domain.ReadOnlyPropertyException extends PropertyDescriptorException implements Serializable

serialVersionUID: 1L

Serialized Fields

currentValue

Serializable currentValue

The current value of the property that has not been changed.

rejectedValue

Serializable rejectedValue

The value the property was requested to change to but has been rejected.

Package de.smartics.properties.impl.config.cache

Class de.smartics.properties.impl.config.cache.AbstractCacheConfigurationPropertiesManagement extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

cache

de.smartics.properties.impl.config.cache.DependencyTrackingCache cache

The cache implementation that provides synchronized access to the stored elements.

Class de.smartics.properties.impl.config.cache.CacheConfigurationPropertiesManagement extends AbstractCacheConfigurationPropertiesManagement implements Serializable

serialVersionUID: 1L

Serialized Fields

delegate

ConfigurationPropertiesManagementSpi delegate

The wrapped delegate whose properties are to be cached.

Class de.smartics.properties.impl.config.cache.SerializableCacheConfigurationPropertiesManagement extends AbstractCacheConfigurationPropertiesManagement implements Serializable

serialVersionUID: 1L

Serialized Fields

delegate

SerializableConfigurationPropertiesManagementSpi delegate

The wrapped delegate whose properties are to be cached.

Package de.smartics.properties.impl.config.classpath

Class de.smartics.properties.impl.config.classpath.ClasspathConfigurationProperties extends AbstractInMemoryConfigurationProperties implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.impl.config.classpath.ClasspathConfigurationPropertiesFactory extends AbstractConfigurationPropertiesFactory<ClasspathConfigurationProperties> implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.impl.config.ds

Class de.smartics.properties.impl.config.ds.DataSourceConfigurationProperties extends AbstractConfigurationPropertiesManagement implements Serializable

serialVersionUID: 1L

Serialized Fields

store

PropertiesStore store

The store containing properties.

Class de.smartics.properties.impl.config.ds.DataSourceConfigurationPropertiesFactory extends AbstractConfigurationPropertiesFactory<ConfigurationPropertiesManagement> implements Serializable

serialVersionUID: 1L

Serialized Fields

manager

PropertiesStore manager

The cached manager for reuse to access properties information.

Package de.smartics.properties.impl.config.properties

Class de.smartics.properties.impl.config.properties.PropertiesConfigurationProperties extends AbstractInMemoryConfigurationProperties implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.impl.config.properties.PropertiesConfigurationPropertiesFactory extends AbstractConfigurationPropertiesFactory<PropertiesConfigurationProperties> implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.impl.config.resource

Class de.smartics.properties.impl.config.resource.ResourceConfigurationPropertiesFactory extends AbstractConfigurationPropertiesFactory<ConfigurationPropertiesManagement> implements Serializable

serialVersionUID: 1L

Serialized Fields

artifactIds

Map<K,V> artifactIds

The list of artifact that reference all resources to access to read property declarations and definitions.

Package de.smartics.properties.report.app

Class de.smartics.properties.report.app.ReportException extends RuntimeException implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.report.data

Class de.smartics.properties.report.data.ReportProblem extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

message

String message

The message to the problem.

cause

Throwable cause

The optional root cause to the problem.

Package de.smartics.properties.resource.repository

Class de.smartics.properties.resource.repository.ArtifactId extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

groupId

String groupId

The group the artifact belongs to.

name

String name

The name of the artifact.

version

String version

The version of the artifact.

archiveType

String archiveType

The artifact type that is expressed by the artifact's file name extension.

classifier

String classifier

The classifier to the artifact. May be null.

Class de.smartics.properties.resource.repository.ArtifactRef extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

ArtifactId id

The unique identifier of the artifact.

url

URL url

The reference to the physical artifact.

Class de.smartics.properties.resource.repository.ClassPathEnvironment extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

index

Map<K,V> index

The map of artifact IDs (GAV concatenated and separated by colons) to the artifact references.

artifactRefs

List<E> artifactRefs

The list of artifact references found on this class path.

Class de.smartics.properties.resource.repository.RepositoryException extends PropertyRootException implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.spi.config.definition

Class de.smartics.properties.spi.config.definition.DefinitionKeyHelper extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

context

PropertiesDefinitionContext context

The context to evaluate the configuration keys from properties file paths.

Class de.smartics.properties.spi.config.definition.PropertiesDefinitionContext extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

tlds

Set<E> tlds

The collection of top-level-domains (tlds). Country codes (two letters) are not necessarily mentioned here since they are dealt with generically.

environments

Set<E> environments

The collection of registered environment names.

nodes

Set<E> nodes

The collection of registered node names.

groups

Set<E> groups

The collection of registered group names.

files

Map<K,V> files

The mapping of properties file path names to a associated configuration key.

Package de.smartics.properties.spi.config.domain

Class de.smartics.properties.spi.config.domain.ConfigurationPropertiesManagementProxy extends ConfigurationPropertiesProxy implements Serializable

serialVersionUID: 1L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Reads the object from the given stream.

Throws:

IOException - on read problems.

ClassNotFoundException - if a class cannot be found.

Class de.smartics.properties.spi.config.domain.ConfigurationPropertiesProxy extends Object implements Serializable

serialVersionUID: 1L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Reads the object from the given stream.

Throws:

IOException - on read problems.

ClassNotFoundException - if a class cannot be found.

Serialized Fields

key

ConfigurationKey key

The key of the configuration properties instance is to be associated with.

factory

ConfigurationPropertiesFactory factory

The factory to create instances of the configuration properties.

Package de.smartics.properties.spi.config.ds

Class de.smartics.properties.spi.config.ds.AbstractDataSourceDescriptor extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

table

String table

The name of the configuration table.

nameColumn

String nameColumn

The name of the property name column.

valueColumn

String valueColumn

The name of the property value column.

Class de.smartics.properties.spi.config.ds.DataSourceConfigurationPropertyProvider extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

configurationKey

ConfigurationKey configurationKey

The identifier of the configuration the provided properties are part of.

manager

PropertiesStore manager

The access to the properties of the data source.

Class de.smartics.properties.spi.config.ds.DataSourceException extends PropertyRootException implements Serializable

serialVersionUID: 1L

Serialized Fields

dataSourceId

String dataSourceId

The identifier of the data source. Usually this is the connection URL plus any other identifying information.

Class de.smartics.properties.spi.config.ds.DefaultDataSourceManager extends AbstractDataSourceDescriptor implements Serializable

serialVersionUID: 1L

Serialized Fields

dataSourceProxy

DataSourceProxy dataSourceProxy

The proxy to provide access to a data source.

initialProperties

Map<K,V> initialProperties

The properties to fill the database initially. May be null.

dropTable

boolean dropTable

Signals to drop the properties table before creation.

ignoreTableCreationProblems

boolean ignoreTableCreationProblems

The flag signals that any problems encountered on creating the table should be ignored. Useful if there are no means to check is a database table already exists.

createTableSqlStatement

String createTableSqlStatement

The SQL statement to create the configuration table.

Class de.smartics.properties.spi.config.ds.JndiDataSourceProxy extends Object implements Serializable

serialVersionUID: 1L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Reads the object from the given stream.

Throws:

IOException - on read problems.

ClassNotFoundException - if a class cannot be found.

Serialized Fields

mappedName

String mappedName

The JNDI name to access the data source.

Class de.smartics.properties.spi.config.ds.PropertiesStore extends DefaultDataSourceManager implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.spi.config.proxy

Class de.smartics.properties.spi.config.proxy.InvalidArgumentsException extends PropertiesException implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.spi.config.proxy.NotAPropertySetAnnotatedInterfaceException extends PropertiesException implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.spi.config.proxy.PropertiesException extends RuntimeException implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.spi.config.proxy.PropertiesProxyInvocationHandler extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

configurationProperties

SerializableConfigurationProperties configurationProperties

To access the properties.

Class de.smartics.properties.spi.config.proxy.PropertyMethodNotFoundException extends PropertiesException implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.spi.config.resolve

Class de.smartics.properties.spi.config.resolve.ConfigurationPropertiesResolveContext extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

registry

PropertyDescriptorRegistry registry

The registry to resolve property descriptors.

config

ConfigurationProperties config

The configuration to adapt.

Class de.smartics.properties.spi.config.resolve.NullValuePropertyException extends UnresolvablePropertyException implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.spi.config.resolve.RecursivePropertyException extends UnresolvablePropertyException implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.spi.config.resolve.ResolveConfigurationException extends ConfigurationException implements Serializable

serialVersionUID: 1L

Serialized Fields

expression

String expression

The expression that cannot be resolved.

Class de.smartics.properties.spi.config.resolve.UnresolvablePropertyException extends RuntimeException implements Serializable

serialVersionUID: 1L

Serialized Fields

propertyKey

String propertyKey

The key to the unresolvable property.

path

List<E> path

The path to the recursive point.

Package de.smartics.properties.spi.config.support

Class de.smartics.properties.spi.config.support.AbstractConfigurationPropertiesFactory extends Object implements Serializable

serialVersionUID: 1L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Reads the object from the given stream.

Throws:

IOException - on read problems.

ClassNotFoundException - if a class cannot be found.

Serialized Fields

rootLocations

List<E> rootLocations

The locations to search for property descriptors and definitions.

rootPropertyProviders

List<E> rootPropertyProviders

The properties provided by other means than being found on the class path.

While AbstractConfigurationPropertiesFactory.addRootLocations(Collection) and AbstractConfigurationPropertiesFactory.addRootLocations(URL...) allows to declare class path roots to search for properties files automatically, the root property provider allow access to properties that are stored in arbitrary locations and formats. These properties may be stored in databases or any other technology, as long as they provide the concept of key and value.

factoryConfiguration

FactoryConfiguration factoryConfiguration

The factory configuration.

registry

PropertyDescriptorRegistry registry

The registry of declarations used by all created configurations.

lock

ReentrantReadWriteLock lock

The lock for synchronized access.

readLock

Lock readLock

The read lock for synchronized access.

writeLock

Lock writeLock

The write lock for synchronized access.

Class de.smartics.properties.spi.config.support.AbstractInMemoryConfigurationProperties extends AbstractConfigurationPropertiesManagement implements Serializable

serialVersionUID: 1L

Serialized Fields

properties

InMemoryPropertiesManager properties

The management of the properties.

requiresDefaultOnClassPath

boolean 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.

Class de.smartics.properties.spi.config.support.BootConfigurationProperties extends AbstractInMemoryConfigurationProperties implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.spi.config.support.ConfigurationPropertiesManagementWithDefaults extends AbstractConfigurationProperties implements Serializable

serialVersionUID: 1L

Serialized Fields

configurationProperties

List<E> configurationProperties

The list of configuration properties to consult on requests.

Class de.smartics.properties.spi.config.support.InMemoryPropertiesManager extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

configurationKey

ConfigurationKey configurationKey

The key of the configuration whose properties are managed.

sourceId

PropertyLocation sourceId

The unique identifier of the property source.

propertiesKeyToValueMap

Map<K,V> propertiesKeyToValueMap

The map of properties key strings to their property instance.

support

PropertyChangeSupport support

Helper to handle property change listeners.

lock

ReentrantReadWriteLock lock

The lock for synchronized access to property values.

readLock

Lock readLock

The read lock for synchronized access to property values.

writeLock

Lock writeLock

The write lock for synchronized access to property values.

Class de.smartics.properties.spi.config.support.PropertiesPropertyProvider extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

configurationKey

ConfigurationKey configurationKey

The key of the configuration whose properties are provided.

sourceId

PropertyLocation sourceId

The unique identifier of the physical source of the properties.

properties

Properties properties

The wrapped properties.

Package de.smartics.properties.spi.config.validation

Class de.smartics.properties.spi.config.validation.ConfigurationValidator extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

configuration

ConfigurationPropertiesManagement configuration

The configuration to validate.

lenient

boolean lenient

The lenient flag that tells the validation process to handle unknown properties gracefully if set to true. If the value is false unknown properties are reported as validation failures.

Package de.smartics.properties.spi.core.constraint

Class de.smartics.properties.spi.core.constraint.AbstractPropertyConstraint extends Object implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.spi.core.constraint.jsr303

Class de.smartics.properties.spi.core.constraint.jsr303.GenericPropertyConstraint extends AbstractPropertyConstraint<T> implements Serializable

serialVersionUID: 1L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Reads the object from the given stream.

Throws:

IOException - on read problems.

ClassNotFoundException - if a class cannot be found.

Serialized Fields

constraintAnnotation

Annotation constraintAnnotation

The JSR-303 constraint annotation.

validatorClass

Class<T> validatorClass

Stores the validator class for serialization.

Package de.smartics.properties.spi.core.constraints

Class de.smartics.properties.spi.core.constraints.ListValueConstraint extends AbstractPropertyConstraint<List<?>> implements Serializable

serialVersionUID: 1L

Serialized Fields

elementType

Class<T> elementType

The type of the list elements.

minOccurs

Integer minOccurs

The minimum number of elements in the list. May be null if there is no constraint on the minimum number of elements.

maxOccurs

Integer maxOccurs

The maximum number of elements in the list. May be null if there is no constraint on the maximum number of elements.

elementConstraints

List<E> elementConstraints

The constraints on the individual elements of the list. May be empty, but is never null.

Class de.smartics.properties.spi.core.constraints.PropertyRangeConstraint extends AbstractPropertyConstraint<T> implements Serializable

serialVersionUID: 1L

Serialized Fields

valueRange

PropertyValueRange<T> valueRange

The list of valid properties.

A value of null tells that there is no range defined.

Package de.smartics.properties.spi.core.context

Class de.smartics.properties.spi.core.context.MandatoryPropertyContext extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

propertiesContext

PropertiesContext propertiesContext

The context of the properties.

descriptor

PropertyDescriptor descriptor

The descriptor of the property.

Class de.smartics.properties.spi.core.context.PropertyContextProxy extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

context

PropertiesContext context

The properties context to fetch information from the META-INF folder.

Package de.smartics.properties.spi.core.convert

Class de.smartics.properties.spi.core.convert.BeanUtilsPropertyValueConverter extends Object implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.spi.core.metadata

Class de.smartics.properties.spi.core.metadata.MetaInfDocumentMetaDataProxy extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

context

PropertiesContext context

The properties context to fetch information from the META-INF folder. May be null.

propertyMethod

SerializableMethod propertyMethod

The method to use to fetch annotations in case the context is not to be used.

metaData

Map<K,V> metaData

The cached comments.

Class de.smartics.properties.spi.core.metadata.PropertyCommentProxy extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

context

PropertiesContext context

The properties context to fetch information from the META-INF folder. May be null.

comments

Map<K,V> comments

The cached comments.

Class de.smartics.properties.spi.core.metadata.PropertyMetaData extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

contextProxy

PropertyContextProvider contextProxy

The context of the property descriptor.

declaringType

Class<T> declaringType

The type that declares the property that is described by this instance.

key

PropertyKey key

The key of the property. Must not be null.

type

PropertyType type

The type of the property value. Must not be null.

mandatory

boolean mandatory

The flag to determine whether or not the property value is mandatory to be specified. A property has a value if it is either specified explicitly or derived from the property expression.

accessType

AccessType accessType

The flag to define the access type.

updateIntervalInMs

long updateIntervalInMs

The update interval in milliseconds (ms).

An application may cache the value of the property for the given period of time.

value	description
< 0	Property is not mutable.
0	Property is required on each access.
> 0	Property is required to be read new after the given number of ms elapsed.

configurationTime

PropertyDefinitionTime configurationTime

The designed time the property is defined.

defaultExpression

PropertyExpression defaultExpression

The default expression to evaluate a default property value. May be null.

valueRange

PropertyValueRange<T> valueRange

The range of values allowed for this property.

constraints

List<E> constraints

The list of constraints a value for the property has to meet. May be empty, but is never null.

documentMetaDataProxy

DocumentMetaDataProxy documentMetaDataProxy

The meta data information for the property.

commentProxy

PropertyCommentProvider commentProxy

The comment to the property and its values.

Package de.smartics.properties.spi.core.metadata.comment

Class de.smartics.properties.spi.core.metadata.comment.CommentException extends RuntimeException implements Serializable

serialVersionUID: 1L

Serialized Fields

systemId

String systemId

The resource that cannot be read.

Package de.smartics.properties.spi.core.metadata.projectdoc

Class de.smartics.properties.spi.core.metadata.projectdoc.MetaDataException extends RuntimeException implements Serializable

serialVersionUID: 1L

Serialized Fields

systemId

String systemId

The resource that cannot be read.

Class de.smartics.properties.spi.core.metadata.projectdoc.ProjectdocMetaData extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

parent

ProjectdocMetaData parent

The reference to the parent meta data to access as default values.

categories

List<E> categories

The categories associated with the document instance.

tags

List<E> tags

The tags associated with the document instance.

parents

List<E> parents

The parents associated with the document instance.

audience

List<E> audience

The audience the documentation targets.

name

String name

The unique document identifier within the project. It is generated by the system if not given explicitly and may be expanded with context information to be unique.

space

String space

The space within which the title of a document is required to be unique.

title

String title

The title of a document, unique within the given space.

shortDescription

String shortDescription

The short description of the document to be incorporated in an overview table. Should not exceed one to three sentences.

summary

String summary

The short summary of contents of the document to give more detailed information to a potential reader. Should not exceed one too three paragraphs.

sortKey

String sortKey

The option to sort elements. This sort key is used first for sorting the document instances in the index document of this doctype.

notes

List<E> notes

The list of notes appended to the document instance.

Package de.smartics.properties.spi.core.registry

Class de.smartics.properties.spi.core.registry.ConfigurationRegistry extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

lock

ReentrantReadWriteLock lock

The lock for synchronized access to the context cache.

readLock

Lock readLock

The read lock for synchronized access to the context cache.

writeLock

Lock writeLock

The write lock for synchronized access to the context cache.

contexts

Map<K,V> contexts

Maps the properties context configuration information keyed by their archive path.

Class de.smartics.properties.spi.core.registry.InMemoryPropertyDescriptorRegistry extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

descriptors

com.google.common.collect.ArrayListMultimap<K,V> descriptors

The list of property descriptor types to their property descriptors.

descriptorMap

Map<K,V> descriptorMap

Fast access map to descriptors by their String keys. The key is the key of the property descriptor.

mandatoryProperties

List<E> mandatoryProperties

The list of mandatory properties.

configurationRegistry

ConfigurationRegistry configurationRegistry

The repository of properties configurations.

lock

ReentrantReadWriteLock lock

The lock for synchronized access to the context cache.

readLock

Lock readLock

The read lock for synchronized access to the context cache.

writeLock

Lock writeLock

The write lock for synchronized access to the context cache.

Package de.smartics.properties.spi.core.util

Class de.smartics.properties.spi.core.util.SerializableMethod extends Object implements Serializable

serialVersionUID: 1L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Reads the object from the given stream.

Throws:

IOException - on read problems.

ClassNotFoundException - if a class cannot be found.

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Method to write the object to the stream.

Throws:

IOException - on any write problem.

Package de.smartics.properties.spi.core.validate

Class de.smartics.properties.spi.core.validate.PropertyValidator extends Object implements Serializable

serialVersionUID: 1L

Package de.smartics.properties.spi.core.value

Class de.smartics.properties.spi.core.value.CollectionPropertyValueRange extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

valueRange

Map<K,V> valueRange

The values mapped by their string representation to their value instance.

Class de.smartics.properties.spi.core.value.EnumeratedPropertyValueRange extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

enumeration

Class<T> enumeration

The enumeration to provide the value for this range.

translator

de.smartics.properties.spi.core.value.EnumIdTranslator<T extends Enum<T>> translator

Translator that supports static fromString methods.