Package org.refcodes.configuration.ext.obfuscation

Class ObfuscationPropertiesBuilderDecorator

java.lang.Object

org.refcodes.configuration.AbstractPropertiesDecorator<T>

org.refcodes.configuration.AbstractPropertiesBuilderDecorator<org.refcodes.configuration.Properties.PropertiesBuilder>

org.refcodes.configuration.ext.obfuscation.AbstractObfuscationPropertiesBuilderDecorator

org.refcodes.configuration.ext.obfuscation.ObfuscationPropertiesBuilderDecorator

All Implemented Interfaces:

Map<String,String>, ObfuscationProperties, ObfuscationProperties.MutableObfuscationProperties, ObfuscationProperties.ObfuscationPropertiesBuilder, org.refcodes.configuration.Properties, org.refcodes.configuration.Properties.MutableProperties, org.refcodes.configuration.Properties.PropertiesBuilder, org.refcodes.mixin.DecryptPrefixAccessor, org.refcodes.mixin.DecryptPrefixAccessor.DecryptPrefixBuilder<ObfuscationProperties.ObfuscationPropertiesBuilder>, org.refcodes.mixin.DecryptPrefixAccessor.DecryptPrefixMutator, org.refcodes.mixin.DecryptPrefixAccessor.DecryptPrefixProperty, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EncryptPrefixAccessor, org.refcodes.mixin.EncryptPrefixAccessor.EncryptPrefixBuilder<ObfuscationProperties.ObfuscationPropertiesBuilder>, org.refcodes.mixin.EncryptPrefixAccessor.EncryptPrefixMutator, org.refcodes.mixin.EncryptPrefixAccessor.EncryptPrefixProperty, org.refcodes.mixin.TypeAccessor<String>, org.refcodes.structure.CanonicalMap, org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap, org.refcodes.structure.Clearable, org.refcodes.structure.Containable, org.refcodes.structure.Dictionary<String,String>, org.refcodes.structure.Dictionary.MutableDictionary<String,String>, org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.PathMap.PathMapBuilder<String>>, org.refcodes.structure.Keys<String,String>, org.refcodes.structure.Keys.MutableKeys<String,String>, org.refcodes.structure.Keys.MutableValues<String,String>, org.refcodes.structure.PathMap<String>, org.refcodes.structure.PathMap.MutablePathMap<String>, org.refcodes.structure.PathMap.PathMapBuilder<String>, org.refcodes.structure.PropertiesAccessorMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

public class ObfuscationPropertiesBuilderDecorator
extends AbstractObfuscationPropertiesBuilderDecorator
implements ObfuscationProperties.ObfuscationPropertiesBuilder

The ObfuscationPropertiesBuilderDecorator represents a decorator for Properties.PropertiesBuilder instances by implementing the ObfuscationProperties.ObfuscationPropertiesBuilder interface. Properties marked in the resource as "to be decrypted" are decrypted (e.g. with a host individual key). Those encrypted properties are decrypted "on-the-fly" (in memory only) upon accessing the according property. Retrieving a value via AbstractObfuscationPropertiesBuilderDecorator.get(Object) (or the like), which is prefixed with "decrypt:" (default), will be decrypted accordingly before passed back to the caller. The prefix may be changed by invoking the according implementaion's constructor or the according methods. Properties marked in the resource as "to be encrypted" by being prefixed with "encrypt:" (default) are encrypted (e.g. with a host individual key) when being added and instead are prefixed with "decrypt:" (default). Retrieving a value via AbstractObfuscationPropertiesBuilderDecorator.get(Object) (or the like), which is prefixed with "decrypt:" (default), will be decrypted accordingly before passed back to the caller. The prefix may be changed by invoking the according implementaion's constructor. By default (if not configured otherwise) the prefix Prefix.DECRYPT is used as decrypt prefix (as of Prefix.getPrefix()). Also by default (if not configured otherwise) the prefix Prefix.ENCRYPT is used as encrypt prefix (as of Prefix.getPrefix()) constructor or the according methods.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.structure.CanonicalMap

org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Nested classes/interfaces inherited from interface org.refcodes.mixin.DecryptPrefixAccessor

org.refcodes.mixin.DecryptPrefixAccessor.DecryptPrefixBuilder<B extends org.refcodes.mixin.DecryptPrefixAccessor.DecryptPrefixBuilder<B>>, org.refcodes.mixin.DecryptPrefixAccessor.DecryptPrefixMutator, org.refcodes.mixin.DecryptPrefixAccessor.DecryptPrefixProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.DelimiterAccessor

org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary

org.refcodes.structure.Dictionary.MutableDictionary<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary.MutableDictionary

org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K extends Object,V extends Object,B extends org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>

Nested classes/interfaces inherited from interface org.refcodes.mixin.EncryptPrefixAccessor

org.refcodes.mixin.EncryptPrefixAccessor.EncryptPrefixBuilder<B extends org.refcodes.mixin.EncryptPrefixAccessor.EncryptPrefixBuilder<B>>, org.refcodes.mixin.EncryptPrefixAccessor.EncryptPrefixMutator, org.refcodes.mixin.EncryptPrefixAccessor.EncryptPrefixProperty

Nested classes/interfaces inherited from interface org.refcodes.configuration.ext.obfuscation.ObfuscationProperties

ObfuscationProperties.MutableObfuscationProperties, ObfuscationProperties.ObfuscationPropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.structure.PathMap

org.refcodes.structure.PathMap.MutablePathMap<T extends Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.configuration.Properties

org.refcodes.configuration.Properties.MutableProperties, org.refcodes.configuration.Properties.PropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.structure.PropertiesAccessorMixin

org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T extends Object>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

Field Summary

Fields inherited from class org.refcodes.configuration.ext.obfuscation.AbstractObfuscationPropertiesBuilderDecorator

_decryptPrefix, _encryptPrefix

Fields inherited from interface org.refcodes.configuration.Properties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor	Description
ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties)	Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality.
ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties, String aSecret)	Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality.
ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties, String aDecryptPrefix, String aEncryptPrefix)	Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality.
ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties, String aDecryptPrefix, String aEncryptPrefix, String aSecret)	Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality.
ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties, String aDecryptPrefix, String aEncryptPrefix, org.refcodes.runtime.SystemContext aObfuscationMode)	Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality.
ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties, org.refcodes.runtime.SystemContext aObfuscationMode)	Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality.

Method Summary

Methods inherited from class org.refcodes.configuration.ext.obfuscation.AbstractObfuscationPropertiesBuilderDecorator

encryptAll, encryptSet, get, getDecryptPrefix, getEncryptPrefix, put, setDecryptPrefix, setEncryptPrefix

Methods inherited from class org.refcodes.configuration.AbstractPropertiesBuilderDecorator

clear, containsValue, entrySet, putAll, remove

Methods inherited from class org.refcodes.configuration.AbstractPropertiesDecorator

childrenOf, containsKey, getDelimiter, getProperties, isEmpty, keySet, retrieveFrom, retrieveTo, setProperties, size, toDataStructure, values

Methods inherited from interface org.refcodes.structure.CanonicalMap

toInstance, toInstance, toType, toType

Methods inherited from interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

withInsert, withInsert, withInsertFrom, withInsertTo

Methods inherited from interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

insert, insert, insertFrom, insertTo, putAll, toDump, toSourceCode, toSourceCode

Methods inherited from interface org.refcodes.structure.Clearable

clear

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

Methods inherited from interface org.refcodes.mixin.DecryptPrefixAccessor

getDecryptPrefix

Methods inherited from interface org.refcodes.mixin.DecryptPrefixAccessor.DecryptPrefixMutator

setDecryptPrefix

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump

Methods inherited from interface org.refcodes.mixin.EncryptPrefixAccessor

getEncryptPrefix

Methods inherited from interface org.refcodes.mixin.EncryptPrefixAccessor.EncryptPrefixMutator

setEncryptPrefix

Methods inherited from interface org.refcodes.structure.Keys.MutableValues

put

Methods inherited from interface org.refcodes.configuration.ext.obfuscation.ObfuscationProperties.ObfuscationPropertiesBuilder

withDecryptPrefix, withEncryptPrefix, withInsert, withInsert, withInsertFrom, withInsertTo, withPut, withPut, withPutBoolean, withPutByte, withPutDouble, withPutFloat, withPutInteger, withPutLong, withPutShort, withRemoveFrom

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.structure.PathMap

directories, directories, entries, entries, fromExternalKey, getArray, getArray, getRootPath, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath

Methods inherited from interface org.refcodes.structure.PathMap.MutablePathMap

insert, insert, insert, insert, insertFrom, insertFrom, insertTo, insertTo, put, putArray, putArray, removeAll

Methods inherited from interface org.refcodes.structure.PathMap.PathMapBuilder

withInsert, withInsert, withInsertFrom, withInsertTo

Methods inherited from interface org.refcodes.configuration.Properties

childrenOf, getDelimiter, getType, retrieve, retrieveFrom, retrieveTo, toMap, toProperties, toPropertyPath

Methods inherited from interface org.refcodes.configuration.Properties.MutableProperties

containsValue, delete, delete, insert, insert, insertFrom, insertTo, put, putAll, putAll, putAll

Methods inherited from interface org.refcodes.configuration.Properties.PropertiesBuilder

withInsert, withInsert, withInsertFrom, withInsertTo

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

containsKey, get, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin

withPut

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

put, put, putBoolean, putBoolean, putByte, putByte, putDouble, putDouble, putFloat, putFloat, putInteger, putInteger, putLong, putLong, putShort, putShort

Constructor Detail

ObfuscationPropertiesBuilderDecorator

public ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties)

Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality. Changes applied to the provided Properties.PropertiesBuilder affect the decorator. A host specific secret is used to encrypt and decrypt the according properties.

Parameters:

aProperties - The Properties.PropertiesBuilder to be decorated.

ObfuscationPropertiesBuilderDecorator

public ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties,
                                             String aDecryptPrefix,
                                             String aEncryptPrefix)

Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality. Changes applied to the provided Properties.PropertiesBuilder affect the decorator. A host specific secret is used to encrypt and decrypt the according properties.

Parameters:

aProperties - The Properties.PropertiesBuilder to be decorated.

aDecryptPrefix - The decrypt prefix to be used for values which are to be decrypted, e.g. "decrypt:".

aEncryptPrefix - The decrypt prefix to be used. for values which are to be encrypted, e.g. "encrypt:".

ObfuscationPropertiesBuilderDecorator

public ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties,
                                             String aDecryptPrefix,
                                             String aEncryptPrefix,
                                             org.refcodes.runtime.SystemContext aObfuscationMode)

Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality. Changes applied to the provided Properties affect the decorator. A host specific secret is used to encrypt and decrypt the according properties.

Parameters:

aProperties - The Properties.PropertiesBuilder to be decorated.

aDecryptPrefix - The decrypt prefix to be used for values which are to be decrypted, e.g. "decrypt:".

aEncryptPrefix - The decrypt prefix to be used. for values which are to be encrypted, e.g. "encrypt:".

aObfuscationMode - The SystemContext specifies which level of obfuscation is to be used when encountering upon obfuscated properties: E.g. obfuscation may be bound to the host, the "secret" used for obfuscation being the same for all applications on the same host or obfuscation may be bound to the application, being different for different applications on the same host.

ObfuscationPropertiesBuilderDecorator

public ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties,
                                             String aDecryptPrefix,
                                             String aEncryptPrefix,
                                             String aSecret)

Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality. Changes applied to the provided Properties.PropertiesBuilder affect the decorator. The given secret is used to encrypt and decrypt the according properties.

Parameters:

aProperties - The Properties to be decorated.

aDecryptPrefix - The decrypt prefix to be used for values which are to be decrypted, e.g. "decrypt:".

aEncryptPrefix - The decrypt prefix to be used. for values which are to be encrypted, e.g. "encrypt:".

aSecret - The secret to use when encrypting and decrypting the according properties.

ObfuscationPropertiesBuilderDecorator

public ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties,
                                             org.refcodes.runtime.SystemContext aObfuscationMode)

Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality. Changes applied to the provided Properties affect the decorator. A host specific secret is used to encrypt and decrypt the according properties.

Parameters:

aProperties - The Properties.PropertiesBuilder to be decorated.

aObfuscationMode - The SystemContext specifies which level of obfuscation is to be used when encountering upon obfuscated properties: E.g. obfuscation may be bound to the host, the "secret" used for obfuscation being the same for all applications on the same host or obfuscation may be bound to the application, being different for different applications on the same host.

ObfuscationPropertiesBuilderDecorator

public ObfuscationPropertiesBuilderDecorator(org.refcodes.configuration.Properties.PropertiesBuilder aProperties,
                                             String aSecret)

Decorates the provided Properties.PropertiesBuilder with additional ObfuscationProperties.ObfuscationPropertiesBuilder behavior or functionality. Changes applied to the provided Properties.PropertiesBuilder affect the decorator. The given secret is used to encrypt and decrypt the according properties.

Parameters:

aProperties - The Properties to be decorated.

aSecret - The secret to use when encrypting and decrypting the according properties.