EncryptionProvider interface

Reference for the interface implemented by encryption providers.

public interface com.ibm.iis.spi.security.crypto.EncryptionProvider

The encrypt and decrypt methods are the encryption and decryption methods for the provider.

The getAlias method must return a short name (usually an acronym) that uniquely identifies the encryption provider. This alias can be used by callers to mark the encrypted data with a prefix in braces ({}) to determine which provider was used to encrypt the data. IBM® InfoSphere® Information Server uses the standard Java™ service provider mechanism to load the encryption provider from the classpath. Therefore, the META-INF/services/com.ibm.iis.spi.security.crypto.EncryptionProvider configuration file must be created and bundled. The location of the JAR file to use for compilation is IS_install_path/ASBNode/eclipse/plugins/com.ibm.iis.client/iis_util.jar. See the Java documentation for information about service providers.

Method summary

Returns Method
byte[]
decrypt(byte[] encryptedBytes)
The decrypt method takes an encrypted array of bytes and returns a decrypted array of bytes.
byte[]
encrypt(byte[] clearBytes)
The encrypt method takes an array of bytes and returns an encrypted array of bytes.
java.lang.String
getAlias()
Returns the encryption provider alias.
void
initialize(java.util.HashMap initData)
Reserved for future use.

Method detail

getAlias
getAlias()

Returns the encryption provider alias. The encryption provider alias is alphanumeric ASCII characters, which can contain only [0-9][a-z][A-Z]. It must uniquely identify the encryption provider. The return value of this method is used by callers to prefix the encrypted data with {alias_value}. The alias itself cannot contain opening brace ({) or closing brace (}) characters.

Returns:

String

initialize
initialize(java.util.HashMap initData) throws InitializationException

Reserved for future use.

Parameters:

java.util.HashMap - initData

Throws:

InitializationException

encrypt
encrypt(byte[] clearBytes)

The encrypt method takes an array of bytes and returns an encrypted array of bytes.

Parameters:

byte[] - clearBytes

Returns:

byte[]

decrypt
decrypt(byte[] encryptedBytes)

The decrypt method takes an encrypted array of bytes and returns a decrypted array of bytes.

Parameters:

byte[] - encryptedBytes

Returns:

byte[]