Serialized Form

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

Class de.smartics.properties.api.core.app.AbstractBaseMessageBean extends de.smartics.exceptions.i18n.AbstractMessageBean implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.api.core.app.PropertyRootException extends de.smartics.exceptions.i18n.AbstractMessageRuntimeException 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 PropertyRootException implements Serializable

serialVersionUID: 2L

Class de.smartics.properties.api.core.domain.ConfigMessageBean extends AbstractBaseMessageBean implements Serializable

serialVersionUID: 1L

Serialized Fields

systemId

String systemId

The resource that cannot be read.

duplicateKeys

de.smartics.properties.api.core.domain.ConfigMessageBean.DuplicateKeys duplicateKeys

The two configuration keys where only one is allowed.

invalidNamespace

de.smartics.properties.api.core.domain.ConfigMessageBean.InvalidNamespace invalidNamespace

The namespaces that do not match.

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

serialVersionUID: 1L

Serialized Fields

name

String name

The name identifier of the document.

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

serialVersionUID: 2L

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

serialVersionUID: 1L

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.

exceptionsMessage

String exceptionsMessage

The summary of exception.

Class de.smartics.properties.api.core.domain.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.

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.PropertyCategories extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

categories

List<E> categories

The list of categories.

technical

boolean technical

The flag to indicate that at least one category is considered to tag the property as technical.

business

boolean business

The flag to indicate that at least one category is considered to tag the property as business.

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.PropertyDescriptorClashingMessageBean extends PropertyDescriptorMessageBean implements Serializable

serialVersionUID: 1L

Serialized Fields

clashingDescriptor

PropertyDescriptor clashingDescriptor

The clashing property descriptor with the same key.

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

serialVersionUID: 1L

Class de.smartics.properties.api.core.domain.PropertyDescriptorMessageBean extends PropertyMessageBean 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

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.PropertyExpressionMessageBean extends PropertyDescriptorMessageBean implements Serializable

serialVersionUID: 1L

Serialized Fields

expression

String expression

The expression that failed to be resolved.

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.PropertyMessageBean extends AbstractBaseMessageBean implements Serializable

serialVersionUID: 1L

Serialized Fields

propertyKey

PropertyKey propertyKey

The key of the property raising the exception.

Class de.smartics.properties.api.core.domain.PropertyProjectdoc extends ProjectdocMetaData implements Serializable

serialVersionUID: 1L

Serialized Fields

comment

PropertyComment comment

The property comment.

sourceInfo

SourceInfo sourceInfo

The information on the property's source code.

Class de.smartics.properties.api.core.domain.PropertySetProjectdoc extends ProjectdocMetaData implements Serializable

serialVersionUID: 1L

Serialized Fields

comment

String comment

The property set comment.

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

Class de.smartics.properties.api.core.domain.PropertyValidationMessageBean extends PropertyValueMessageBean implements Serializable

serialVersionUID: 1L

Serialized Fields

constraints

List<E> constraints

The property constraints that failed to be met.

Class de.smartics.properties.api.core.domain.PropertyValueChangeMessageBean extends PropertyDescriptorMessageBean 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.

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

Class de.smartics.properties.api.core.domain.PropertyValueMessageBean extends PropertyDescriptorMessageBean implements Serializable

serialVersionUID: 1L

Serialized Fields

value

Serializable value

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

valueType

String valueType

The type of the value if not null.

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

serialVersionUID: 1L

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

serialVersionUID: 1L

Package de.smartics.properties.api.core.security

Class de.smartics.properties.api.core.security.AbstractPropertyValueSecurity extends Object implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.api.core.security.Base64PropertyValueSecurity extends Object implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.api.core.security.PropertiesBasedPropertyValueSecurity extends AbstractPropertyValueSecurity implements Serializable

serialVersionUID: 1L

Serialized Fields

properties

Properties properties

The security properties to create key and cipher.

key

SecretKey key

The symmetric key to en- and decrypt property values.

Class de.smartics.properties.api.core.security.SecurityConfigurationLoader extends Object implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.api.core.security.SecurityException extends PropertyRootException implements Serializable

serialVersionUID: 1L

Class de.smartics.properties.api.core.security.SecurityMessageBean extends AbstractBaseMessageBean implements Serializable

serialVersionUID: 1L

Serialized Fields

securityPropertiesFile

String securityPropertiesFile

The path to the security properties file.

Class de.smartics.properties.api.core.security.SystemPropertyBasedPropertyValueSecurity extends AbstractPropertyValueSecurity implements Serializable

serialVersionUID: 1L

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

documentName

DocumentName documentName

The name of the document that identifies the document uniquely within the context of the project. It is used to select the projectdoc document in the META-INF folder.

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 property comments.

propertySetMetaData

Map<K,V> propertySetMetaData

The cached property set 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.

secured

boolean secured

The flag to determine whether or not the property value contains sensitive information that is required to be secured.

accessType

de.smartics.properties.api.core.annotations.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

de.smartics.properties.api.core.annotations.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.

categories

PropertyCategories categories

The categories the property is associated with.

useType

de.smartics.properties.api.core.annotations.PropertyUse.UseType useType

The use type of the property.

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.AnnotationHelper extends Object implements Serializable

serialVersionUID: 1L

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.

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

Serialized Fields

adminMode

boolean adminMode

The switch to turn validation into administration mode. In administration mode the validation allows to deal with properties not allowed in management mode. E.g. mandatory property are allowed to be unset in administration, but not in management mode.

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.