Package com.nimbusds.common.config

Class CustomKeyStoreConfiguration

java.lang.Object

com.nimbusds.common.config.CustomKeyStoreConfiguration

All Implemented Interfaces:

LoggableConfiguration

public class CustomKeyStoreConfiguration
extends Object
implements LoggableConfiguration

Details of a custom key store for client X.509 certificates to be presented to a remote server.

Supports Log4j logging, see log.

Property keys: [prefix]*

Field Summary

Fields

Modifier and Type	Field	Description
boolean	enable	If true a custom key store file must be used for the client X.509 certificates to be presented to the remote server (if such authentication is required).
String	file	The file system location of the custom key store file.
String	password	The password to unlock the custom key store file.
String	type	The type of the custom key store file, typically "JKS" or "PKCS12".

Fields inherited from interface com.nimbusds.common.config.LoggableConfiguration

LOG_CATEGORY

Constructor Summary

Constructors

Constructor	Description
CustomKeyStoreConfiguration(String prefix, Properties props)	Creates a new custom key store configuration from the specified properties.

Method Summary

Modifier and Type	Method	Description
void	log()	Logs the configuration details at INFO level using Log4j.

Methods inherited from class java.lang.Object

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

Field Detail

enable

public final boolean enable

If true a custom key store file must be used for the client X.509 certificates to be presented to the remote server (if such authentication is required).

If false the default key store will be used (if one has been provided and correctly configured).

Property key: [prefix]enable

file

public final String file

The file system location of the custom key store file.

Property key: [prefix]file

type

public final String type

The type of the custom key store file, typically "JKS" or "PKCS12". An empty or null string indicates to use the system default type.

Property key: [prefix]type

password

public final String password

The password to unlock the custom key store file. An empty or null string indicates that no password is required.

Property key: [prefix]password

Constructor Detail

CustomKeyStoreConfiguration

public CustomKeyStoreConfiguration(String prefix,
                                   Properties props)
                            throws com.thetransactioncompany.util.PropertyParseException

Creates a new custom key store configuration from the specified properties.

Mandatory properties:

• none

Conditionally mandatory properties:

• [prefix]file - if the key store is enabled

Optional properties, with defaults:

• [prefix]enable = false
• [prefix]type = null
• [prefix]password = null

Parameters:

prefix - The properties prefix. Must not be null.

props - The properties. Must not be null.

Throws:

com.thetransactioncompany.util.PropertyParseException - On a missing or invalid property.

Method Detail

log

public void log()

Logs the configuration details at INFO level using Log4j.

Specified by:

log in interface LoggableConfiguration