org.forgerock.security.keystore

Class KeyStoreConfigurationManagerImpl

java.lang.Object

org.forgerock.security.keystore.KeyStoreConfigurationManagerImpl

All Implemented Interfaces:

KeyStoreConfigurationManager

public class KeyStoreConfigurationManagerImpl
extends Object
implements KeyStoreConfigurationManager

Implements a KeyStoreConfigurationManager using JSON serialization. The typical usage will be to open a JSON file in conf/keystore.json that contains the configurations for the various keystores the application may use. For example:

 {
    "default": {
      "comment": "Additional fields should be ignored. This is the default keystore implementation",
      "keyStoreFile": "keystore.pfx",
      "keyStorePasswordFile": "storepass",
      "keyStoreType": "PKCS12"
    },
    "legacy": {
      "comment": "Some legacy keystore",
      "keyStoreFile": "keystore.jks",
      "keyStorePasswordFile": "storepass",
      "keyStoreType": "JKS"
    },
    "opendj": {
        "comment": "opendj keystore",
         "providerName": "OpenDJ",
         "providerArg": "src/test/resources/keystore.conf",
         "keyStoreType": "LDAP",
         "providerClass": "org.forgerock.opendj.security.OpenDjSecurityProvider",
         "keyStorePasswordFile": "dj_storepass",
         "keyPasswordFile": "dj_storepass"
     }
 }
 

Constructor Summary

Constructors

Constructor and Description
KeyStoreConfigurationManagerImpl(InputStream jsonStream) Construct a KeyStoreConfigurationManager instance.
KeyStoreConfigurationManagerImpl(String fileName) Construct a KeyStoreConfigurationManager instance.

Method Summary

Modifier and Type	Method and Description
KeyStoreConfiguration	getKeyStoreConfiguration(String name) Return the KeyStore configuration for the given symbolic name.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyStoreConfigurationManagerImpl

public KeyStoreConfigurationManagerImpl(String fileName)
                                 throws IOException

Construct a KeyStoreConfigurationManager instance.

Parameters:

fileName - JSON file path that holds the keystore configuration

Throws:

IOException - If the configuration JSON can not be read

KeyStoreConfigurationManagerImpl

public KeyStoreConfigurationManagerImpl(InputStream jsonStream)
                                 throws IOException

Construct a KeyStoreConfigurationManager instance.

Parameters:

jsonStream - InputStream to an json object to be parsed.

Throws:

IOException - If the configuration JSON can not be read

Method Detail

getKeyStoreConfiguration

public KeyStoreConfiguration getKeyStoreConfiguration(String name)

Description copied from interface: KeyStoreConfigurationManager

Return the KeyStore configuration for the given symbolic name.

Specified by:

getKeyStoreConfiguration in interface KeyStoreConfigurationManager

Parameters:

name - The name of the keystore configuration. example: default, saml2, hsm, test-keystore

Returns:

KeyStoreConfiguration for this name, or null if no such configuration exists