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

Class SslSocketManager

java.lang.Object

org.apache.logging.log4j.core.appender.AbstractManager

org.apache.logging.log4j.core.appender.OutputStreamManager

org.apache.logging.log4j.core.net.AbstractSocketManager

org.apache.logging.log4j.core.net.TcpSocketManager

org.apache.logging.log4j.core.net.SslSocketManager

All Implemented Interfaces:

AutoCloseable, ByteBufferDestination

public class SslSocketManager
extends TcpSocketManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SslSocketManager.SslFactoryData
private static class	SslSocketManager.SslSocketManagerFactory

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.net.TcpSocketManager

TcpSocketManager.FactoryData, TcpSocketManager.HostResolver, TcpSocketManager.TcpSocketManagerFactory<M extends TcpSocketManager,T extends TcpSocketManager.FactoryData>

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractManager

AbstractManager.AbstractFactoryData

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PORT
private static final SslSocketManager.SslSocketManagerFactory	FACTORY
private final SslConfiguration	sslConfig

Fields inherited from class org.apache.logging.log4j.core.net.TcpSocketManager

DEFAULT_RECONNECTION_DELAY_MILLIS

Fields inherited from class org.apache.logging.log4j.core.net.AbstractSocketManager

host, inetAddress, port

Fields inherited from class org.apache.logging.log4j.core.appender.OutputStreamManager

byteBuffer, layout

Fields inherited from class org.apache.logging.log4j.core.appender.AbstractManager

count, LOGGER

Constructor Summary

Constructors

Constructor	Description
SslSocketManager(String name, OutputStream os, Socket sock, SslConfiguration sslConfig, InetAddress inetAddress, String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize)	Deprecated. Use SslSocketManager(String, OutputStream, Socket, SslConfiguration, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions).
SslSocketManager(String name, OutputStream os, Socket sock, SslConfiguration sslConfig, InetAddress inetAddress, String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions)

Method Summary

Modifier and Type	Method	Description
(package private) static SNIHostName	createSniHostName(String hostName)	Returns an SNIHostName instance if the provided host name is not an IP literal (RFC 6066), and constitutes a valid host name (RFC 1035); null otherwise.
private static Socket	createSocket(String hostName, InetSocketAddress socketAddress, int connectTimeoutMillis, SslConfiguration sslConfiguration, SocketOptions socketOptions)
protected Socket	createSocket(InetSocketAddress socketAddress)
private static String	createSslConfigurationId(SslConfiguration sslConfig)	Creates a unique identifier using the certificate issuers and serial numbers of the given SSL configuration.
private static SSLSocketFactory	createSslSocketFactory(SslConfiguration sslConf)
static SslSocketManager	getSocketManager(SslConfiguration sslConfig, String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize)	Deprecated. Use getSocketManager(SslConfiguration, String, int, int, int, boolean, Layout, int, SocketOptions).
static SslSocketManager	getSocketManager(SslConfiguration sslConfig, String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions)

Methods inherited from class org.apache.logging.log4j.core.net.TcpSocketManager

closeOutputStream, createSocket, getConnectTimeoutMillis, getContentFormat, getReconnectionDelayMillis, getSocket, getSocketManager, getSocketManager, getSocketOptions, setHostResolver, toString, write

Methods inherited from class org.apache.logging.log4j.core.net.AbstractSocketManager

getHost, getPort

Methods inherited from class org.apache.logging.log4j.core.appender.OutputStreamManager

createOutputStream, drain, flush, flushBuffer, flushDestination, getByteBuffer, getManager, getOutputStream, hasOutputStream, isOpen, releaseSub, setOutputStream, skipFooter, write, write, write, writeBytes, writeBytes, writeFooter, writeHeader, writeToDestination

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractManager

close, getCount, getLoggerContext, getManager, getName, getStrSubstitutor, hasManager, log, logDebug, logError, logger, logWarn, narrow, release, stop, updateData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

• Constant Field Values

FACTORY

private static final SslSocketManager.SslSocketManagerFactory FACTORY

sslConfig

private final SslConfiguration sslConfig

Constructor Details

SslSocketManager

@Deprecated
public SslSocketManager(String name,
 OutputStream os,
 Socket sock,
 SslConfiguration sslConfig,
 InetAddress inetAddress,
 String host,
 int port,
 int connectTimeoutMillis,
 int reconnectionDelayMillis,
 boolean immediateFail,
 Layout<? extends Serializable> layout,
 int bufferSize)

Deprecated.

Use SslSocketManager(String, OutputStream, Socket, SslConfiguration, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions).

Parameters:

name - the unique name of this connection

os - the OutputStream

sock - the Socket

inetAddress - the Internet address of the host

host - the name of the host

port - the port number on the host

connectTimeoutMillis - the connect timeout in milliseconds

reconnectionDelayMillis - Reconnection interval.

immediateFail - True if the write should fail if no socket is immediately available.

layout - the Layout

bufferSize - The buffer size.

SslSocketManager

public SslSocketManager(String name,
 OutputStream os,
 Socket sock,
 SslConfiguration sslConfig,
 InetAddress inetAddress,
 String host,
 int port,
 int connectTimeoutMillis,
 int reconnectionDelayMillis,
 boolean immediateFail,
 Layout<? extends Serializable> layout,
 int bufferSize,
 SocketOptions socketOptions)

Parameters:

name - The unique name of this connection.

os - The OutputStream.

sock - The Socket.

inetAddress - The Internet address of the host.

host - The name of the host.

port - The port number on the host.

connectTimeoutMillis - the connect timeout in milliseconds.

reconnectionDelayMillis - Reconnection interval.

immediateFail - True if the write should fail if no socket is immediately available.

layout - The Layout.

bufferSize - The buffer size.

Method Details

getSocketManager

@Deprecated
public static SslSocketManager getSocketManager(SslConfiguration sslConfig,
 String host,
 int port,
 int connectTimeoutMillis,
 int reconnectDelayMillis,
 boolean immediateFail,
 Layout<? extends Serializable> layout,
 int bufferSize)

Deprecated.

Use getSocketManager(SslConfiguration, String, int, int, int, boolean, Layout, int, SocketOptions).

getSocketManager

public static SslSocketManager getSocketManager(SslConfiguration sslConfig,
 String host,
 int port,
 int connectTimeoutMillis,
 int reconnectDelayMillis,
 boolean immediateFail,
 Layout<? extends Serializable> layout,
 int bufferSize,
 SocketOptions socketOptions)

createSslConfigurationId

private static String createSslConfigurationId(SslConfiguration sslConfig)

Creates a unique identifier using the certificate issuers and serial numbers of the given SSL configuration.

Parameters:

sslConfig - an SSL configuration

Returns:

a unique identifier extracted from the given SSL configuration

createSocket

protected Socket createSocket(InetSocketAddress socketAddress)
                       throws IOException

Overrides:

createSocket in class TcpSocketManager

Throws:

IOException

createSslSocketFactory

private static SSLSocketFactory createSslSocketFactory(SslConfiguration sslConf)

createSocket

private static Socket createSocket(String hostName,
 InetSocketAddress socketAddress,
 int connectTimeoutMillis,
 SslConfiguration sslConfiguration,
 SocketOptions socketOptions)
                            throws IOException

Throws:

IOException

createSniHostName

static SNIHostName createSniHostName(String hostName)

Returns an SNIHostName instance if the provided host name is not an IP literal (RFC 6066), and constitutes a valid host name (RFC 1035); null otherwise.

Parameters:

hostName - a host name

Returns:

an SNIHostName instance if the provided host name is not an IP literal (RFC 6066), and constitutes a valid host name (RFC 1035); null otherwise

See Also:

• Literal IPv4 and IPv6 addresses are not permitted in "HostName" (RFC 6066)
• Domain Names - Implementation and Specification (RFC 1035)