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

Class SslConfiguration

java.lang.Object

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

@Plugin(name="Ssl",
        category="Core",
        printObject=true)
public class SslConfiguration
extends java.lang.Object

SSL Configuration

Field Summary

Fields

Modifier and Type	Field and Description
private KeyStoreConfiguration	keyStoreConfig
private static StatusLogger	LOGGER
private java.lang.String	protocol
private javax.net.ssl.SSLContext	sslContext
private TrustStoreConfiguration	trustStoreConfig
private boolean	verifyHostName

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SslConfiguration(java.lang.String protocol, KeyStoreConfiguration keyStoreConfig, TrustStoreConfiguration trustStoreConfig, boolean verifyHostName)

Method Summary

Modifier and Type	Method and Description
void	clearSecrets() Clears the secret fields in this object but still allow it to operate normally.
private javax.net.ssl.SSLContext	createDefaultSslContext()
static SslConfiguration	createSSLConfiguration(java.lang.String protocol, KeyStoreConfiguration keyStoreConfig, TrustStoreConfiguration trustStoreConfig) Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.
static SslConfiguration	createSSLConfiguration(java.lang.String protocol, KeyStoreConfiguration keyStoreConfig, TrustStoreConfiguration trustStoreConfig, boolean verifyHostName) Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.
private javax.net.ssl.SSLContext	createSslContext()
private javax.net.ssl.SSLContext	createSslContext(boolean loadDefaultKeyManagerFactory, boolean loadDefaultTrustManagerFactory)
private javax.net.ssl.SSLContext	createSslContextBasedOnConfiguration()
private javax.net.ssl.SSLContext	createSslContextWithDefaultKeyManagerFactory()
private javax.net.ssl.SSLContext	createSslContextWithDefaultTrustManagerFactory()
private javax.net.ssl.SSLContext	createSslContextWithKeyStoreFailure()
private javax.net.ssl.SSLContext	createSslContextWithTrustStoreFailure()
boolean	equals(java.lang.Object obj)
KeyStoreConfiguration	getKeyStoreConfig()
java.lang.String	getProtocol()
javax.net.ssl.SSLContext	getSslContext()
javax.net.ssl.SSLServerSocketFactory	getSslServerSocketFactory()
javax.net.ssl.SSLSocketFactory	getSslSocketFactory()
TrustStoreConfiguration	getTrustStoreConfig()
int	hashCode()
boolean	isVerifyHostName()
private javax.net.ssl.KeyManagerFactory	loadKeyManagerFactory()
private javax.net.ssl.TrustManagerFactory	loadTrustManagerFactory()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final StatusLogger LOGGER

keyStoreConfig

private final KeyStoreConfiguration keyStoreConfig

trustStoreConfig

private final TrustStoreConfiguration trustStoreConfig

sslContext

private final javax.net.ssl.SSLContext sslContext

protocol

private final java.lang.String protocol

verifyHostName

private final boolean verifyHostName

Constructor Detail

SslConfiguration

private SslConfiguration(java.lang.String protocol,
                         KeyStoreConfiguration keyStoreConfig,
                         TrustStoreConfiguration trustStoreConfig,
                         boolean verifyHostName)

Method Detail

clearSecrets

public void clearSecrets()

Clears the secret fields in this object but still allow it to operate normally.

getSslSocketFactory

public javax.net.ssl.SSLSocketFactory getSslSocketFactory()

getSslServerSocketFactory

public javax.net.ssl.SSLServerSocketFactory getSslServerSocketFactory()

createSslContext

private javax.net.ssl.SSLContext createSslContext()

createSslContextWithTrustStoreFailure

private javax.net.ssl.SSLContext createSslContextWithTrustStoreFailure()

createSslContextWithKeyStoreFailure

private javax.net.ssl.SSLContext createSslContextWithKeyStoreFailure()

createSslContextBasedOnConfiguration

private javax.net.ssl.SSLContext createSslContextBasedOnConfiguration()
                                                               throws KeyStoreConfigurationException,
                                                                      TrustStoreConfigurationException

Throws:

KeyStoreConfigurationException

TrustStoreConfigurationException

createSslContextWithDefaultKeyManagerFactory

private javax.net.ssl.SSLContext createSslContextWithDefaultKeyManagerFactory()
                                                                       throws TrustStoreConfigurationException

Throws:

TrustStoreConfigurationException

createSslContextWithDefaultTrustManagerFactory

private javax.net.ssl.SSLContext createSslContextWithDefaultTrustManagerFactory()
                                                                         throws KeyStoreConfigurationException

Throws:

KeyStoreConfigurationException

createDefaultSslContext

private javax.net.ssl.SSLContext createDefaultSslContext()

createSslContext

private javax.net.ssl.SSLContext createSslContext(boolean loadDefaultKeyManagerFactory,
                                                  boolean loadDefaultTrustManagerFactory)
                                           throws KeyStoreConfigurationException,
                                                  TrustStoreConfigurationException

Throws:

KeyStoreConfigurationException

TrustStoreConfigurationException

loadTrustManagerFactory

private javax.net.ssl.TrustManagerFactory loadTrustManagerFactory()
                                                           throws TrustStoreConfigurationException

Throws:

TrustStoreConfigurationException

loadKeyManagerFactory

private javax.net.ssl.KeyManagerFactory loadKeyManagerFactory()
                                                       throws KeyStoreConfigurationException

Throws:

KeyStoreConfigurationException

createSSLConfiguration

@PluginFactory
public static SslConfiguration createSSLConfiguration(@PluginAttribute(value="protocol")
                                                                     java.lang.String protocol,
                                                                     @PluginElement(value="KeyStore")
                                                                     KeyStoreConfiguration keyStoreConfig,
                                                                     @PluginElement(value="TrustStore")
                                                                     TrustStoreConfiguration trustStoreConfig)

Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.

Parameters:

protocol - The protocol, see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#SSLContext

keyStoreConfig - The KeyStoreConfiguration.

trustStoreConfig - The TrustStoreConfiguration.

Returns:

a new SslConfiguration

createSSLConfiguration

public static SslConfiguration createSSLConfiguration(@PluginAttribute(value="protocol")
                                                      java.lang.String protocol,
                                                      @PluginElement(value="KeyStore")
                                                      KeyStoreConfiguration keyStoreConfig,
                                                      @PluginElement(value="TrustStore")
                                                      TrustStoreConfiguration trustStoreConfig,
                                                      @PluginElement(value="verifyHostName")
                                                      boolean verifyHostName)

Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.

Parameters:

protocol - The protocol, see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#SSLContext

keyStoreConfig - The KeyStoreConfiguration.

trustStoreConfig - The TrustStoreConfiguration.

Returns:

a new SslConfiguration

Since:

2.12

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getKeyStoreConfig

public KeyStoreConfiguration getKeyStoreConfig()

getTrustStoreConfig

public TrustStoreConfiguration getTrustStoreConfig()

getSslContext

public javax.net.ssl.SSLContext getSslContext()

getProtocol

public java.lang.String getProtocol()

isVerifyHostName

public boolean isVerifyHostName()