winstone

Class HttpListener

java.lang.Object

winstone.HttpListener

All Implemented Interfaces:

Runnable, Listener

Direct Known Subclasses:

HttpsListener

public class HttpListener
extends Object
implements Listener, Runnable

Implements the main listener daemon thread. This is the class that gets launched by the command line, and owns the server socket, etc. Note that this class is also used as the base class for the HTTPS listener.

Version:

$Id: HttpListener.java,v 1.15 2007/05/01 04:39:49 rickknowles Exp $

Author:

Rick Knowles

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BACKLOG_COUNT
protected static int	CONNECTION_TIMEOUT
protected static boolean	DEFAULT_HNL
protected boolean	doHostnameLookups
protected HostGroup	hostGroup
protected boolean	interrupted
protected static int	KEEP_ALIVE_SLEEP
protected static int	KEEP_ALIVE_SLEEP_MAX
protected int	keepAliveTimeout
protected String	listenAddress
protected static int	LISTENER_TIMEOUT
protected int	listenPort
protected ObjectPool	objectPool

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpListener()
	HttpListener(Map args, ObjectPool objectPool, HostGroup hostGroup) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	allocateRequestResponse(Socket socket, InputStream inSocket, OutputStream outSocket, RequestHandlerThread handler, boolean iAmFirst) Called by the request handler thread, because it needs specific setup code for this connection's protocol (ie construction of request/response objects, in/out streams, etc).
void	deallocateRequestResponse(RequestHandlerThread handler, WinstoneRequest req, WinstoneResponse rsp, WinstoneInputStream inData, WinstoneOutputStream outData) Called by the request handler thread, because it needs specific shutdown code for this connection's protocol (ie releasing input/output streams, etc).
void	destroy() Interrupts the listener thread.
protected String	getConnectorName() The name to use when getting properties - this is just so that we can override for the SSL connector.
protected String	getConnectorScheme()
protected int	getDefaultPort() The default port to use - this is just so that we can override for the SSL connector.
protected ServerSocket	getServerSocket() Gets a server socket - this is mostly for the purpose of allowing an override in the SSL connector.
void	parseHeaders(WinstoneRequest req, WinstoneInputStream inData) Parse the incoming stream into a list of headers (stopping at the first blank line), then call the parseHeaders(req, list) method on that list.
protected void	parseSocketInfo(Socket socket, WinstoneRequest req)
String	parseURI(RequestHandlerThread handler, WinstoneRequest req, WinstoneResponse rsp, WinstoneInputStream inData, Socket socket, boolean iAmFirst) Called by the request handler thread, because it needs specific shutdown code for this connection's protocol if the keep-alive period expires (ie closing sockets, etc).The iAmFirst variable identifies whether or not this is the initial request on on this socket (ie a keep alive or a first-time accept)
boolean	processKeepAlive(WinstoneRequest request, WinstoneResponse response, InputStream inSocket) Tries to wait for extra requests on the same socket.
void	releaseSocket(Socket socket, InputStream inSocket, OutputStream outSocket) Called by the request handler thread, because it needs specific shutdown code for this connection's protocol if the keep-alive period expires (ie closing sockets, etc).
void	run() The main run method.
boolean	start() After the listener is loaded and initialized, this starts the thread

Methods inherited from class java.lang.Object

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

Field Detail

LISTENER_TIMEOUT

protected static int LISTENER_TIMEOUT

CONNECTION_TIMEOUT

protected static int CONNECTION_TIMEOUT

BACKLOG_COUNT

protected static int BACKLOG_COUNT

DEFAULT_HNL

protected static boolean DEFAULT_HNL

keepAliveTimeout

protected int keepAliveTimeout

KEEP_ALIVE_SLEEP

protected static int KEEP_ALIVE_SLEEP

KEEP_ALIVE_SLEEP_MAX

protected static int KEEP_ALIVE_SLEEP_MAX

hostGroup

protected HostGroup hostGroup

objectPool

protected ObjectPool objectPool

doHostnameLookups

protected boolean doHostnameLookups

listenPort

protected int listenPort

listenAddress

protected String listenAddress

interrupted

protected boolean interrupted

Constructor Detail

HttpListener

protected HttpListener()

HttpListener

public HttpListener(Map args,
            ObjectPool objectPool,
            HostGroup hostGroup)

Constructor

Method Detail

start

public boolean start()
              throws IOException

Description copied from interface: Listener

After the listener is loaded and initialized, this starts the thread

Specified by:

start in interface Listener

Throws:

IOException

getDefaultPort

protected int getDefaultPort()

The default port to use - this is just so that we can override for the SSL connector.

getConnectorName

protected String getConnectorName()

The name to use when getting properties - this is just so that we can override for the SSL connector.

getConnectorScheme

protected String getConnectorScheme()

getServerSocket

protected ServerSocket getServerSocket()
                                throws IOException

Gets a server socket - this is mostly for the purpose of allowing an override in the SSL connector.

Throws:

IOException

run

public void run()

The main run method. This continually listens for incoming connections, and allocates any that it finds to a request handler thread, before going back to listen again.

Specified by:

run in interface Runnable

destroy

public void destroy()

Interrupts the listener thread. This will trigger a listener shutdown once the so timeout has passed.

Specified by:

destroy in interface Listener

allocateRequestResponse

public void allocateRequestResponse(Socket socket,
                           InputStream inSocket,
                           OutputStream outSocket,
                           RequestHandlerThread handler,
                           boolean iAmFirst)
                             throws SocketException,
                                    IOException

Called by the request handler thread, because it needs specific setup code for this connection's protocol (ie construction of request/response objects, in/out streams, etc). This implementation parses incoming AJP13 packets, and builds an outputstream that is capable of writing back the response in AJP13 packets.

Specified by:

allocateRequestResponse in interface Listener

Throws:

SocketException

IOException

deallocateRequestResponse

public void deallocateRequestResponse(RequestHandlerThread handler,
                             WinstoneRequest req,
                             WinstoneResponse rsp,
                             WinstoneInputStream inData,
                             WinstoneOutputStream outData)

Called by the request handler thread, because it needs specific shutdown code for this connection's protocol (ie releasing input/output streams, etc).

Specified by:

deallocateRequestResponse in interface Listener

parseURI

public String parseURI(RequestHandlerThread handler,
              WinstoneRequest req,
              WinstoneResponse rsp,
              WinstoneInputStream inData,
              Socket socket,
              boolean iAmFirst)
                throws IOException

Description copied from interface: Listener

Called by the request handler thread, because it needs specific shutdown code for this connection's protocol if the keep-alive period expires (ie closing sockets, etc).The iAmFirst variable identifies whether or not this is the initial request on on this socket (ie a keep alive or a first-time accept)

Specified by:

parseURI in interface Listener

Throws:

IOException

releaseSocket

public void releaseSocket(Socket socket,
                 InputStream inSocket,
                 OutputStream outSocket)
                   throws IOException

Called by the request handler thread, because it needs specific shutdown code for this connection's protocol if the keep-alive period expires (ie closing sockets, etc). This implementation simply shuts down the socket and streams.

Specified by:

releaseSocket in interface Listener

Throws:

IOException

parseSocketInfo

protected void parseSocketInfo(Socket socket,
                   WinstoneRequest req)
                        throws IOException

Throws:

IOException

processKeepAlive

public boolean processKeepAlive(WinstoneRequest request,
                       WinstoneResponse response,
                       InputStream inSocket)

Tries to wait for extra requests on the same socket. If any are found before the timeout expires, it exits with a true, indicating a new request is waiting. If the protocol does not support keep-alives, or the request instructed us to close the connection, or the timeout expires, return a false, instructing the handler thread to begin shutting down the socket and relase itself.

Specified by:

processKeepAlive in interface Listener

parseHeaders

public void parseHeaders(WinstoneRequest req,
                WinstoneInputStream inData)
                  throws IOException

Parse the incoming stream into a list of headers (stopping at the first blank line), then call the parseHeaders(req, list) method on that list.

Throws:

IOException