Class SimpleKeyFile

java.lang.Object

org.jpos.security.SimpleKeyFile

All Implemented Interfaces:

Configurable, SecureKeyStore, LogSource

public class SimpleKeyFile
extends Object
implements SecureKeyStore, Configurable, LogSource

Implements SecureKeyStore using a properties file.

See Also:

• Properties

Nested Class Summary

Nested classes/interfaces inherited from interface SecureKeyStore

SecureKeyStore.SecureKeyStoreException

Modifier and Type	Interface	Description
static class	SecureKeyStore.SecureKeyStoreException	Exception type raised by SecureKeyStore implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	logger	Logger receiving load/save diagnostic events.
protected String	realm	Logger realm associated with this store.

Constructor Summary

Constructors

Constructor	Description
SimpleKeyFile()	Default constructor.
SimpleKeyFile(String keyFileName)	Constructs the store and immediately loads keys from keyFileName.

Method Summary

Modifier and Type	Method	Description
SecureKey	getKey(String alias)	Returns the key assiciated with the given alias.
Map<String, SecureKey>	getKeys()	Returns map of existing keys assiciated with aliases.
Logger	getLogger()	Returns the Logger associated with this source.
String	getProperty(String alias, String subName)	Returns the trimmed property stored under alias.subName.
String	getRealm()	Returns the log realm associated with this source.
void	init(String keyFileName)	Loads (or creates) the underlying properties file and reads its contents.
void	setConfiguration(Configuration cfg)	Configures this object with the supplied Configuration.
void	setKey(String alias, SecureKey secureKey)	Assigns the given key to the given alias.
void	setLogger(Logger logger, String realm)	Attaches a Logger and realm to this log source.
void	setProperty(String alias, String subName, String value)	Sets the property stored under alias.subName.

Methods inherited from class Object

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

Field Details

logger

protected Logger logger

Logger receiving load/save diagnostic events.

realm

protected String realm

Logger realm associated with this store.

Constructor Details

SimpleKeyFile

public SimpleKeyFile()

Default constructor.

SimpleKeyFile

public SimpleKeyFile(String keyFileName)
              throws SecureKeyStore.SecureKeyStoreException

Constructs the store and immediately loads keys from keyFileName.

Parameters:

keyFileName - path to the properties file backing this store

Throws:

SecureKeyStore.SecureKeyStoreException - if the file cannot be created or loaded

Method Details

init

public void init(String keyFileName)
          throws SecureKeyStore.SecureKeyStoreException

Loads (or creates) the underlying properties file and reads its contents.

Parameters:

keyFileName - path to the properties file backing this store

Throws:

SecureKeyStore.SecureKeyStoreException - if the file cannot be created or loaded

setLogger

public void setLogger(Logger logger,
 String realm)

Description copied from interface: LogSource

Attaches a Logger and realm to this log source.

Specified by:

setLogger in interface LogSource

Parameters:

logger - the logger to use

realm - the log realm (diagnostic label)

getLogger

public Logger getLogger()

Description copied from interface: LogSource

Returns the Logger associated with this source.

Specified by:

getLogger in interface LogSource

Returns:

the Logger

getRealm

public String getRealm()

Description copied from interface: LogSource

Returns the log realm associated with this source.

Specified by:

getRealm in interface LogSource

Returns:

log realm

setConfiguration

public void setConfiguration(Configuration cfg)
                      throws ConfigurationException

Description copied from interface: Configurable

Configures this object with the supplied Configuration.

Specified by:

setConfiguration in interface Configurable

Parameters:

cfg - configuration object

Throws:

ConfigurationException - if configuration is invalid

getKey

public SecureKey getKey(String alias)
                 throws SecureKeyStore.SecureKeyStoreException

Description copied from interface: SecureKeyStore

Returns the key assiciated with the given alias.

Specified by:

getKey in interface SecureKeyStore

Parameters:

alias - the alias name

Returns:

the requested key, or null if the given alias does not exist.

Throws:

SecureKeyStore.SecureKeyStoreException - if SecureKeyStore is not initialized or if the operation fails for some other reason.

setKey

public void setKey(String alias,
 SecureKey secureKey)
            throws SecureKeyStore.SecureKeyStoreException

Description copied from interface: SecureKeyStore

Assigns the given key to the given alias. If the given alias already exists, the keystore information associated with it is overridden by the given key.

Specified by:

setKey in interface SecureKeyStore

Parameters:

alias - the alias name

secureKey - the key to be associated with the alias

Throws:

SecureKeyStore.SecureKeyStoreException - if SecureKeyStore is not initialized or the key can't be recovered.

getProperty

public String getProperty(String alias,
 String subName)
                   throws SecureKeyStore.SecureKeyStoreException

Returns the trimmed property stored under alias.subName.

Parameters:

alias - key alias

subName - property name within the alias

Returns:

the trimmed property value

Throws:

SecureKeyStore.SecureKeyStoreException - if the property is not present

setProperty

public void setProperty(String alias,
 String subName,
 String value)

Sets the property stored under alias.subName.

Parameters:

alias - key alias

subName - property name within the alias

value - new property value

getKeys

public Map<String, SecureKey> getKeys()
                               throws SecureKeyStore.SecureKeyStoreException

Description copied from interface: SecureKeyStore

Returns map of existing keys assiciated with aliases.

Specified by:

getKeys in interface SecureKeyStore

Returns:

map of existing keys assiciated with aliases.

Throws:

SecureKeyStore.SecureKeyStoreException - if SecureKeyStore is not initialized or if the operation fails for some other reason.