org.forgerock.openam.keystore

Class KeyStoreConfig

java.lang.Object

org.forgerock.openam.keystore.KeyStoreConfig

public class KeyStoreConfig
extends Object

Holds a Keystore Configuration. This gets serialized to/from JSON as part of boot.json

todo: This functionality should be moved into the commons project There is just enough functionality here to support OpenAM boot.json

Since:

14.0

Constructor Summary

Constructors

Constructor and Description
KeyStoreConfig()

Method Summary

Modifier and Type	Method and Description
char[]	getKeyPassword() Get the key password used to unlock key entries.
String	getKeyPasswordFile() Get the path the key password file.
String	getKeyStoreFile() Get the path to the keystore.
char[]	getKeyStorePassword() Get the keystore password.
String	getKeyStorePasswordFile() Get the path to the file used to unlock the keystore.
String	getKeyStoreType() Get the keystore type.
String	getProviderArg() Get the provider class name as a string.
String	getProviderClass() Get the provider class name string.
KeyStore	loadKeyStore() Initialize and load the keystore described by this configuration todo: This is just enough to get the current keystore.jceks opened When this is moved to commons the functionality should be expanded to open all keystore types There are a number of possible exceptions that can be generated - they are consolidated to a single type and the underlying exception is wrapped.
void	setKeyPasswordFile(String keyPasswordFile) Set the path the file that holds the per entry password.
void	setKeyStoreFile(String keyStoreFile) Set the keystore file path.
void	setKeyStorePasswordFile(String keyStorePasswordFile) Set path the file that contains the password used to unlock the keystore.
void	setKeyStoreType(String keyStoreType) Set the keystore type (e.g.
void	setProviderArg(String providerArg) Set provider arg.
void	setProviderClass(String providerClass) set the provider class name string.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyStoreConfig

public KeyStoreConfig()

Method Detail

getKeyStorePasswordFile

public String getKeyStorePasswordFile()

Get the path to the file used to unlock the keystore.

Returns:

Path to file that holds the password to unlock the keystore

setKeyStorePasswordFile

public void setKeyStorePasswordFile(String keyStorePasswordFile)

Set path the file that contains the password used to unlock the keystore.

Parameters:

keyStorePasswordFile - path to keystore password file

getKeyPasswordFile

public String getKeyPasswordFile()

Get the path the key password file.

Returns:

path to file that contains password to unlock individual key entries

setKeyPasswordFile

public void setKeyPasswordFile(String keyPasswordFile)

Set the path the file that holds the per entry password.

Parameters:

keyPasswordFile - set the path to file that holds the per key password

getKeyStoreType

public String getKeyStoreType()

Get the keystore type.

Returns:

the keystore type (JKS, JCEKS , etc. )

setKeyStoreType

public void setKeyStoreType(String keyStoreType)

Set the keystore type (e.g. JKS, JCEKS, ).

Parameters:

keyStoreType - set the keystore type

getKeyStoreFile

public String getKeyStoreFile()

Get the path to the keystore.

Returns:

The keystore file (example: /tmp/keystore.jceks )

setKeyStoreFile

public void setKeyStoreFile(String keyStoreFile)

Set the keystore file path.

Parameters:

keyStoreFile - the keystore file path

getProviderClass

public String getProviderClass()

Get the provider class name string. This is optional for providers.

Returns:

The provider class

setProviderClass

public void setProviderClass(String providerClass)

set the provider class name string.

Parameters:

providerClass - - provider class. This is optional for most providers

getProviderArg

public String getProviderArg()

Get the provider class name as a string.

Returns:

optional provider argument

setProviderArg

public void setProviderArg(String providerArg)

Set provider arg.

Parameters:

providerArg - optional provider arument used to create provider instances

getKeyStorePassword

public char[] getKeyStorePassword()
                           throws IOException

Get the keystore password.

Returns:

The keystore password as a char array

Throws:

IOException - IF the keystore password file can not be opened

getKeyPassword

public char[] getKeyPassword()
                      throws IOException

Get the key password used to unlock key entries.

Returns:

The key password as a char array

Throws:

IOException - If the key password file can not be opened

loadKeyStore

public KeyStore loadKeyStore()
                      throws KeyStoreException

Initialize and load the keystore described by this configuration todo: This is just enough to get the current keystore.jceks opened When this is moved to commons the functionality should be expanded to open all keystore types There are a number of possible exceptions that can be generated - they are consolidated to a single type and the underlying exception is wrapped.

Returns:

the opened KeyStore

Throws:

KeyStoreException - if the keystore can not be opened or initialized.