Modifier and Type	Class and Description
public static class	AbstractGenerator.Output Output.
public static class	AbstractGenerator.OutputWriter OutputWriter.

Modifier and Type	Field and Description
private static Buffer[]	__reasons
protected Buffer	_buffer
protected Buffers	_buffers
protected boolean	_close
protected Buffer	_content
protected int	_contentBufferSize
protected long	_contentLength
protected long	_contentWritten
protected EndPoint	_endp
protected boolean	_head
protected Buffer	_header
protected int	_headerBufferSize
protected boolean	_last
protected Buffer	_method
protected boolean	_noContent
protected Buffer	_reason
private boolean	_sendServerVersion
protected int	_state
protected int	_status
protected String	_uri
protected int	_version
private static int	MAX_OUTPUT_CHARS
private static byte[]	NO_BYTES
public static final int	STATE_CONTENT
public static final int	STATE_END
public static final int	STATE_FLUSHING
public static final int	STATE_HEADER

Access	Constructor and Description
public	AbstractGenerator(Buffers buffer pool buffers, EndPoint io, int Size of the buffer to allocate for HTTP header headerBufferSize, int Size of the buffer to allocate for HTTP content contentBufferSize) Constructor.

Method Summary

Modifier and Type	Method and Description
public void	complete() Implements org.mortbay.jetty.Generator.complete. Complete the message.
public abstract void	completeHeader(HttpFields fields, boolean allContentAdded) Redeclares org.mortbay.jetty.Generator.completeHeader.
pack-priv void	completeUncheckedAddContent()
public abstract long	flush() Redeclares org.mortbay.jetty.Generator.flush.
public int	Returns: Returns the contentBufferSize. getContentBufferSize() Implements org.mortbay.jetty.Generator.getContentBufferSize.
public long	Returns: Returns the contentWritten. getContentWritten() Implements org.mortbay.jetty.Generator.getContentWritten.
public static String	getReason(int code)
protected static Buffer	getReasonBuffer(int code)
public boolean	getSendServerVersion()
public int	getState()
public Buffer	getUncheckedBuffer()
public int	getVersion()
public void	increaseContentBufferSize(int The contentBufferSize to set. contentBufferSize) Implements org.mortbay.jetty.Generator.increaseContentBufferSize.
public boolean	isBufferFull() Implements org.mortbay.jetty.Generator.isBufferFull.
public boolean	isCommitted() Implements org.mortbay.jetty.Generator.isCommitted.
public boolean	isComplete() Implements org.mortbay.jetty.Generator.isComplete.
public boolean	isContentWritten() Implements org.mortbay.jetty.Generator.isContentWritten.
public boolean	Returns: Returns the head. isHead()
public boolean	isIdle() Implements org.mortbay.jetty.Generator.isIdle.
public boolean	Returns: `false` if the connection should be closed after a request has been read, `true` if it should be used for additional requests. isPersistent() Implements org.mortbay.jetty.Generator.isPersistent.
public boolean	isState(int state)
protected abstract int	Returns: the available space in the buffer. prepareUncheckedAddContent() Prepare buffer for unchecked writes.
public void	reset(boolean returnBuffers) Implements org.mortbay.jetty.Generator.reset.
public void	resetBuffer() Implements org.mortbay.jetty.Generator.resetBuffer.
public void	sendError(int code, String reason, String content, boolean close) Implements org.mortbay.jetty.Generator.sendError. Utility method to send an error response.
public void	setContentLength(long value) Implements org.mortbay.jetty.Generator.setContentLength.
public void	setHead(boolean The head to set. head) Implements org.mortbay.jetty.Generator.setHead.
public void	setPersistent(boolean persistent) Implements org.mortbay.jetty.Generator.setPersistent.
public void	setRequest(String method, String uri) Implements org.mortbay.jetty.Generator.setRequest.
public void	setResponse(int The status code to send. status, String the status message to send. reason) Implements org.mortbay.jetty.Generator.setResponse.
public void	setSendServerVersion(boolean sendServerVersion) Implements org.mortbay.jetty.Generator.setSendServerVersion.
public void	setVersion(int The version of the client the response is being sent to (NB. Not the version in the response, which is the version of the server). version) Implements org.mortbay.jetty.Generator.setVersion.
pack-priv void	uncheckedAddContent(int b)

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

Field Detail

__reasons	back to summary
private static Buffer[] __reasons

_buffer	back to summary
protected Buffer _buffer

_buffers	back to summary
protected Buffers _buffers

_close	back to summary
protected boolean _close

_content	back to summary
protected Buffer _content

_contentBufferSize	back to summary
protected int _contentBufferSize

_contentLength	back to summary
protected long _contentLength

_contentWritten	back to summary
protected long _contentWritten

_endp	back to summary
protected EndPoint _endp

_head	back to summary
protected boolean _head

_header	back to summary
protected Buffer _header

_headerBufferSize	back to summary
protected int _headerBufferSize

_last	back to summary
protected boolean _last

_method	back to summary
protected Buffer _method

_noContent	back to summary
protected boolean _noContent

_reason	back to summary
protected Buffer _reason

_sendServerVersion	back to summary
private boolean _sendServerVersion

_state	back to summary
protected int _state

_status	back to summary
protected int _status

_uri	back to summary
protected String _uri

_version	back to summary
protected int _version

MAX_OUTPUT_CHARS	back to summary
private static int MAX_OUTPUT_CHARS

NO_BYTES	back to summary
private static byte[] NO_BYTES

STATE_CONTENT	back to summary
public static final int STATE_CONTENT

STATE_END	back to summary
public static final int STATE_END

STATE_FLUSHING	back to summary
public static final int STATE_FLUSHING

STATE_HEADER	back to summary
public static final int STATE_HEADER

Constructor Detail

AbstractGenerator	back to summary
public AbstractGenerator(Buffers buffers, EndPoint io, int headerBufferSize, int contentBufferSize) Constructor. Parameters buffers:Buffers buffer pool headerBufferSize:int Size of the buffer to allocate for HTTP header contentBufferSize:int Size of the buffer to allocate for HTTP content

AbstractGenerator

back to summary

public AbstractGenerator(Buffers buffers, EndPoint io, int headerBufferSize, int contentBufferSize)

Constructor.

Parameters

buffers:Buffers: buffer pool
headerBufferSize:int: Size of the buffer to allocate for HTTP header
contentBufferSize:int: Size of the buffer to allocate for HTTP content

Method Detail

complete	back to summary
public void complete() throws IOException Implements org.mortbay.jetty.Generator.complete. Complete the message.

complete

back to summary

public void complete() throws IOException

Implements org.mortbay.jetty.Generator.complete.

Complete the message.

completeHeader	back to summary
public abstract void completeHeader(HttpFields fields, boolean allContentAdded) throws IOException Redeclares org.mortbay.jetty.Generator.completeHeader.

completeUncheckedAddContent	back to summary
pack-priv void completeUncheckedAddContent()

flush	back to summary
public abstract long flush() throws IOException Redeclares org.mortbay.jetty.Generator.flush.

getContentBufferSize	back to summary
public int getContentBufferSize() Implements org.mortbay.jetty.Generator.getContentBufferSize. Returns:int Returns the contentBufferSize.

getContentBufferSize

back to summary

public int getContentBufferSize()

Implements org.mortbay.jetty.Generator.getContentBufferSize.

Returns:int: Returns the contentBufferSize.

getContentWritten	back to summary
public long getContentWritten() Implements org.mortbay.jetty.Generator.getContentWritten. Returns:long Returns the contentWritten.

getContentWritten

back to summary

public long getContentWritten()

Implements org.mortbay.jetty.Generator.getContentWritten.

Returns:long: Returns the contentWritten.

getReason	back to summary
public static String getReason(int code)

getReasonBuffer	back to summary
protected static Buffer getReasonBuffer(int code)

getSendServerVersion	back to summary
public boolean getSendServerVersion()

getState	back to summary
public int getState()

getUncheckedBuffer	back to summary
public Buffer getUncheckedBuffer()

getVersion	back to summary
public int getVersion()

increaseContentBufferSize	back to summary
public void increaseContentBufferSize(int contentBufferSize) Implements org.mortbay.jetty.Generator.increaseContentBufferSize. Parameters contentBufferSize:int The contentBufferSize to set.

increaseContentBufferSize

back to summary

public void increaseContentBufferSize(int contentBufferSize)

Implements org.mortbay.jetty.Generator.increaseContentBufferSize.

Parameters

contentBufferSize:int: The contentBufferSize to set.

isBufferFull	back to summary
public boolean isBufferFull() Implements org.mortbay.jetty.Generator.isBufferFull.

isCommitted	back to summary
public boolean isCommitted() Implements org.mortbay.jetty.Generator.isCommitted.

isComplete	back to summary
public boolean isComplete() Implements org.mortbay.jetty.Generator.isComplete.

isContentWritten	back to summary
public boolean isContentWritten() Implements org.mortbay.jetty.Generator.isContentWritten.

isHead	back to summary
public boolean isHead() Returns:boolean Returns the head.

isIdle	back to summary
public boolean isIdle() Implements org.mortbay.jetty.Generator.isIdle.

isPersistent back to summary

public boolean isPersistent()

Implements org.mortbay.jetty.Generator.isPersistent.

Returns:boolean: false if the connection should be closed after a request has been read, true if it should be used for additional requests.

isState	back to summary
public boolean isState(int state)

prepareUncheckedAddContent

back to summary

protected abstract int prepareUncheckedAddContent() throws IOException

Prepare buffer for unchecked writes. Prepare the generator buffer to receive unchecked writes

Returns:int: the available space in the buffer.

reset	back to summary
public void reset(boolean returnBuffers) Implements org.mortbay.jetty.Generator.reset.

resetBuffer	back to summary
public void resetBuffer() Implements org.mortbay.jetty.Generator.resetBuffer.

sendError

back to summary

public void sendError(int code, String reason, String content, boolean close) throws IOException

Implements org.mortbay.jetty.Generator.sendError.

Utility method to send an error response. If the builder is not committed, this call is equivalent to a setResponse, addcontent and complete call.

setContentLength	back to summary
public void setContentLength(long value) Implements org.mortbay.jetty.Generator.setContentLength.

setHead

back to summary

public void setHead(boolean head)

Implements org.mortbay.jetty.Generator.setHead.

Parameters

head:boolean: The head to set.

setPersistent	back to summary
public void setPersistent(boolean persistent) Implements org.mortbay.jetty.Generator.setPersistent.

setRequest	back to summary
public void setRequest(String method, String uri) Implements org.mortbay.jetty.Generator.setRequest.

setResponse

back to summary

public void setResponse(int status, String reason)

Implements org.mortbay.jetty.Generator.setResponse.

Parameters

status:int: The status code to send.
reason:String: the status message to send.

setSendServerVersion	back to summary
public void setSendServerVersion(boolean sendServerVersion) Implements org.mortbay.jetty.Generator.setSendServerVersion.

setVersion

back to summary

public void setVersion(int version)

Implements org.mortbay.jetty.Generator.setVersion.

Parameters

version:int: The version of the client the response is being sent to (NB. Not the version in the response, which is the version of the server).

uncheckedAddContent	back to summary
pack-priv void uncheckedAddContent(int b)

org.mortbay.jetty back to summary

public Class AbstractGenerator.Output

Class Inheritance

extends ServletOutputStream

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

Known Direct Subclasses

org.mortbay.jetty.HttpConnection.Output

Output.

Implements javax.servlet.ServletOutputStream from the javax.servlet package.

A ServletOutputStream implementation that writes content to a AbstractGenerator. The class is designed to be reused and can be reopened after a close.

Field Summary

Modifier and Type	Field and Description
protected ByteArrayBuffer	_buf
pack-priv ByteArrayOutputStream2	_bytes
pack-priv String	_characterEncoding
pack-priv char[]	_chars
protected boolean	_closed
pack-priv Writer	_converter
protected AbstractGenerator	_generator
protected long	_maxIdleTime

Constructor Summary

Access	Constructor and Description
public	Output(AbstractGenerator generator, long maxIdleTime)

Method Summary

Modifier and Type	Method and Description
pack-priv void	blockForOutput()
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	flush() Overrides java.io.OutputStream.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 javax.servlet.ServletOutputStream.print. Writes a `String` to the client, without a carriage return-line feed (CRLF) character at the end.
pack-priv void	reopen()
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
public void	write(byte[] the data. b) Overrides java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream.
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
private void	write(Buffer buffer)

Inherited from javax.servlet.ServletOutputStream:: isReady print print print print print print println println println println println println println println setWriteListener

Field Detail

_buf	back to summary
protected ByteArrayBuffer _buf

_bytes	back to summary
pack-priv ByteArrayOutputStream2 _bytes

_characterEncoding	back to summary
pack-priv String _characterEncoding

_chars	back to summary
pack-priv char[] _chars

_closed	back to summary
protected boolean _closed

_converter	back to summary
pack-priv Writer _converter

_generator	back to summary
protected AbstractGenerator _generator

_maxIdleTime	back to summary
protected long _maxIdleTime

Constructor Detail

Output	back to summary
public Output(AbstractGenerator generator, long maxIdleTime)

Method Detail

blockForOutput	back to summary
pack-priv void blockForOutput() throws IOException

close back to summary

public void close() throws IOException

Overrides java.io.OutputStream.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 java.io.OutputStream.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 javax.servlet.ServletOutputStream.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

reopen	back to summary
pack-priv void reopen()

write back to summary

public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

write back to summary

public void write(byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters

b:byte[]: the data.

Exceptions

IOException:: if an I/O error occurs.

write back to summary

public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write	back to summary
private void write(Buffer buffer) throws IOException

org.mortbay.jetty back to summary

public Class AbstractGenerator.OutputWriter

Class Inheritance

extends Writer

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

Known Direct Subclasses

org.mortbay.jetty.HttpConnection.OutputWriter

OutputWriter. A writer that can wrap a Output stream and provide character encodings. The UTF-8 encoding is done by this class and no additional buffers or Writers are used. The UTF-8 code was inspired by http://javolution.org

Field Summary

Modifier and Type	Field and Description
pack-priv AbstractGenerator	_generator
pack-priv AbstractGenerator.Output	_out
pack-priv int	_surrogate
pack-priv int	_writeMode
private static final int	WRITE_CONV
private static final int	WRITE_ISO1
private static final int	WRITE_UTF8

Inherited from java.io.Writer:: lock

Constructor Summary

Access	Constructor and Description
public	OutputWriter(AbstractGenerator.Output out)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Closes the stream, flushing it first.
public void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushes the stream.
private Writer	getConverter()
public void	setCharacterEncoding(String encoding)
public void	write(String A String s, int Offset from which to start writing characters offset, int Number of characters to write length) Overrides java.io.Writer.write. Writes a portion of a string.
public void	write(char[] Array of characters s, int Offset from which to start writing characters offset, int Number of characters to write length) Implements abstract java.io.Writer.write. Writes a portion of an array of characters.

Inherited from java.io.Writer:: append append append nullWriter write write write

Field Detail

_generator	back to summary
pack-priv AbstractGenerator _generator

_out	back to summary
pack-priv AbstractGenerator.Output _out

_surrogate	back to summary
pack-priv int _surrogate

_writeMode	back to summary
pack-priv int _writeMode

WRITE_CONV	back to summary
private static final int WRITE_CONV

WRITE_ISO1	back to summary
private static final int WRITE_ISO1

WRITE_UTF8	back to summary
private static final int WRITE_UTF8

Constructor Detail

OutputWriter	back to summary
public OutputWriter(AbstractGenerator.Output out)

Method Detail

back to summary

public void close() throws IOException

Implements abstract java.io.Writer.close.

Implements java.io.Closeable.close.

Doc from java.io.Writer.close.

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Exceptions

IOException:: If an I/O error occurs

flush

back to summary

public void flush() throws IOException

Implements abstract java.io.Writer.flush.

Implements java.io.Flushable.flush.

Doc from java.io.Writer.flush.

Flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.

Exceptions

IOException:: If an I/O error occurs

getConverter	back to summary
private Writer getConverter() throws IOException

setCharacterEncoding	back to summary
public void setCharacterEncoding(String encoding)

write

back to summary

public void write(String s, int offset, int length) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of a string.

Parameters

s:String: A String
offset:int: Offset from which to start writing characters
length:int: Number of characters to write

Exceptions

IOException:: If an I/O error occurs

write

back to summary

public void write(char[] s, int offset, int length) throws IOException

Implements abstract java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of an array of characters.

Parameters

s:char[]: Array of characters
offset:int: Offset from which to start writing characters
length:int: Number of characters to write

Exceptions

IOException:: If an I/O error occurs

public abstract Class AbstractGenerator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AbstractGenerator.Output

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AbstractGenerator.OutputWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail