org.lightningj.paywall.keymgmt

Class FileKeyManager

java.lang.Object

org.lightningj.paywall.keymgmt.FileKeyManager

All Implemented Interfaces:

KeyManager

Direct Known Subclasses:

DefaultFileKeyManager

public abstract class FileKeyManager
extends java.lang.Object
implements KeyManager

Base File Key Manager manages keys stored on disk. Created by Philip Vendil on 2018-09-15.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.logging.Logger	log

Constructor Summary

Constructors

Constructor and Description
FileKeyManager()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getDirectory(java.lang.String type, java.lang.String tempSubDir) Method that returns configured directory for storing using keys.
protected static java.lang.String	getDirectory(java.lang.String configPath, java.lang.String type, java.lang.String tempSubDir)
protected abstract java.lang.String	getKeyStorePath() Returns the path of directory where key files are stored.
protected abstract java.lang.String	getProtectPassphrase() Method to retrieve the configured pass phrase used to protect generated keys.
protected char[]	getProtectPassphraseWithDefault() Help method that sets a default pass phrase if not configured with a warning log entry.
java.lang.String	getProvider(Context context) Method to return the Security Provider to use in given context.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static java.util.logging.Logger log

Constructor Detail

FileKeyManager

public FileKeyManager()

Method Detail

getProvider

public java.lang.String getProvider(Context context)

Method to return the Security Provider to use in given context. Currently uses SUN provider.

Specified by:

getProvider in interface KeyManager

Parameters:

context - the related context

Returns:

the provider to use.

getKeyStorePath

protected abstract java.lang.String getKeyStorePath()
                                             throws InternalErrorException

Returns the path of directory where key files are stored.

Returns:

the path to the directory where key store files are stored. Or null if not configured.

Throws:

InternalErrorException - if internal error occurred retrieving the key store path.

getProtectPassphrase

protected abstract java.lang.String getProtectPassphrase()
                                                  throws InternalErrorException

Method to retrieve the configured pass phrase used to protect generated keys.

Returns:

the configured protect pass phrase or null if no passphrase is configured.

Throws:

InternalErrorException - if internal error occurred retrieving configuration.

getProtectPassphraseWithDefault

protected char[] getProtectPassphraseWithDefault()
                                          throws InternalErrorException

Help method that sets a default pass phrase if not configured with a warning log entry.

Returns:

passphrase of default pass phrase, never null

Throws:

InternalErrorException - if internal error occurred retrieving configuration.

getDirectory

protected java.lang.String getDirectory(java.lang.String type,
                                        java.lang.String tempSubDir)
                                 throws InternalErrorException

Method that returns configured directory for storing using keys. If not configured is temporary directory used, (when used in development test environments).

Parameters:

type - display name of path used for logging purposes.

tempSubDir - the sub directory used if config path is null and temporary directory should be used.

Returns:

the name of the directory used to store/fetch keys.

Throws:

InternalErrorException - if internal problems occured.

getDirectory

protected static java.lang.String getDirectory(java.lang.String configPath,
                                               java.lang.String type,
                                               java.lang.String tempSubDir)
                                        throws InternalErrorException

Throws:

InternalErrorException