com.mulesoft.mule.runtime.gw.policies.encryption.encrypter

Class PolicyTypeEncrypter<T>

java.lang.Object

com.mulesoft.mule.runtime.gw.policies.encryption.encrypter.PolicyTypeEncrypter<T>

Direct Known Subclasses:

KeyvalueEncrypter, ListOfKeyvaluesEncrypter, ListOfStringsEncrypter, NullEncrypter, StringEncrypter

public abstract class PolicyTypeEncrypter<T>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	TEMPLATE_PREFIX
protected static String	TEMPLATE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
PolicyTypeEncrypter(com.mulesoft.mule.runtime.gw.internal.encryption.RuntimeEncrypter runtimeEncrypter, boolean isSensitiveOnlyEnabled, List<PolicyProperty> policyProperties)

Method Summary

Modifier and Type	Method and Description
protected String	decrypt(String value) Decrypts a single value.
protected abstract EncryptedValueResult	decryptSingle(String key, T value) Decrypts the given value if it is encrypted.
protected String	encrypt(String value) Encrypts a single value.
EncryptedValueResult	encrypt(String key, T value) Depending on configuration and value metadata, it encrypts or decrypts (if already encrypted) the given config data value
protected abstract EncryptedValueResult	encryptSingle(String key, T value) Encrypts the given value
boolean	supports(String key) Whether this encrypter supports treating the given key
protected abstract boolean	supports(String key, Optional<PolicyProperty> property)

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_PREFIX

protected static final String TEMPLATE_PREFIX

See Also:

Constant Field Values

TEMPLATE_SUFFIX

protected static final String TEMPLATE_SUFFIX

See Also:

Constant Field Values

Constructor Detail

PolicyTypeEncrypter

public PolicyTypeEncrypter(com.mulesoft.mule.runtime.gw.internal.encryption.RuntimeEncrypter runtimeEncrypter,
                           boolean isSensitiveOnlyEnabled,
                           List<PolicyProperty> policyProperties)

Method Detail

supports

public boolean supports(String key)

Whether this encrypter supports treating the given key

Parameters:

key - the key of the config data value that needs to be treated

Returns:

true if it can be treated

encrypt

public EncryptedValueResult encrypt(String key,
                                    T value)

Depending on configuration and value metadata, it encrypts or decrypts (if already encrypted) the given config data value

Parameters:

key - the key of the config data value

value - the actual value to encrypt or decrypt

Returns:

an EncryptedValueResult containing the result of the process

encryptSingle

protected abstract EncryptedValueResult encryptSingle(String key,
                                                      T value)

Encrypts the given value

Parameters:

key - the key of the config data value

value - the actual value to encrypt or decrypt

Returns:

an EncryptedValueResult containing the result of the process

decryptSingle

protected abstract EncryptedValueResult decryptSingle(String key,
                                                      T value)

Decrypts the given value if it is encrypted. It does nothing to it if it is not

Parameters:

key - the key of the config data value

value - the actual value to encrypt or decrypt

Returns:

an EncryptedValueResult containing the result of the process

supports

protected abstract boolean supports(String key,
                                    Optional<PolicyProperty> property)

encrypt

protected String encrypt(String value)

Encrypts a single value.

Parameters:

value - The value that might be encrypted. It must be unescaped before encryption.

Returns:

The value encypted (that may be the same as value)

decrypt

protected String decrypt(String value)

Decrypts a single value.

Parameters:

value - The value that should be decrypted. This may be already encrypted or not. If it is not encrypted (the value is not between ![value] the decrypting function will leave the value untouched. In case of it being encrypted, it will try to decrypt it. In both cases, and same as before encryption, it should be unescaped to get the original value and avoid invalid characters when filling the template.

Returns:

The value decrypted (that may be the same as value)