A HttpConnection represents the connection of a HTTP client to the server and is created by an instance of a Connector. It's prime function is to associate Request and Response instances with a EndPoint.

A connection is also the prime mechanism used by jetty to recycle objects without pooling. The Request, Response, HttpParser, HttpGenerator and HttpFields instances are all recycled for the duraction of a connection. Where appropriate, allocated buffers are also kept associated with the connection via the parser and/or generator.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public class	HttpConnection.Output
public class	HttpConnection.OutputWriter
private class	HttpConnection.RequestHandler

Field Summary

Modifier and Type	Field and Description
private static ThreadLocal<HttpConnection>	__currentConnection
private Object	_associatedObject
protected final Connector	_connector
private transient boolean	_delayedHandling
private boolean	_destroy
protected final EndPoint	_endp
private transient int	_expect
protected final Generator	_generator
private boolean	_handling
private transient boolean	_head
private transient boolean	_host
protected ServletInputStream	_in
pack-priv int	_include
protected HttpConnection.Output	_out
protected final Parser	_parser
protected PrintWriter	_printWriter
protected final Request	_request
protected final HttpFields	_requestFields
private int	_requests
protected final Response	_response
protected final HttpFields	_responseFields
protected final Server	_server
private long	_timeStamp
protected final HttpURI	_uri
private transient int	_version
protected HttpConnection.OutputWriter	_writer
private static int	UNKNOWN

Constructor Summary

Access	Constructor and Description
public	HttpConnection(Connector connector, EndPoint endpoint, Server server) Constructor
protected	HttpConnection(Connector connector, EndPoint endpoint, Server server, Parser parser, Generator generator, Request request)

Method Summary

Modifier and Type	Method and Description
public void	cancelTimeout(Timeout.Task task)
public void	commitResponse(boolean last)
public void	completeResponse()
public void	destroy()
public void	flushResponse()
public Object	Returns: Returns the associatedObject. getAssociatedObject()
public Connector	Returns: Returns the connector. getConnector()
public static HttpConnection	getCurrentConnection()
public EndPoint	Returns: The `EndPoint` for this connection. getEndPoint()
public Generator	getGenerator()
public ServletInputStream	Returns: The input stream for this connection. The stream will be created if it does not already exist. getInputStream()
public ServletOutputStream	Returns: The output stream for this connection. The stream will be created if it does not already exist. getOutputStream()
public Parser	Returns: the parser used by this connection getParser()
public PrintWriter	Returns: A `PrintWriter` wrapping the `output stream`. The writer is created if it does not already exist. getPrintWriter(String encoding)
public Request	Returns: Returns the request. getRequest()
public HttpFields	Returns: Returns the requestFields. getRequestFields()
public int	Returns: the number of requests handled by this connection getRequests()
public boolean	Returns: `false` (this method is not yet implemented) getResolveNames()
public Response	Returns: Returns the response. getResponse()
public HttpFields	Returns: Returns the responseFields. getResponseFields()
public long	Returns: The time this connection was established. getTimeStamp()
public void	handle() Implements org.mortbay.io.Connection.handle.
protected void	handleRequest()
public void	include()
public void	included()
public boolean	Returns: The result of calling `getConnector`.`isCondidential`(request), or false if there is no connector. isConfidential(Request request)
public boolean	isIdle() Implements org.mortbay.io.Connection.isIdle.
public boolean	isIncluding()
public boolean	Returns: `true` if there is a `connector` and it considers `request` to be `integral` isIntegral(Request request) Find out if the request is INTEGRAL security.
public boolean	isResponseCommitted()
public void	reset(boolean returnBuffers)
public void	scheduleTimeout(Timeout.Task task, long timeoutMs)
public void	setAssociatedObject(Object The associatedObject to set. associatedObject)
protected static void	setCurrentConnection(HttpConnection connection)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

__currentConnection	back to summary
private static ThreadLocal<HttpConnection> __currentConnection

_associatedObject	back to summary
private Object _associatedObject

_connector	back to summary
protected final Connector _connector

_delayedHandling	back to summary
private transient boolean _delayedHandling

_destroy	back to summary
private boolean _destroy

_endp	back to summary
protected final EndPoint _endp

_expect	back to summary
private transient int _expect

_generator	back to summary
protected final Generator _generator

_handling	back to summary
private boolean _handling

_head	back to summary
private transient boolean _head

_host	back to summary
private transient boolean _host

_in	back to summary
protected ServletInputStream _in

_include	back to summary
pack-priv int _include

_out	back to summary
protected HttpConnection.Output _out

_parser	back to summary
protected final Parser _parser

_printWriter	back to summary
protected PrintWriter _printWriter

_request	back to summary
protected final Request _request

_requestFields	back to summary
protected final HttpFields _requestFields

_requests	back to summary
private int _requests

_response	back to summary
protected final Response _response

_responseFields	back to summary
protected final HttpFields _responseFields

_server	back to summary
protected final Server _server

_timeStamp	back to summary
private long _timeStamp

_uri	back to summary
protected final HttpURI _uri

_version	back to summary
private transient int _version

_writer	back to summary
protected HttpConnection.OutputWriter _writer

UNKNOWN	back to summary
private static int UNKNOWN

Constructor Detail

HttpConnection	back to summary
public HttpConnection(Connector connector, EndPoint endpoint, Server server) Constructor

HttpConnection	back to summary
protected HttpConnection(Connector connector, EndPoint endpoint, Server server, Parser parser, Generator generator, Request request)

Method Detail

cancelTimeout	back to summary
public void cancelTimeout(Timeout.Task task)

commitResponse	back to summary
public void commitResponse(boolean last) throws IOException

completeResponse	back to summary
public void completeResponse() throws IOException

destroy	back to summary
public void destroy()

flushResponse	back to summary
public void flushResponse() throws IOException

getAssociatedObject	back to summary
public Object getAssociatedObject() Returns:Object Returns the associatedObject.

getConnector	back to summary
public Connector getConnector() Returns:Connector Returns the connector.

getCurrentConnection	back to summary
public static HttpConnection getCurrentConnection()

getEndPoint	back to summary
public EndPoint getEndPoint() Returns:EndPoint The `EndPoint` for this connection.

getGenerator	back to summary
public Generator getGenerator()

getInputStream	back to summary
public ServletInputStream getInputStream() throws IOException Returns:ServletInputStream The input stream for this connection. The stream will be created if it does not already exist.

getOutputStream	back to summary
public ServletOutputStream getOutputStream() Returns:ServletOutputStream The output stream for this connection. The stream will be created if it does not already exist.

getParser	back to summary
public Parser getParser() Returns:Parser the parser used by this connection

getPrintWriter	back to summary
public PrintWriter getPrintWriter(String encoding) Returns:PrintWriter A `PrintWriter` wrapping the `output stream`. The writer is created if it does not already exist.

getRequest	back to summary
public Request getRequest() Returns:Request Returns the request.

getRequestFields	back to summary
public HttpFields getRequestFields() Returns:HttpFields Returns the requestFields.

getRequests	back to summary
public int getRequests() Returns:int the number of requests handled by this connection

getResolveNames	back to summary
public boolean getResolveNames() Returns:boolean `false` (this method is not yet implemented)

getResponse	back to summary
public Response getResponse() Returns:Response Returns the response.

getResponseFields	back to summary
public HttpFields getResponseFields() Returns:HttpFields Returns the responseFields.

getTimeStamp	back to summary
public long getTimeStamp() Returns:long The time this connection was established.

handle	back to summary
public void handle() throws IOException Implements org.mortbay.io.Connection.handle.

handleRequest	back to summary
protected void handleRequest() throws IOException

include	back to summary
public void include()

included	back to summary
public void included()

isConfidential	back to summary
public boolean isConfidential(Request request) Returns:boolean The result of calling `getConnector`.`isCondidential`(request), or false if there is no connector.

isIdle	back to summary
public boolean isIdle() Implements org.mortbay.io.Connection.isIdle.

isIncluding	back to summary
public boolean isIncluding()

isIntegral back to summary

public boolean isIntegral(Request request)

Find out if the request is INTEGRAL security.

Returns:boolean: true if there is a connector and it considers request to be integral

isResponseCommitted	back to summary
public boolean isResponseCommitted()

reset	back to summary
public void reset(boolean returnBuffers)

scheduleTimeout	back to summary
public void scheduleTimeout(Timeout.Task task, long timeoutMs)

setAssociatedObject	back to summary
public void setAssociatedObject(Object associatedObject) Parameters associatedObject:Object The associatedObject to set.

setCurrentConnection	back to summary
protected static void setCurrentConnection(HttpConnection connection)

org.mortbay.jetty back to summary

public Class HttpConnection.Output

Class Inheritance

extends Output

java.lang.Object
java.io.OutputStream
javax.servlet.ServletOutputStream
org.mortbay.jetty.AbstractGenerator.Output
org.mortbay.jetty.HttpConnection.Output

Field Summary

Inherited from org.mortbay.jetty.AbstractGenerator.Output:: _buf _bytes _characterEncoding _chars _closed _converter _generator _maxIdleTime

Constructor Summary

Access	Constructor and Description
pack-priv	Output()

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides org.mortbay.jetty.AbstractGenerator.Output.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	flush() Overrides org.mortbay.jetty.AbstractGenerator.Output.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out.
public void	print(String the `String` to send to the client s) Overrides org.mortbay.jetty.AbstractGenerator.Output.print. Writes a `String` to the client, without a carriage return-line feed (CRLF) character at the end.
public void	sendContent(Object content)
public void	sendResponse(Buffer response)

Inherited from org.mortbay.jetty.AbstractGenerator.Output:: blockForOutput reopen write write write

Constructor Detail

Output	back to summary
pack-priv Output()

Method Detail

close back to summary

public void close() throws IOException

Overrides org.mortbay.jetty.AbstractGenerator.Output.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions

IOException:: if an I/O error occurs.

flush back to summary

public void flush() throws IOException

Overrides org.mortbay.jetty.AbstractGenerator.Output.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Exceptions

IOException:: if an I/O error occurs.

print back to summary

public void print(String s) throws IOException

Overrides org.mortbay.jetty.AbstractGenerator.Output.print.

Doc from javax.servlet.ServletOutputStream.print.

Writes a String to the client, without a carriage return-line feed (CRLF) character at the end.

Parameters

s:String: the String to send to the client

Exceptions

IOException:: if an input or output exception occurred

sendContent	back to summary
public void sendContent(Object content) throws IOException

sendResponse	back to summary
public void sendResponse(Buffer response) throws IOException

org.mortbay.jetty back to summary

public Class HttpConnection.OutputWriter

Class Inheritance

extends OutputWriter

java.lang.Object
java.io.Writer
org.mortbay.jetty.AbstractGenerator.OutputWriter
org.mortbay.jetty.HttpConnection.OutputWriter

Field Summary

Inherited from org.mortbay.jetty.AbstractGenerator.OutputWriter:: _generator _out _surrogate _writeMode

Constructor Summary

Access	Constructor and Description
pack-priv	OutputWriter()

Method Summary

Inherited from org.mortbay.jetty.AbstractGenerator.OutputWriter:: close flush setCharacterEncoding write write

Constructor Detail

OutputWriter	back to summary
pack-priv OutputWriter()

org.mortbay.jetty back to summary

private Class HttpConnection.RequestHandler

Class Inheritance

extends EventHandler

java.lang.Object
org.mortbay.jetty.HttpParser.EventHandler
org.mortbay.jetty.HttpConnection.RequestHandler

Field Summary

Modifier and Type	Field and Description
private String	_charset

Constructor Summary

Access	Constructor and Description
private	RequestHandler()

Method Summary

Modifier and Type	Method and Description
public void	content(Buffer ref) Implements abstract org.mortbay.jetty.HttpParser.EventHandler.content.
public void	headerComplete() Overrides org.mortbay.jetty.HttpParser.EventHandler.headerComplete.
public void	messageComplete(long contextLength) Overrides org.mortbay.jetty.HttpParser.EventHandler.messageComplete.
public void	parsedHeader(Buffer name, Buffer value) Overrides org.mortbay.jetty.HttpParser.EventHandler.parsedHeader. This is the method called by parser when a HTTP Header name and value is found
public void	startRequest(Buffer method, Buffer uri, Buffer version) Implements abstract org.mortbay.jetty.HttpParser.EventHandler.startRequest. This is the method called by parser when the HTTP request line is parsed
public void	startResponse(Buffer version, int status, Buffer reason) Implements abstract org.mortbay.jetty.HttpParser.EventHandler.startResponse. This is the method called by parser when the HTTP request line is parsed

Field Detail

_charset	back to summary
private String _charset

Constructor Detail

RequestHandler	back to summary
private RequestHandler()

Method Detail

content	back to summary
public void content(Buffer ref) throws IOException Implements abstract org.mortbay.jetty.HttpParser.EventHandler.content.

headerComplete	back to summary
public void headerComplete() throws IOException Overrides org.mortbay.jetty.HttpParser.EventHandler.headerComplete.

messageComplete	back to summary
public void messageComplete(long contextLength) throws IOException Overrides org.mortbay.jetty.HttpParser.EventHandler.messageComplete.

parsedHeader

back to summary

public void parsedHeader(Buffer name, Buffer value)

Overrides org.mortbay.jetty.HttpParser.EventHandler.parsedHeader.

Doc from org.mortbay.jetty.HttpParser.EventHandler.parsedHeader.

This is the method called by parser when a HTTP Header name and value is found

startRequest

back to summary

public void startRequest(Buffer method, Buffer uri, Buffer version) throws IOException

Implements abstract org.mortbay.jetty.HttpParser.EventHandler.startRequest.

Doc from org.mortbay.jetty.HttpParser.EventHandler.startRequest.

This is the method called by parser when the HTTP request line is parsed

startResponse

back to summary

public void startResponse(Buffer version, int status, Buffer reason)

Implements abstract org.mortbay.jetty.HttpParser.EventHandler.startResponse.

Doc from org.mortbay.jetty.HttpParser.EventHandler.startResponse.

This is the method called by parser when the HTTP request line is parsed