com.ibm.websphere.crypto

Interface KeyGenerator

public interface KeyGenerator

This interface defines the method to generate a java.security.Key. When a keyGeneration class implements this method, the generateKey method will be called and a Key will be stored in the keystore.

Since:

WAS 6.1

Version:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
java.security.Key	generateKey() This method will be called whenever a key needs to be generated either from the schedule or manually requested.
void	init(java.util.Properties customProps) This method will be called to pass any custom properties configured with the KeySet to the implementation of this interface.

Method Detail

init

void init(java.util.Properties customProps)

This method will be called to pass any custom properties configured with the KeySet to the implementation of this interface.

Parameters:

java.util.Properties -

generateKey

java.security.Key generateKey()
                              throws KeyException

This method will be called whenever a key needs to be generated either from the schedule or manually requested. The key will be stored in the KeyStore referenced by the configured KeySet which contains the keyGenerationClass implementing this interface. The implementation of this interface will manage the type of the key. The user of the KeySet should also know the type that will be returned by this keyGenerationClass.

Returns:

java.security.Key

Throws:

KeyException