Package org.apache.xmlrpc.webserver

Class Connection

java.lang.Object

org.apache.xmlrpc.webserver.Connection

All Implemented Interfaces:

ServerStreamConnection, ThreadPool.InterruptableTask, ThreadPool.Task

public class Connection
extends Object
implements ThreadPool.InterruptableTask, ServerStreamConnection

Handler for a single clients connection. This implementation is able to do HTTP keepalive. In other words, it can serve multiple requests via a single, physical connection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	Connection.BadEncodingException
private static class	Connection.BadRequestException
private static class	Connection.RequestException

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	buffer
private static final byte[]	clength
private static final byte[]	conclose
private static final byte[]	conkeep
private static final byte[]	ctype
private static final byte[]	doubleNewline
private boolean	firstByte
private Map	headers
private final InputStream	input
private static final byte[]	newline
private static final byte[]	ok
private final OutputStream	output
private RequestData	requestData
private final XmlRpcStreamServer	server
private static final byte[]	serverName
private boolean	shuttingDown
private final Socket	socket
private static final String	US_ASCII
private final WebServer	webServer
private static final byte[]	wwwAuthenticate

Constructor Summary

Constructors

Constructor	Description
Connection(WebServer pWebServer, XmlRpcStreamServer pServer, Socket pSocket)	Creates a new webserver connection on the given socket.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the connection, and frees resources.
private RequestData	getRequestConfig()	Returns the connections request configuration by merging the HTTP request headers and the servers configuration.
InputStream	newInputStream()	Returns the connections input stream.
OutputStream	newOutputStream()	Returns the connections output stream.
private String	readLine()
void	run()	Performs the task.
void	setResponseHeader(String pHeader, String pValue)	Sets a response header value.
void	shutdown()	Interrupts the task.
private static final byte[]	toHTTPBytes(String text)	Returns the US-ASCII encoded byte representation of text for HTTP use (as per section 2.2 of RFC 2068).
private void	writeContentLengthHeader(int pContentLength)
void	writeError(RequestData pData, Throwable pError, ByteArrayOutputStream pStream)	Writes an error response to the output stream.
void	writeErrorHeader(RequestData pData, Throwable pError, int pContentLength)	Writes an error responses headers to the output stream.
void	writeResponse(RequestData pData, OutputStream pBuffer)	Writes the response header and the response to the output stream.
void	writeResponseHeader(RequestData pData, int pContentLength)	Writes the response header to the output stream.

Methods inherited from class java.lang.Object

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

Field Details

US_ASCII

private static final String US_ASCII

See Also:

• Constant Field Values

ctype

private static final byte[] ctype

clength

private static final byte[] clength

newline

private static final byte[] newline

doubleNewline

private static final byte[] doubleNewline

conkeep

private static final byte[] conkeep

conclose

private static final byte[] conclose

ok

private static final byte[] ok

serverName

private static final byte[] serverName

wwwAuthenticate

private static final byte[] wwwAuthenticate

webServer

private final WebServer webServer

socket

private final Socket socket

input

private final InputStream input

output

private final OutputStream output

server

private final XmlRpcStreamServer server

buffer

private byte[] buffer

headers

private Map headers

requestData

private RequestData requestData

shuttingDown

private boolean shuttingDown

firstByte

private boolean firstByte

Constructor Details

Connection

public Connection(WebServer pWebServer,
 XmlRpcStreamServer pServer,
 Socket pSocket)
           throws IOException

Creates a new webserver connection on the given socket.

Parameters:

pWebServer - The webserver maintaining this connection.

pServer - The server being used to execute requests.

pSocket - The server socket to handle; the Connection is responsible for closing this socket.

Throws:

IOException

Method Details

toHTTPBytes

private static final byte[] toHTTPBytes(String text)

Returns the US-ASCII encoded byte representation of text for HTTP use (as per section 2.2 of RFC 2068).

getRequestConfig

private RequestData getRequestConfig()
                              throws IOException

Returns the connections request configuration by merging the HTTP request headers and the servers configuration.

Returns:

The connections request configuration.

Throws:

IOException - Reading the request headers failed.

run

public void run()

Description copied from interface: ThreadPool.Task

Performs the task.

Specified by:

run in interface ThreadPool.Task

readLine

private String readLine()
                 throws IOException

Throws:

IOException

writeResponse

public void writeResponse(RequestData pData,
 OutputStream pBuffer)
                   throws IOException

Writes the response header and the response to the output stream.

Parameters:

pData - The request data.

pBuffer - The ByteArrayOutputStream holding the response.

Throws:

IOException - Writing the response failed.

writeResponseHeader

public void writeResponseHeader(RequestData pData,
 int pContentLength)
                         throws IOException

Writes the response header to the output stream. *

Parameters:

pData - The request data

pContentLength - The content length, if known, or -1.

Throws:

IOException - Writing the response failed.

writeError

public void writeError(RequestData pData,
 Throwable pError,
 ByteArrayOutputStream pStream)
                throws IOException

Writes an error response to the output stream.

Parameters:

pData - The request data.

pError - The error being reported.

pStream - The ByteArrayOutputStream with the error response.

Throws:

IOException - Writing the response failed.

writeErrorHeader

public void writeErrorHeader(RequestData pData,
 Throwable pError,
 int pContentLength)
                      throws IOException

Writes an error responses headers to the output stream.

Parameters:

pData - The request data.

pError - The error being reported.

pContentLength - The response length, if known, or -1.

Throws:

IOException - Writing the response failed.

writeContentLengthHeader

private void writeContentLengthHeader(int pContentLength)
                               throws IOException

Throws:

IOException

setResponseHeader

public void setResponseHeader(String pHeader,
 String pValue)

Sets a response header value.

newOutputStream

public OutputStream newOutputStream()
                             throws IOException

Description copied from interface: ServerStreamConnection

Returns the connections output stream.

Specified by:

newOutputStream in interface ServerStreamConnection

Throws:

IOException

newInputStream

public InputStream newInputStream()
                           throws IOException

Description copied from interface: ServerStreamConnection

Returns the connections input stream.

Specified by:

newInputStream in interface ServerStreamConnection

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: ServerStreamConnection

Closes the connection, and frees resources.

Specified by:

close in interface ServerStreamConnection

Throws:

IOException

shutdown

public void shutdown()
              throws Throwable

Description copied from interface: ThreadPool.InterruptableTask

Interrupts the task.

Specified by:

shutdown in interface ThreadPool.InterruptableTask

Throws:

Throwable - Shutting down the task failed.