org.openqa.jetty.http

Class JsseListener

java.lang.Object

org.openqa.jetty.util.ThreadPool

org.openqa.jetty.util.ThreadedServer

org.openqa.jetty.http.SocketListener

org.openqa.jetty.http.JsseListener

All Implemented Interfaces:

Serializable, HttpListener, LifeCycle

Direct Known Subclasses:

SunJsseListener

Deprecated.

use SslListener

public abstract class JsseListener
extends SocketListener

JSSE Socket Listener. This specialization of HttpListener is an abstract listener that can be used as the basis for a specific JSSE listener. This is heavily based on the work from Court Demas, which in turn is based on the work from Forge Research.

Version:

$Id: JsseListener.java,v 1.19 2005/11/03 18:21:59 gregwilkins Exp $

Author:

Greg Wilkins ([email protected]), Court Demas ([email protected]), Forge Research Pty Ltd ACN 003 491 576, Jan Hlavatý

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.openqa.jetty.util.ThreadPool

ThreadPool.PoolThread

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_KEYSTORE Deprecated. Default value for the keystore location path.
static String	DEFAULT_KEYSTORE_PROVIDER_CLASS Deprecated. Default value for keystore provider class.
static String	DEFAULT_KEYSTORE_PROVIDER_NAME Deprecated. Default value for keystore provider name.
static String	DEFAULT_KEYSTORE_TYPE Deprecated. Default keystore type
static String	KEYPASSWORD_PROPERTY Deprecated. String name of key password property.
static String	KEYSTORE_PROPERTY Deprecated. String name of keystore location path property.
static String	KEYSTORE_PROVIDER_CLASS_PROPERTY Deprecated. String name of keystore provider class property
static String	KEYSTORE_PROVIDER_NAME_PROPERTY Deprecated. String name of keystore provider name property
static String	KEYSTORE_TYPE_PROPERTY Deprecated. String name of keystore type property
static String	PASSWORD_PROPERTY Deprecated. String name of keystore password property.

Fields inherited from class org.openqa.jetty.util.ThreadPool

__DAEMON, __PRIORITY

Fields inherited from interface org.openqa.jetty.http.HttpListener

ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
JsseListener() Deprecated. Constructor.
JsseListener(InetAddrPort p_address) Deprecated. Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Socket	accept(ServerSocket p_serverSocket) Deprecated.
protected abstract SSLServerSocketFactory	createFactory() Deprecated.
protected void	customizeRequest(Socket socket, HttpRequest request) Deprecated. Allow the Listener a chance to customise the request.
boolean	getNeedClientAuth() Deprecated.
boolean	isConfidential(HttpConnection connection) Deprecated. By default, we're confidential, given we speak SSL.
boolean	isIntegral(HttpConnection connection) Deprecated. By default, we're integral, given we speak SSL.
protected ServerSocket	newServerSocket(InetAddrPort p_address, int p_acceptQueueSize) Deprecated. New server socket.
void	setNeedClientAuth(boolean needClientAuth) Deprecated. Set the value of the needClientAuth property

Methods inherited from class org.openqa.jetty.http.SocketListener

createConnection, customizeRequest, getBufferReserve, getBufferSize, getConfidentialPort, getConfidentialScheme, getDefaultScheme, getHttpHandler, getHttpServer, getIdentifyListener, getIntegralPort, getIntegralScheme, getLowResourcePersistTimeMs, getLowResources, handleConnection, isLowOnResources, isOutOfResources, persistConnection, setBufferReserve, setBufferSize, setConfidentialPort, setConfidentialScheme, setDefaultScheme, setHttpHandler, setHttpServer, setIdentifyListener, setIntegralPort, setIntegralScheme, setLowResourcePersistTimeMs, setLowResources, start, stop

Methods inherited from class org.openqa.jetty.util.ThreadedServer

acceptSocket, acceptSocket, getAcceptorThreads, getAcceptQueueSize, getHost, getInetAddress, getInetAddrPort, getLingerTimeSecs, getMaxReadTimeMs, getPort, getServerSocket, getTcpNoDelay, handle, handleConnection, open, setAcceptorThreads, setAcceptQueueSize, setHost, setInetAddress, setInetAddrPort, setLingerTimeSecs, setMaxReadTimeMs, setPort, setTcpNoDelay, stopJob, toString

Methods inherited from class org.openqa.jetty.util.ThreadPool

getIdleThreads, getMaxIdleTimeMs, getMaxThreads, getMinThreads, getName, getPoolName, getThreads, getThreadsPriority, isDaemon, isStarted, join, run, setDaemon, setMaxIdleTimeMs, setMaxStopTimeMs, setMaxThreads, setMinThreads, setName, setPoolName, setThreadsPriority, shrink

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openqa.jetty.http.HttpListener

getHost, getPort, setHost, setPort

Methods inherited from interface org.openqa.jetty.util.LifeCycle

isStarted

Field Detail

KEYSTORE_PROPERTY

public static final String KEYSTORE_PROPERTY

Deprecated.

String name of keystore location path property.

See Also:

Constant Field Values

KEYSTORE_TYPE_PROPERTY

public static final String KEYSTORE_TYPE_PROPERTY

Deprecated.

String name of keystore type property

See Also:

Constant Field Values

DEFAULT_KEYSTORE_TYPE

public static final String DEFAULT_KEYSTORE_TYPE

Deprecated.

Default keystore type

KEYSTORE_PROVIDER_NAME_PROPERTY

public static final String KEYSTORE_PROVIDER_NAME_PROPERTY

Deprecated.

String name of keystore provider name property

See Also:

Constant Field Values

KEYSTORE_PROVIDER_CLASS_PROPERTY

public static final String KEYSTORE_PROVIDER_CLASS_PROPERTY

Deprecated.

String name of keystore provider class property

See Also:

Constant Field Values

DEFAULT_KEYSTORE_PROVIDER_CLASS

public static final String DEFAULT_KEYSTORE_PROVIDER_CLASS

Deprecated.

Default value for keystore provider class. null = use default

DEFAULT_KEYSTORE

public static final String DEFAULT_KEYSTORE

Deprecated.

Default value for the keystore location path.

DEFAULT_KEYSTORE_PROVIDER_NAME

public static final String DEFAULT_KEYSTORE_PROVIDER_NAME

Deprecated.

Default value for keystore provider name. null = use default

PASSWORD_PROPERTY

public static final String PASSWORD_PROPERTY

Deprecated.

String name of keystore password property.

See Also:

Constant Field Values

KEYPASSWORD_PROPERTY

public static final String KEYPASSWORD_PROPERTY

Deprecated.

String name of key password property.

See Also:

Constant Field Values

Constructor Detail

JsseListener

public JsseListener()

Deprecated.

Constructor.

JsseListener

public JsseListener(InetAddrPort p_address)

Deprecated.

Constructor.

Parameters:

p_address -

Method Detail

setNeedClientAuth

public void setNeedClientAuth(boolean needClientAuth)

Deprecated.

Set the value of the needClientAuth property

Parameters:

needClientAuth - true iff we require client certificate authentication.

getNeedClientAuth

public boolean getNeedClientAuth()

Deprecated.

isIntegral

public boolean isIntegral(HttpConnection connection)

Deprecated.

By default, we're integral, given we speak SSL. But, if we've been told about an integral port, and said port is not our port, then we're not. This allows separation of listeners providing INTEGRAL versus CONFIDENTIAL constraints, such as one SSL listener configured to require client certs providing CONFIDENTIAL, whereas another SSL listener not requiring client certs providing mere INTEGRAL constraints.

Specified by:

isIntegral in interface HttpListener

Overrides:

isIntegral in class SocketListener

Parameters:

connection - The connection to test.

Returns:

True of the connection checks the integrity of the data. For most implementations this is true for https connections.

isConfidential

public boolean isConfidential(HttpConnection connection)

Deprecated.

By default, we're confidential, given we speak SSL. But, if we've been told about an confidential port, and said port is not our port, then we're not. This allows separation of listeners providing INTEGRAL versus CONFIDENTIAL constraints, such as one SSL listener configured to require client certs providing CONFIDENTIAL, whereas another SSL listener not requiring client certs providing mere INTEGRAL constraints.

Specified by:

isConfidential in interface HttpListener

Overrides:

isConfidential in class SocketListener

Parameters:

connection - The connection to test.

Returns:

True of the connection checks the integrity of the data. For most implementations this is true for https connections.

createFactory

protected abstract SSLServerSocketFactory createFactory()
                                                 throws Exception

Deprecated.

Throws:

Exception

newServerSocket

protected ServerSocket newServerSocket(InetAddrPort p_address,
                           int p_acceptQueueSize)
                                throws IOException

Deprecated.

Description copied from class: ThreadedServer

New server socket. Creates a new servers socket. May be overriden by derived class to create specialist serversockets (eg SSL).

Overrides:

newServerSocket in class ThreadedServer

Parameters:

p_address -

p_acceptQueueSize -

Returns:

A ServerSocket object using the passed parameters to set it up from an SSLServerSocketFactory.

Throws:

IOException

accept

protected Socket accept(ServerSocket p_serverSocket)
                 throws IOException

Deprecated.

Parameters:

p_serverSocket -

Returns:

A Socket object, based on p_serverSocket, with SSL enabled.

Throws:

IOException

customizeRequest

protected void customizeRequest(Socket socket,
                    HttpRequest request)

Deprecated.

Allow the Listener a chance to customise the request. before the server does its stuff.
This allows the required attributes to be set for SSL requests.
The requirements of the Servlet specs are:

• an attribute named "javax.servlet.request.cipher_suite" of type String.
• an attribute named "javax.servlet.request.key_size" of type Integer.
• an attribute named "javax.servlet.request.X509Certificate" of type java.security.cert.X509Certificate[]. This is an array of objects of type X509Certificate, the order of this array is defined as being in ascending order of trust. The first certificate in the chain is the one set by the client, the next is the one used to authenticate the first, and so on.

Overrides:

customizeRequest in class SocketListener

Parameters:

socket - The Socket the request arrived on. This should be a javax.net.ssl.SSLSocket.

request - HttpRequest to be customised.