Class LdapSslSocketFactory

java.lang.Object

javax.net.SocketFactory

javax.net.ssl.SSLSocketFactory

org.springframework.boot.ldap.autoconfigure.LdapSslSocketFactory

public final class LdapSslSocketFactory
extends SSLSocketFactory

Bridges the JNDI java.naming.ldap.factory.socket environment property to an SslBundle. That property only accepts a class name, which JNDI loads and on which it then calls getDefault(), with no way of passing an actual factory instance. The bundle to use is therefore held in a static field.

JNDI calls getDefault() once per new connection and the SslBundle is asked for a fresh SSLContext each time, so key and trust material of a bundle that has been reloaded is picked up by connections opened from then on. Reloading is only tracked for a bundle configured by name through spring.ldap.ssl.bundle; a bundle supplied by a custom LdapConnectionDetails is used as given.

As the bundle is held statically, a single SslBundle applies JVM-wide. This is sufficient for the auto-configured LdapContextSource, of which there is at most one per application context.

This class is referenced by name from a JNDI environment and is not intended to be used directly.

Since:

4.2.0

Author:

Moritz Halbritter

Method Summary

Modifier and Type	Method	Description
Socket	createSocket()	Creates an unconnected socket.
Socket	createSocket(String host, int port)
Socket	createSocket(String host, int port, InetAddress localAddress, int localPort)
Socket	createSocket(InetAddress host, int port)
Socket	createSocket(InetAddress address, int port, InetAddress localAddress, int localPort)
Socket	createSocket(Socket socket, InputStream consumed, boolean autoClose)
Socket	createSocket(Socket socket, String host, int port, boolean autoClose)
static SocketFactory	getDefault()
String[]	getDefaultCipherSuites()
String[]	getSupportedCipherSuites()

Methods inherited from class Object

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

Method Details

getDefault

public static SocketFactory getDefault()

getDefaultCipherSuites

public String[] getDefaultCipherSuites()

Specified by:

getDefaultCipherSuites in class SSLSocketFactory

getSupportedCipherSuites

public String[] getSupportedCipherSuites()

Specified by:

getSupportedCipherSuites in class SSLSocketFactory

createSocket

public Socket createSocket(Socket socket,
 String host,
 int port,
 boolean autoClose)
                    throws IOException

Specified by:

createSocket in class SSLSocketFactory

Throws:

IOException

createSocket

public Socket createSocket(Socket socket,
 InputStream consumed,
 boolean autoClose)
                    throws IOException

Overrides:

createSocket in class SSLSocketFactory

Throws:

IOException

createSocket

public Socket createSocket()
                    throws IOException

Creates an unconnected socket. JNDI tries this first when a connect timeout has been configured, so it has to be delegated rather than inheriting SocketFactory.createSocket(), which throws and makes JNDI fall back to a connected socket that ignores the timeout.

Overrides:

createSocket in class SocketFactory

Returns:

an unconnected socket

Throws:

IOException - if the socket cannot be created

createSocket

public Socket createSocket(String host,
 int port)
                    throws IOException

Specified by:

createSocket in class SocketFactory

Throws:

IOException

createSocket

public Socket createSocket(String host,
 int port,
 InetAddress localAddress,
 int localPort)
                    throws IOException

Specified by:

createSocket in class SocketFactory

Throws:

IOException

createSocket

public Socket createSocket(InetAddress host,
 int port)
                    throws IOException

Specified by:

createSocket in class SocketFactory

Throws:

IOException

createSocket

public Socket createSocket(InetAddress address,
 int port,
 InetAddress localAddress,
 int localPort)
                    throws IOException

Specified by:

createSocket in class SocketFactory

Throws:

IOException