org.jasypt.properties

Class EncryptableProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

org.jasypt.properties.EncryptableProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public final class EncryptableProperties
extends java.util.Properties

Subclass of java.util.Properties which can make use of a StringEncryptor or TextEncryptor object to decrypt property values if they are encrypted in the .properties file.

A value is considered "encrypted" when it appears surrounded by ENC(...), like:

my.value=ENC(!"DGAS24FaIO$)

Decryption is performed on-the-fly when the getProperty(String) or getProperty(String, String) methods are called, and only these two methods perform decryption (note that neither get(Object) nor Hashtable.toString() do). Load and store operations are not affected by decryption in any manner.

Encrypted and unencrypted objects can be combined in the same properties file.

Please note that, altough objects of this class are Serializable, they cannot be serialized and then de-serialized in different classloaders or virtual machines. This is so because encryptors are not serializable themselves (they cannot, as they contain sensitive information) and so they remain in memory, and live for as long as the classloader lives.

Since:

1.4

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Integer	ident
private static long	serialVersionUID
private StringEncryptor	stringEncryptor
private TextEncryptor	textEncryptor

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
EncryptableProperties(java.util.Properties defaults, StringEncryptor stringEncryptor) Creates an EncryptableProperties instance which will use the passed StringEncryptor object to decrypt encrypted values, and the passed defaults as default values (may contain encrypted values).
EncryptableProperties(java.util.Properties defaults, TextEncryptor textEncryptor) Creates an EncryptableProperties instance which will use the passed TextEncryptor object to decrypt encrypted values, and the passed defaults as default values (may contain encrypted values).
EncryptableProperties(StringEncryptor stringEncryptor) Creates an EncryptableProperties instance which will use the passed StringEncryptor object to decrypt encrypted values.
EncryptableProperties(TextEncryptor textEncryptor) Creates an EncryptableProperties instance which will use the passed TextEncryptor object to decrypt encrypted values.

Method Summary

Modifier and Type	Method and Description
private java.lang.String	decode(java.lang.String encodedValue)
java.lang.Object	get(java.lang.Object key) Obtains the property value for the specified key (see Hashtable#get(Object)), decrypting it if needed.
(package private) java.lang.Integer	getIdent()
java.lang.String	getProperty(java.lang.String key) Obtains the property value for the specified key (see Properties.getProperty(String)), decrypting it if needed.
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) Obtains the property value for the specified key (see Properties.getProperty(String)), decrypting it if needed.
private void	readObject(java.io.ObjectInputStream in)
private void	writeObject(java.io.ObjectOutputStream outputStream)

Methods inherited from class java.util.Properties

list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

ident

private final java.lang.Integer ident

stringEncryptor

private transient StringEncryptor stringEncryptor

textEncryptor

private transient TextEncryptor textEncryptor

Constructor Detail

EncryptableProperties

public EncryptableProperties(StringEncryptor stringEncryptor)

Creates an EncryptableProperties instance which will use the passed StringEncryptor object to decrypt encrypted values.

Parameters:

stringEncryptor - the StringEncryptor to be used do decrypt values. It can not be null.

EncryptableProperties

public EncryptableProperties(TextEncryptor textEncryptor)

Creates an EncryptableProperties instance which will use the passed TextEncryptor object to decrypt encrypted values.

Parameters:

textEncryptor - the TextEncryptor to be used do decrypt values. It can not be null.

EncryptableProperties

public EncryptableProperties(java.util.Properties defaults,
                             StringEncryptor stringEncryptor)

Creates an EncryptableProperties instance which will use the passed StringEncryptor object to decrypt encrypted values, and the passed defaults as default values (may contain encrypted values).

Parameters:

defaults - default values for properties (may be encrypted).

stringEncryptor - the StringEncryptor to be used do decrypt values. It can not be null.

EncryptableProperties

public EncryptableProperties(java.util.Properties defaults,
                             TextEncryptor textEncryptor)

Creates an EncryptableProperties instance which will use the passed TextEncryptor object to decrypt encrypted values, and the passed defaults as default values (may contain encrypted values).

Parameters:

defaults - default values for properties (may be encrypted).

textEncryptor - the TextEncryptor to be used do decrypt values. It can not be null.

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String key)

Obtains the property value for the specified key (see Properties.getProperty(String)), decrypting it if needed.

Overrides:

getProperty in class java.util.Properties

Parameters:

key - the property key

Returns:

the (decrypted) value

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defaultValue)

Obtains the property value for the specified key (see Properties.getProperty(String)), decrypting it if needed.

If no value is found for the specified key, the default value will be returned (decrypted if needed).

Overrides:

getProperty in class java.util.Properties

Parameters:

key - the property key

defaultValue - the default value to return

Returns:

the (decrypted) value

get

public java.lang.Object get(java.lang.Object key)

Obtains the property value for the specified key (see Hashtable#get(Object)), decrypting it if needed.

Specified by:

get in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

get in class java.util.Hashtable<java.lang.Object,java.lang.Object>

Parameters:

key - the property key

Returns:

the (decrypted) value

Since:

1.9.0

getIdent

java.lang.Integer getIdent()

decode

private java.lang.String decode(java.lang.String encodedValue)

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeObject

private void writeObject(java.io.ObjectOutputStream outputStream)
                  throws java.io.IOException

Throws:

java.io.IOException