Class EncryptableProperties
- Object
-
- java.util.Dictionary<K,V>
-
- java.util.Hashtable<Object,Object>
-
- java.util.Properties
-
- org.jasypt.properties.EncryptableProperties
-
- All Implemented Interfaces:
java.io.Serializable
,Cloneable
,java.util.Map<Object,Object>
public final class EncryptableProperties extends java.util.Properties
Subclass of java.util.Properties which can make use of a
StringEncryptor
orTextEncryptor
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)
orgetProperty(String, String)
methods are called, and only these two methods perform decryption (note that neitherget(Object)
norProperties.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
- Author:
- Daniel Fernández
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EncryptableProperties(java.util.Properties defaults, StringEncryptor stringEncryptor)
Creates an EncryptableProperties instance which will use the passedStringEncryptor
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 passedTextEncryptor
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 passedStringEncryptor
object to decrypt encrypted values.EncryptableProperties(TextEncryptor textEncryptor)
Creates an EncryptableProperties instance which will use the passedTextEncryptor
object to decrypt encrypted values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
get(Object key)
Obtains the property value for the specified key (seeHashtable#get(Object)
), decrypting it if needed.String
getProperty(String key)
Obtains the property value for the specified key (seeProperties.getProperty(String)
), decrypting it if needed.String
getProperty(String key, String defaultValue)
Obtains the property value for the specified key (seeProperties.getProperty(String)
), decrypting it if needed.-
Methods inherited from class java.util.Properties
clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keys, keySet, list, list, load, load, loadFromXML, merge, propertyNames, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, save, setProperty, size, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, toString, values
-
-
-
-
Constructor Detail
-
EncryptableProperties
public EncryptableProperties(StringEncryptor stringEncryptor)
Creates an EncryptableProperties instance which will use the passed
StringEncryptor
object to decrypt encrypted values.- Parameters:
stringEncryptor
- theStringEncryptor
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
- theTextEncryptor
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
- theStringEncryptor
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
- theTextEncryptor
to be used do decrypt values. It can not be null.
-
-
Method Detail
-
getProperty
public String getProperty(String key)
Obtains the property value for the specified key (see
Properties.getProperty(String)
), decrypting it if needed.- Overrides:
getProperty
in classjava.util.Properties
- Parameters:
key
- the property key- Returns:
- the (decrypted) value
-
getProperty
public String getProperty(String key, 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 classjava.util.Properties
- Parameters:
key
- the property keydefaultValue
- the default value to return- Returns:
- the (decrypted) value
-
get
public Object get(Object key)
Obtains the property value for the specified key (see
Hashtable#get(Object)
), decrypting it if needed.- Specified by:
get
in interfacejava.util.Map<Object,Object>
- Overrides:
get
in classjava.util.Properties
- Parameters:
key
- the property key- Returns:
- the (decrypted) value
- Since:
- 1.9.0
-
-