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

Class SslConfiguration

java.lang.Object

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

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

SSL Configuration

Method Summary

Modifier and Type	Method	Description
void	clearSecrets()	Clears the secret fields in this object but still allow it to operate normally.
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.
boolean	equals(Object obj)
@Nullable KeyStoreConfiguration	getKeyStoreConfig()
String	getProtocol()
@Nullable SSLContext	getSslContext()
@Nullable SSLServerSocketFactory	getSslServerSocketFactory()	Deprecated. Use SSLContext.getServerSocketFactory() on getSslContext()
@Nullable SSLSocketFactory	getSslSocketFactory()	Deprecated. Use SSLContext.getSocketFactory() on getSslContext()
@Nullable TrustStoreConfiguration	getTrustStoreConfig()
int	hashCode()
boolean	isVerifyHostName()

Methods inherited from class java.lang.Object

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

Method Detail

clearSecrets

public void clearSecrets()

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

getSslSocketFactory

@Deprecated
public @Nullable 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 @Nullable 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

createSSLConfiguration

@NullUnmarked
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

@NullUnmarked
@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 @Nullable KeyStoreConfiguration getKeyStoreConfig()

getTrustStoreConfig

public @Nullable TrustStoreConfiguration getTrustStoreConfig()

getSslContext

public @Nullable SSLContext getSslContext()