org.ldaptive.ssl

Class AbstractTLSSocketFactory

java.lang.Object

javax.net.SocketFactory

javax.net.ssl.SSLSocketFactory

org.ldaptive.ssl.AbstractTLSSocketFactory

Direct Known Subclasses:

TLSSocketFactory

public abstract class AbstractTLSSocketFactory
extends javax.net.ssl.SSLSocketFactory

Provides common implementation for TLSSocketFactory.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PROTOCOL Default SSL protocol, value is "TLS".
protected javax.net.ssl.SSLSocketFactory	factory SSLSocketFactory used for creating SSL sockets.
protected org.slf4j.Logger	logger Logger for this class.
private SocketConfig	socketConfig Socket configuration options.
private SslConfig	sslConfig SSL configuration options.

Constructor Summary

Constructors

Constructor and Description
AbstractTLSSocketFactory()

Method Summary

Modifier and Type	Method and Description
java.net.Socket	createSocket() Creates an unconnected socket.
java.net.Socket	createSocket(java.net.InetAddress host, int port) Creates a socket and connects it to the specified port number at the specified address.
java.net.Socket	createSocket(java.net.InetAddress address, int port, java.net.InetAddress localAddress, int localPort) Creates a socket and connect it to the specified port number at the specified address.
java.net.Socket	createSocket(java.net.Socket socket, java.lang.String host, int port, boolean autoClose) Returns a socket layered over an existing socket connected to the named host, at the given port.
java.net.Socket	createSocket(java.lang.String host, int port) Creates a socket and connects it to the specified port number at the specified address.
java.net.Socket	createSocket(java.lang.String host, int port, java.net.InetAddress localHost, int localPort) Creates a socket and connect it to the specified port number at the specified address.
java.lang.String[]	getDefaultCipherSuites() Returns the list of cipher suites which are enabled by default.
javax.net.ssl.SSLSocketFactory	getFactory() Returns the underlying SSL socket factory that this class uses for creating SSL Sockets.
SocketConfig	getSocketConfig() Returns the socket configuration used by this socket factory.
SslConfig	getSslConfig() Returns the SSL configuration used by this socket factory.
java.lang.String[]	getSupportedCipherSuites() Returns the names of the cipher suites which could be enabled for use on an SSL connection.
abstract void	initialize() Prepares this socket factory for use.
protected javax.net.ssl.SSLSocket	initSSLSocket(javax.net.ssl.SSLSocket socket) Initializes the supplied socket for use.
void	setSocketConfig(SocketConfig config) Sets the socket configuration used by this socket factory.
void	setSslConfig(SslConfig config) Sets the SSL configuration used by this socket factory.

Methods inherited from class javax.net.ssl.SSLSocketFactory

createSocket, getDefault

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROTOCOL

public static final java.lang.String DEFAULT_PROTOCOL

Default SSL protocol, value is "TLS".

See Also:

Constant Field Values

logger

protected final org.slf4j.Logger logger

Logger for this class.

factory

protected javax.net.ssl.SSLSocketFactory factory

SSLSocketFactory used for creating SSL sockets.

sslConfig

private SslConfig sslConfig

SSL configuration options.

socketConfig

private SocketConfig socketConfig

Socket configuration options.

Constructor Detail

AbstractTLSSocketFactory

public AbstractTLSSocketFactory()

Method Detail

initialize

public abstract void initialize()
                         throws java.security.GeneralSecurityException

Prepares this socket factory for use. Must be called before factory can be used.

Throws:

java.security.GeneralSecurityException - if the factory cannot be initialized

getFactory

public javax.net.ssl.SSLSocketFactory getFactory()

Returns the underlying SSL socket factory that this class uses for creating SSL Sockets.

Returns:

SSL socket factory

getSslConfig

public SslConfig getSslConfig()

Returns the SSL configuration used by this socket factory.

Returns:

ssl config

setSslConfig

public void setSslConfig(SslConfig config)

Sets the SSL configuration used by this socket factory.

Parameters:

config - ssl config

getSocketConfig

public SocketConfig getSocketConfig()

Returns the socket configuration used by this socket factory.

Returns:

socket config

setSocketConfig

public void setSocketConfig(SocketConfig config)

Sets the socket configuration used by this socket factory.

Parameters:

config - socket config

initSSLSocket

protected javax.net.ssl.SSLSocket initSSLSocket(javax.net.ssl.SSLSocket socket)
                                         throws java.io.IOException

Initializes the supplied socket for use.

Parameters:

socket - SSL socket to initialize

Returns:

SSL socket

Throws:

java.io.IOException - if an I/O error occurs when initializing the socket

createSocket

public java.net.Socket createSocket(java.net.Socket socket,
                                    java.lang.String host,
                                    int port,
                                    boolean autoClose)
                             throws java.io.IOException

Returns a socket layered over an existing socket connected to the named host, at the given port.

Specified by:

createSocket in class javax.net.ssl.SSLSocketFactory

Parameters:

socket - existing socket

host - server hostname

port - server port

autoClose - close the underlying socket when this socket is closed

Returns:

socket connected to the specified host and port

Throws:

java.io.IOException - if an I/O error occurs when creating the socket

createSocket

public java.net.Socket createSocket()
                             throws java.io.IOException

Creates an unconnected socket.

Overrides:

createSocket in class javax.net.SocketFactory

Returns:

unconnected socket

Throws:

java.io.IOException - if an I/O error occurs when creating the socket

createSocket

public java.net.Socket createSocket(java.net.InetAddress host,
                                    int port)
                             throws java.io.IOException

Creates a socket and connects it to the specified port number at the specified address.

Specified by:

createSocket in class javax.net.SocketFactory

Parameters:

host - server hostname

port - server port

Returns:

socket connected to the specified host and port

Throws:

java.io.IOException - if an I/O error occurs when creating the socket

createSocket

public java.net.Socket createSocket(java.net.InetAddress address,
                                    int port,
                                    java.net.InetAddress localAddress,
                                    int localPort)
                             throws java.io.IOException

Creates a socket and connect it to the specified port number at the specified address. The socket will also be bound to the supplied local address and port.

Specified by:

createSocket in class javax.net.SocketFactory

Parameters:

address - server hostname

port - server port

localAddress - client hostname

localPort - client port

Returns:

socket connected to the specified host and port

Throws:

java.io.IOException - if an I/O error occurs when creating the socket

createSocket

public java.net.Socket createSocket(java.lang.String host,
                                    int port)
                             throws java.io.IOException

Creates a socket and connects it to the specified port number at the specified address.

Specified by:

createSocket in class javax.net.SocketFactory

Parameters:

host - server hostname

port - server port

Returns:

socket connected to the specified host and port

Throws:

java.io.IOException - if an I/O error occurs when creating the socket

createSocket

public java.net.Socket createSocket(java.lang.String host,
                                    int port,
                                    java.net.InetAddress localHost,
                                    int localPort)
                             throws java.io.IOException

Creates a socket and connect it to the specified port number at the specified address. The socket will also be bound to the supplied local address and port.

Specified by:

createSocket in class javax.net.SocketFactory

Parameters:

host - server hostname

port - server port

localHost - client hostname

localPort - client port

Returns:

socket connected to the specified host and port

Throws:

java.io.IOException - if an I/O error occurs when creating the socket

getDefaultCipherSuites

public java.lang.String[] getDefaultCipherSuites()

Returns the list of cipher suites which are enabled by default.

Specified by:

getDefaultCipherSuites in class javax.net.ssl.SSLSocketFactory

Returns:

cipher suites

getSupportedCipherSuites

public java.lang.String[] getSupportedCipherSuites()

Returns the names of the cipher suites which could be enabled for use on an SSL connection.

Specified by:

getSupportedCipherSuites in class javax.net.ssl.SSLSocketFactory

Returns:

cipher suites