Module datarush.commons

Package com.pervasive.datarush.encryption

Interface EncryptionProvider

All Known Implementing Classes:

ClearTextEncryptionProvider, DefaultEncryptionProvider

public interface EncryptionProvider

A provider of textual encryption. Encryption providers are used to provide a basic level of encryption for sensitive information. Currently, they are used to encrypt Password's and PrivateKey's within when encoding to JSON. Providers must be registered by creating a file META-INF/services/com.pervasive.datarush.encryption.EncryptionProvider that contains the name of implementation class. Providers are identified by their providerID. The providerID is always captured on on serialization in order to be able to find the correct provider to decrypt upon deserialization.

Method Summary

Modifier and Type	Method	Description
String	decrypt(String string)	Decrypts a given string.
String	encrypt(String string)	Encrypts the given string.
String	getProviderID()	Returns a unique identifier for this provider

Method Detail

getProviderID

String getProviderID()

Returns a unique identifier for this provider

Returns:

the unique identifer for this provider

encrypt

String encrypt(String string)

Encrypts the given string. The encrypted form may consist of any string format.

Parameters:

string - the clear text

Returns:

the encrypted text

decrypt

String decrypt(String string)

Decrypts a given string. This method must be able to decrypt any string produced by encrypt(String).

Parameters:

string - the string to decrypt

Returns:

the clear text