Class SslConfiguration

java.lang.Object

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

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

SSL Configuration

Field Summary

Fields

Modifier and Type	Field	Description
private final KeyStoreConfiguration	keyStoreConfig
private static final StatusLogger	LOGGER
private final String	protocol
private final SSLContext	sslContext
private final TrustStoreConfiguration	trustStoreConfig
private final boolean	verifyHostName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	clearSecrets()	Clears the secret fields in this object but still allow it to operate normally.
private static SSLContext	createDefaultSslContext(String protocol)
static SslConfiguration	createSSLConfiguration(String protocol, KeyStoreConfiguration keyStoreConfig, TrustStoreConfiguration trustStoreConfig)	Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.
static SslConfiguration	createSSLConfiguration(String protocol, KeyStoreConfiguration keyStoreConfig, TrustStoreConfiguration trustStoreConfig, boolean verifyHostName)	Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.
private static SSLContext	createSslContext(String protocol, KeyStoreConfiguration keyStoreConfig, TrustStoreConfiguration trustStoreConfig)
boolean	equals(Object obj)
KeyStoreConfiguration	getKeyStoreConfig()
String	getProtocol()
SSLContext	getSslContext()
SSLServerSocketFactory	getSslServerSocketFactory()	Deprecated. Use SSLContext.getServerSocketFactory() on getSslContext()
SSLSocketFactory	getSslSocketFactory()	Deprecated. Use SSLContext.getSocketFactory() on getSslContext()
TrustStoreConfiguration	getTrustStoreConfig()
int	hashCode()
boolean	isVerifyHostName()
private static KeyManager[]	loadKeyManagers(KeyStoreConfiguration config)
private static TrustManager[]	loadTrustManagers(TrustStoreConfiguration config)

Methods inherited from class Object

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

Field Details

LOGGER

private static final StatusLogger LOGGER

protocol

private final String protocol

verifyHostName

private final boolean verifyHostName

keyStoreConfig

private final KeyStoreConfiguration keyStoreConfig

trustStoreConfig

private final TrustStoreConfiguration trustStoreConfig

sslContext

private final transient SSLContext sslContext

Constructor Details

SslConfiguration

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

Method Details

clearSecrets

public void clearSecrets()

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

getSslSocketFactory

@Deprecated
public SSLSocketFactory getSslSocketFactory()

Deprecated.

Use SSLContext.getSocketFactory() on getSslContext()

Gets the SSL socket factory of the configured SSL context.

Returns:

the SSL socket factory of the configured SSL context

getSslServerSocketFactory

@Deprecated
public SSLServerSocketFactory getSslServerSocketFactory()

Deprecated.

Use SSLContext.getServerSocketFactory() on getSslContext()

Gets the SSL server socket factory of the configured SSL context.

Returns:

the SSL server socket factory of the configured SSL context

createDefaultSslContext

private static SSLContext createDefaultSslContext(String protocol)

createSslContext

private static SSLContext createSslContext(String protocol,
 KeyStoreConfiguration keyStoreConfig,
 TrustStoreConfiguration trustStoreConfig)

loadKeyManagers

private static KeyManager[] loadKeyManagers(KeyStoreConfiguration config)
                                     throws Exception

Throws:

Exception

loadTrustManagers

private static TrustManager[] loadTrustManagers(TrustStoreConfiguration config)
                                         throws Exception

Throws:

Exception

createSSLConfiguration

public static SslConfiguration createSSLConfiguration(String protocol,
 KeyStoreConfiguration keyStoreConfig,
 TrustStoreConfiguration trustStoreConfig)

Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.

Parameters:

protocol - The protocol, see SSLContext Algorithms

keyStoreConfig - The KeyStoreConfiguration.

trustStoreConfig - The TrustStoreConfiguration.

Returns:

a new SslConfiguration

createSSLConfiguration

@PluginFactory
public static SslConfiguration createSSLConfiguration(@PluginAttribute("protocol")
 String protocol,
 @PluginElement("KeyStore")
 KeyStoreConfiguration keyStoreConfig,
 @PluginElement("TrustStore")
 TrustStoreConfiguration trustStoreConfig,
 @PluginAttribute("verifyHostName")
 boolean verifyHostName)

Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.

Parameters:

protocol - The protocol, see SSLContext Algorithms

keyStoreConfig - The KeyStoreConfiguration.

trustStoreConfig - The TrustStoreConfiguration.

verifyHostName - whether or not to perform host name verification

Returns:

a new SslConfiguration

Since:

2.12

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getProtocol

public String getProtocol()

isVerifyHostName

public boolean isVerifyHostName()

getKeyStoreConfig

public KeyStoreConfiguration getKeyStoreConfig()

getTrustStoreConfig

public TrustStoreConfiguration getTrustStoreConfig()

getSslContext

public SSLContext getSslContext()