Class KeyStoreConfiguration

java.lang.Object

org.apache.logging.log4j.core.net.ssl.StoreConfiguration<KeyStore>

org.apache.logging.log4j.core.net.ssl.AbstractKeyStoreConfiguration

org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration

@Plugin(name="KeyStore",
        category="Core",
        printObject=true)
public class KeyStoreConfiguration
extends AbstractKeyStoreConfiguration

Configuration of the KeyStore

Field Summary

Fields

Modifier and Type	Field	Description
private final String	keyManagerFactoryAlgorithm

Fields inherited from class StoreConfiguration

JKS, LOGGER, PKCS12

Constructor Summary

Constructors

Constructor	Description
KeyStoreConfiguration(String location, char[] password, String keyStoreType, String keyManagerFactoryAlgorithm)	Deprecated. use KeyStoreConfiguration(String, PasswordProvider, String, String) instead
KeyStoreConfiguration(String location, String password, String keyStoreType, String keyManagerFactoryAlgorithm)	Deprecated. Use KeyStoreConfiguration(String, PasswordProvider, String, String) instead
KeyStoreConfiguration(String location, PasswordProvider passwordProvider, String keyStoreType, String keyManagerFactoryAlgorithm)

Method Summary

Modifier and Type	Method	Description
static KeyStoreConfiguration	createKeyStoreConfiguration(String location, char[] password, String keyStoreType, String keyManagerFactoryAlgorithm)	Deprecated. use createKeyStoreConfiguration(String, char[], String, String, String, String)
static KeyStoreConfiguration	createKeyStoreConfiguration(String location, char[] password, String passwordEnvironmentVariable, String passwordFile, String keyStoreType, String keyManagerFactoryAlgorithm)	Creates a KeyStoreConfiguration.
static KeyStoreConfiguration	createKeyStoreConfiguration(String location, String password, String keyStoreType, String keyManagerFactoryAlgorithm)	Deprecated. Use createKeyStoreConfiguration(String, char[], String, String, String, String)
boolean	equals(Object obj)
String	getKeyManagerFactoryAlgorithm()
int	hashCode()
KeyManagerFactory	initKeyManagerFactory()	Deprecated. Planned to be removed in the next major release

Methods inherited from class AbstractKeyStoreConfiguration

getKeyStore, getKeyStoreType, load

Methods inherited from class StoreConfiguration

clearSecrets, getLocation, getPassword, getPasswordAsCharArray, setLocation, setPassword, setPassword

Methods inherited from class Object

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

Field Details

keyManagerFactoryAlgorithm

private final String keyManagerFactoryAlgorithm

Constructor Details

KeyStoreConfiguration

public KeyStoreConfiguration(String location,
 PasswordProvider passwordProvider,
 String keyStoreType,
 String keyManagerFactoryAlgorithm)
                      throws StoreConfigurationException

Throws:

StoreConfigurationException - Thrown if this instance cannot load the KeyStore.

KeyStoreConfiguration

@Deprecated
public KeyStoreConfiguration(String location,
 char[] password,
 String keyStoreType,
 String keyManagerFactoryAlgorithm)
                      throws StoreConfigurationException

Deprecated.

use KeyStoreConfiguration(String, PasswordProvider, String, String) instead

Throws:

StoreConfigurationException - Thrown if this instance cannot load the KeyStore.

KeyStoreConfiguration

@Deprecated
public KeyStoreConfiguration(String location,
 String password,
 String keyStoreType,
 String keyManagerFactoryAlgorithm)
                      throws StoreConfigurationException

Deprecated.

Use KeyStoreConfiguration(String, PasswordProvider, String, String) instead

Throws:

StoreConfigurationException - Thrown if this instance cannot load the KeyStore.

Method Details

createKeyStoreConfiguration

@PluginFactory
public static KeyStoreConfiguration createKeyStoreConfiguration(@PluginAttribute("location")
 String location,
 @PluginAttribute(value="password",sensitive=true)
 char[] password,
 @PluginAttribute("passwordEnvironmentVariable")
 String passwordEnvironmentVariable,
 @PluginAttribute("passwordFile")
 String passwordFile,
 @PluginAttribute("type")
 String keyStoreType,
 @PluginAttribute("keyManagerFactoryAlgorithm")
 String keyManagerFactoryAlgorithm)
                                                         throws StoreConfigurationException

Creates a KeyStoreConfiguration.

Parameters:

location - The location of the KeyStore, a file path, URL or resource.

password - The password to access the KeyStore.

keyStoreType - The KeyStore type, null defaults to "JKS".

keyManagerFactoryAlgorithm - The standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about these names.

Returns:

a new KeyStoreConfiguration

Throws:

StoreConfigurationException - Thrown if this call cannot load the KeyStore.

createKeyStoreConfiguration

@Deprecated
public static KeyStoreConfiguration createKeyStoreConfiguration(String location,
 char[] password,
 String keyStoreType,
 String keyManagerFactoryAlgorithm)
                                                         throws StoreConfigurationException

Deprecated.

use createKeyStoreConfiguration(String, char[], String, String, String, String)

Throws:

StoreConfigurationException

createKeyStoreConfiguration

@Deprecated
public static KeyStoreConfiguration createKeyStoreConfiguration(String location,
 String password,
 String keyStoreType,
 String keyManagerFactoryAlgorithm)
                                                         throws StoreConfigurationException

Deprecated.

Use createKeyStoreConfiguration(String, char[], String, String, String, String)

Creates a KeyStoreConfiguration.

Parameters:

location - The location of the KeyStore, a file path, URL or resource.

password - The password to access the KeyStore.

keyStoreType - The KeyStore type, null defaults to "JKS".

keyManagerFactoryAlgorithm - The standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about these names.

Returns:

a new KeyStoreConfiguration

Throws:

StoreConfigurationException - Thrown if this call cannot load the KeyStore.

initKeyManagerFactory

@Deprecated
public KeyManagerFactory initKeyManagerFactory()
                                        throws NoSuchAlgorithmException,
UnrecoverableKeyException,
KeyStoreException

Deprecated.

Planned to be removed in the next major release

Throws:

NoSuchAlgorithmException

UnrecoverableKeyException

KeyStoreException

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractKeyStoreConfiguration

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractKeyStoreConfiguration

getKeyManagerFactoryAlgorithm

public String getKeyManagerFactoryAlgorithm()