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

Class KeyStoreConfiguration

java.lang.Object

org.apache.logging.log4j.core.net.ssl.StoreConfiguration<java.security.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 and Description
private java.lang.String	keyManagerFactoryAlgorithm

Fields inherited from class org.apache.logging.log4j.core.net.ssl.StoreConfiguration

LOGGER

Constructor Summary

Constructors

Constructor and Description
KeyStoreConfiguration(java.lang.String location, java.lang.String password, java.lang.String keyStoreType, java.lang.String keyManagerFactoryAlgorithm)

Method Summary

Modifier and Type	Method and Description
static KeyStoreConfiguration	createKeyStoreConfiguration(java.lang.String location, java.lang.String password, java.lang.String keyStoreType, java.lang.String keyManagerFactoryAlgorithm) Creates a KeyStoreConfiguration.
boolean	equals(java.lang.Object obj)
int	hashCode()
javax.net.ssl.KeyManagerFactory	initKeyManagerFactory()

Methods inherited from class org.apache.logging.log4j.core.net.ssl.AbstractKeyStoreConfiguration

getKeyStore, load

Methods inherited from class org.apache.logging.log4j.core.net.ssl.StoreConfiguration

getLocation, getPassword, getPasswordAsCharArray, setLocation, setPassword

Methods inherited from class java.lang.Object

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

Field Detail

keyManagerFactoryAlgorithm

private final java.lang.String keyManagerFactoryAlgorithm

Constructor Detail

KeyStoreConfiguration

public KeyStoreConfiguration(java.lang.String location,
                             java.lang.String password,
                             java.lang.String keyStoreType,
                             java.lang.String keyManagerFactoryAlgorithm)
                      throws StoreConfigurationException

Throws:

StoreConfigurationException - Thrown if this instance cannot load the KeyStore.

Method Detail

createKeyStoreConfiguration

@PluginFactory
public static KeyStoreConfiguration createKeyStoreConfiguration(@PluginAttribute(value="location")
                                                                               java.lang.String location,
                                                                               @PluginAttribute(value="password",sensitive=true)
                                                                               java.lang.String password,
                                                                               @PluginAttribute(value="type")
                                                                               java.lang.String keyStoreType,
                                                                               @PluginAttribute(value="keyManagerFactoryAlgorithm")
                                                                               java.lang.String keyManagerFactoryAlgorithm)
                                                                        throws StoreConfigurationException

Creates a KeyStoreConfiguration.

Parameters:

location - The location of the KeyStore.

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

public javax.net.ssl.KeyManagerFactory initKeyManagerFactory()
                                                      throws java.security.NoSuchAlgorithmException,
                                                             java.security.UnrecoverableKeyException,
                                                             java.security.KeyStoreException

Throws:

java.security.NoSuchAlgorithmException

java.security.UnrecoverableKeyException

java.security.KeyStoreException

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractKeyStoreConfiguration

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractKeyStoreConfiguration