org.apache.tomcat.util.net.jsse

Class JSSESocketFactory

java.lang.Object

org.apache.tomcat.util.net.ServerSocketFactory

org.apache.tomcat.util.net.jsse.JSSESocketFactory

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

JSSE14SocketFactory

public abstract class JSSESocketFactory
extends ServerSocketFactory

SSL server socket factory. It _requires_ a valid RSA key and JSSE.

Author:

Harish Prabandham, Costin Manolache, Stefan Freyr Stefansson, EKR -- renamed to JSSESocketFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	clientAuth
protected String[]	enabledCiphers
protected boolean	initialized
protected static com.sun.org.apache.commons.logging.Log	log
protected SSLServerSocketFactory	sslProxy

Fields inherited from class org.apache.tomcat.util.net.ServerSocketFactory

attributes, context

Constructor Summary

Constructors

Constructor and Description
JSSESocketFactory()

Method Summary

Modifier and Type	Method and Description
Socket	acceptSocket(ServerSocket socket) Wrapper function for accept().
ServerSocket	createSocket(int port) Returns a server socket which uses all network interfaces on the host, and is bound to a the specified port.
ServerSocket	createSocket(int port, int backlog) Returns a server socket which uses all network interfaces on the host, is bound to a the specified port, and uses the specified connection backlog.
ServerSocket	createSocket(int port, int backlog, InetAddress ifAddress) Returns a server socket which uses only the specified network interface on the local host, is bound to a the specified port, and uses the specified connection backlog.
protected String[]	getEnabledCiphers(String requestedCiphers, String[] supportedCiphers)
protected abstract String[]	getEnabledProtocols(SSLServerSocket socket, String requestedProtocols)
protected KeyStore	getKeystore(String pass)
protected String	getKeystorePassword()
protected KeyStore	getTrustStore()
void	handshake(Socket sock) Extra function to initiate the handshake.
abstract void	init() Reads the keystore and initializes the SSL socket factory.
protected abstract void	setEnabledProtocols(SSLServerSocket socket, String[] protocols) Set the SSL protocol variants to be enabled.

Methods inherited from class org.apache.tomcat.util.net.ServerSocketFactory

getDefault, getSSLContext, initSocket, setAttribute

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final com.sun.org.apache.commons.logging.Log log

initialized

protected boolean initialized

clientAuth

protected boolean clientAuth

sslProxy

protected SSLServerSocketFactory sslProxy

enabledCiphers

protected String[] enabledCiphers

Constructor Detail

JSSESocketFactory

public JSSESocketFactory()

Method Detail

createSocket

public ServerSocket createSocket(int port)
                          throws IOException

Description copied from class: ServerSocketFactory

Returns a server socket which uses all network interfaces on the host, and is bound to a the specified port. The socket is configured with the socket options (such as accept timeout) given to this factory.

Specified by:

createSocket in class ServerSocketFactory

Parameters:

port - the port to listen to

Throws:

IOException - for networking errors

createSocket

public ServerSocket createSocket(int port,
                                 int backlog)
                          throws IOException

Description copied from class: ServerSocketFactory

Returns a server socket which uses all network interfaces on the host, is bound to a the specified port, and uses the specified connection backlog. The socket is configured with the socket options (such as accept timeout) given to this factory.

Specified by:

createSocket in class ServerSocketFactory

Parameters:

port - the port to listen to

backlog - how many connections are queued

Throws:

IOException - for networking errors

createSocket

public ServerSocket createSocket(int port,
                                 int backlog,
                                 InetAddress ifAddress)
                          throws IOException

Description copied from class: ServerSocketFactory

Returns a server socket which uses only the specified network interface on the local host, is bound to a the specified port, and uses the specified connection backlog. The socket is configured with the socket options (such as accept timeout) given to this factory.

Specified by:

createSocket in class ServerSocketFactory

Parameters:

port - the port to listen to

backlog - how many connections are queued

ifAddress - the network interface address to use

Throws:

IOException - for networking errors

acceptSocket

public Socket acceptSocket(ServerSocket socket)
                    throws IOException

Description copied from class: ServerSocketFactory

Wrapper function for accept(). This allows us to trap and translate exceptions if necessary

Specified by:

acceptSocket in class ServerSocketFactory

Throws:

IOException

handshake

public void handshake(Socket sock)
               throws IOException

Description copied from class: ServerSocketFactory

Extra function to initiate the handshake. Sometimes necessary for SSL

Specified by:

handshake in class ServerSocketFactory

Throws:

IOException

getEnabledCiphers

protected String[] getEnabledCiphers(String requestedCiphers,
                                     String[] supportedCiphers)

getKeystorePassword

protected String getKeystorePassword()

getKeystore

protected KeyStore getKeystore(String pass)
                        throws IOException

Throws:

IOException

getTrustStore

protected KeyStore getTrustStore()
                          throws IOException

Throws:

IOException

init

public abstract void init()
                   throws IOException

Reads the keystore and initializes the SSL socket factory. Place holder method to initialize the KeyStore, etc.

Specified by:

init in class ServerSocketFactory

Throws:

IOException

getEnabledProtocols

protected abstract String[] getEnabledProtocols(SSLServerSocket socket,
                                                String requestedProtocols)

setEnabledProtocols

protected abstract void setEnabledProtocols(SSLServerSocket socket,
                                            String[] protocols)

Set the SSL protocol variants to be enabled.

Parameters:

socket - the SSLServerSocket.

protocols - the protocols to use.