oracle.oud.custom

Interface DataEncryptionProvider

public interface DataEncryptionProvider

This interface defines a custom data encryption provider that can be implemented and plugged into OUD for handling data encryption. Implementation must provide a public sole constructor (no argument).

Method Summary

Modifier and Type	Method and Description
byte[]	decrypt(byte[] value) Decrypts given value as per the custom encryption logic.
byte[]	decryptIndexedValue(byte[] value) Decrypts given value as per the custom encryption logic.
byte[]	encrypt(byte[] value) Encrypts the given value as per the custom encryption logic.
byte[]	encryptForIndexing(byte[] value) Encrypts the given value as per the custom encryption logic.
default Logger	getLogger() Retrieve the logger to log messages into OUD instance's log files.
void	initialize() This method is called to initialize this custom provider.
void	setConfiguration(CustomProviderConfiguration config) This method is called to set the configuration of this custom provider.

Method Detail

encrypt

byte[] encrypt(byte[] value)
        throws CustomProviderException

Encrypts the given value as per the custom encryption logic.

Parameters:

value - to encrypt

Returns:

encrypted value

Throws:

CustomProviderException - in case of errors

decrypt

byte[] decrypt(byte[] value)
        throws CustomProviderException

Decrypts given value as per the custom encryption logic.

Parameters:

value - to decrypt

Returns:

decrypted value

Throws:

CustomProviderException - in case of errors

encryptForIndexing

byte[] encryptForIndexing(byte[] value)
                   throws CustomProviderException

Encrypts the given value as per the custom encryption logic. Indexed value are used during search to locate records. Hence the hash value for the index must always be the same for the search to work. This method is called to encrypt values stored in index tables.

Parameters:

value - to encrypt

Returns:

encrypted value

Throws:

CustomProviderException - in case of errors

decryptIndexedValue

byte[] decryptIndexedValue(byte[] value)
                    throws CustomProviderException

Decrypts given value as per the custom encryption logic. This method is called to encrypt values stored in index tables.

Parameters:

value - string to decrypt

Returns:

decrypted value

Throws:

CustomProviderException - in case of errors

getLogger

default Logger getLogger()

Retrieve the logger to log messages into OUD instance's log files.

Returns:

the logger instance.

initialize

void initialize()
         throws CustomProviderException

This method is called to initialize this custom provider.

Throws:

CustomProviderException - if it fails to initialize successfully.

setConfiguration

void setConfiguration(CustomProviderConfiguration config)
               throws CustomProviderException

This method is called to set the configuration of this custom provider.

Parameters:

config - the configuration of the custom provider.

Throws:

CustomProviderException - if the new configuration can not be applied.