org.alfresco.repo.node.encryption

Class MetadataEncryptor

java.lang.Object

org.alfresco.repo.node.encryption.MetadataEncryptor

public class MetadataEncryptor
extends Object

Component to convert encrypt/decrypt properties.

This is a helper; it is up to the client how and when encryption and decryption is done, but metadata integrity enforcement will expect that encrypted properties are already encrypted.

This class must always be used running as 'system'.

Since:

4.0

Author:

Derek Hulley

Constructor Summary

Constructors

Constructor and Description
MetadataEncryptor()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	backupKeyAvailable(String keyAlias)
Map<org.alfresco.service.namespace.QName,Serializable>	decrypt(Map<org.alfresco.service.namespace.QName,Serializable> inbound) Decrypt properties if they are decryptable.
Serializable	decrypt(org.alfresco.service.namespace.QName propertyQName, Serializable inbound) Decrypt a property if the data definition (model-specific) requires it.
Map<org.alfresco.service.namespace.QName,Serializable>	encrypt(Map<org.alfresco.service.namespace.QName,Serializable> inbound) Encrypt properties if their data definition (model-specific) requires it.
Serializable	encrypt(org.alfresco.service.namespace.QName propertyQName, Serializable inbound) Encrypt a properties if the data definition (model-specific) requires it.
boolean	keyAvailable(String keyAlias)
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setEncryptor(org.alfresco.encryption.FallbackEncryptor encryptor)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataEncryptor

public MetadataEncryptor()

Method Detail

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

Parameters:

dictionaryService - service to check if properties need encrypting

setEncryptor

public void setEncryptor(org.alfresco.encryption.FallbackEncryptor encryptor)

Parameters:

encryptor - the class that does the encryption/decryption

encrypt

public Serializable encrypt(org.alfresco.service.namespace.QName propertyQName,
                   Serializable inbound)

Encrypt a properties if the data definition (model-specific) requires it.

Parameters:

propertyQName - the property qualified name

inbound - the property to encrypt

Returns:

the encrypted property or the original if encryption is not required

decrypt

public Serializable decrypt(org.alfresco.service.namespace.QName propertyQName,
                   Serializable inbound)

Decrypt a property if the data definition (model-specific) requires it.

Parameters:

propertyQName - the property qualified name

inbound - the property to decrypt

Returns:

the decrypted property or the original if it wasn't encrypted

encrypt

public Map<org.alfresco.service.namespace.QName,Serializable> encrypt(Map<org.alfresco.service.namespace.QName,Serializable> inbound)

Encrypt properties if their data definition (model-specific) requires it. The values provided can be mixed; values will be encrypted only if required.

Parameters:

inbound - the properties to encrypt

Returns:

a new map of values if some encryption occured otherwise the original inbound map is returned

decrypt

public Map<org.alfresco.service.namespace.QName,Serializable> decrypt(Map<org.alfresco.service.namespace.QName,Serializable> inbound)

Decrypt properties if they are decryptable. The values provided can be mixed; encrypted values will be sought out and decrypted.

Parameters:

inbound - the properties to decrypt

Returns:

a new map of values if some decryption occured otherwise the original inbound map is returned

keyAvailable

public boolean keyAvailable(String keyAlias)

backupKeyAvailable

public boolean backupKeyAvailable(String keyAlias)