org.apache.http.impl.io

Class AbstractSessionOutputBuffer

java.lang.Object

org.apache.http.impl.io.AbstractSessionOutputBuffer

All Implemented Interfaces:

BufferInfo, SessionOutputBuffer

Direct Known Subclasses:

SocketOutputBuffer

Deprecated.

(4.3) use SessionOutputBufferImpl

@Deprecated
public abstract class AbstractSessionOutputBuffer
extends java.lang.Object
implements SessionOutputBuffer, BufferInfo

Abstract base class for session output buffers that stream data to an arbitrary OutputStream. This class buffers small chunks of output data in an internal byte array for optimal output performance.

writeLine(CharArrayBuffer) and writeLine(String) methods of this class use CR-LF as a line delimiter.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	ascii Deprecated.
private java.nio.ByteBuffer	bbuf Deprecated.
private ByteArrayBuffer	buffer Deprecated.
private java.nio.charset.Charset	charset Deprecated.
private static byte[]	CRLF Deprecated.
private java.nio.charset.CharsetEncoder	encoder Deprecated.
private HttpTransportMetricsImpl	metrics Deprecated.
private int	minChunkLimit Deprecated.
private java.nio.charset.CodingErrorAction	onMalformedCharAction Deprecated.
private java.nio.charset.CodingErrorAction	onUnmappableCharAction Deprecated.
private java.io.OutputStream	outstream Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractSessionOutputBuffer() Deprecated.
protected	AbstractSessionOutputBuffer(java.io.OutputStream outstream, int buffersize, java.nio.charset.Charset charset, int minChunkLimit, java.nio.charset.CodingErrorAction malformedCharAction, java.nio.charset.CodingErrorAction unmappableCharAction) Deprecated.

Method Summary

Modifier and Type	Method and Description
int	available() Deprecated. Returns available space in the buffer.
int	capacity() Deprecated. Returns total capacity of the buffer
protected HttpTransportMetricsImpl	createTransportMetrics() Deprecated.
void	flush() Deprecated. Flushes this session buffer and forces any buffered output bytes to be written out.
protected void	flushBuffer() Deprecated.
HttpTransportMetrics	getMetrics() Deprecated. Returns HttpTransportMetrics for this session buffer.
private void	handleEncodingResult(java.nio.charset.CoderResult result) Deprecated.
protected void	init(java.io.OutputStream outstream, int buffersize, HttpParams params) Deprecated.
int	length() Deprecated. Return length data stored in the buffer
void	write(byte[] b) Deprecated. Writes b.length bytes from the specified byte array to this session buffer.
void	write(byte[] b, int off, int len) Deprecated. Writes len bytes from the specified byte array starting at offset off to this session buffer.
void	write(int b) Deprecated. Writes the specified byte to this session buffer.
private void	writeEncoded(java.nio.CharBuffer cbuf) Deprecated.
void	writeLine(CharArrayBuffer charbuffer) Deprecated. Writes characters from the specified char array followed by a line delimiter to this session buffer.
void	writeLine(java.lang.String s) Deprecated. Writes characters from the specified string followed by a line delimiter to this session buffer.

Methods inherited from class java.lang.Object

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

Field Detail

CRLF

private static final byte[] CRLF

Deprecated.

outstream

private java.io.OutputStream outstream

Deprecated.

buffer

private ByteArrayBuffer buffer

Deprecated.

charset

private java.nio.charset.Charset charset

Deprecated.

ascii

private boolean ascii

Deprecated.

minChunkLimit

private int minChunkLimit

Deprecated.

metrics

private HttpTransportMetricsImpl metrics

Deprecated.

onMalformedCharAction

private java.nio.charset.CodingErrorAction onMalformedCharAction

Deprecated.

onUnmappableCharAction

private java.nio.charset.CodingErrorAction onUnmappableCharAction

Deprecated.

encoder

private java.nio.charset.CharsetEncoder encoder

Deprecated.

bbuf

private java.nio.ByteBuffer bbuf

Deprecated.

Constructor Detail

AbstractSessionOutputBuffer

protected AbstractSessionOutputBuffer(java.io.OutputStream outstream,
                                      int buffersize,
                                      java.nio.charset.Charset charset,
                                      int minChunkLimit,
                                      java.nio.charset.CodingErrorAction malformedCharAction,
                                      java.nio.charset.CodingErrorAction unmappableCharAction)

Deprecated.

AbstractSessionOutputBuffer

public AbstractSessionOutputBuffer()

Deprecated.

Method Detail

init

protected void init(java.io.OutputStream outstream,
                    int buffersize,
                    HttpParams params)

Deprecated.

createTransportMetrics

protected HttpTransportMetricsImpl createTransportMetrics()

Deprecated.

Since:

4.1

capacity

public int capacity()

Deprecated.

Description copied from interface: BufferInfo

Returns total capacity of the buffer

Specified by:

capacity in interface BufferInfo

Returns:

total capacity

Since:

4.1

length

public int length()

Deprecated.

Description copied from interface: BufferInfo

Return length data stored in the buffer

Specified by:

length in interface BufferInfo

Returns:

data length

Since:

4.1

available

public int available()

Deprecated.

Description copied from interface: BufferInfo

Returns available space in the buffer.

Specified by:

available in interface BufferInfo

Returns:

available space.

Since:

4.1

flushBuffer

protected void flushBuffer()
                    throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Deprecated.

Description copied from interface: SessionOutputBuffer

Flushes this session buffer 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.

Specified by:

flush in interface SessionOutputBuffer

Throws:

java.io.IOException - if an I/O error occurs.

write

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

Deprecated.

Description copied from interface: SessionOutputBuffer

Writes len bytes from the specified byte array starting at offset off to this session buffer.

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.

Specified by:

write in interface SessionOutputBuffer

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

java.io.IOException - if an I/O error occurs.

write

public void write(byte[] b)
           throws java.io.IOException

Deprecated.

Description copied from interface: SessionOutputBuffer

Writes b.length bytes from the specified byte array to this session buffer.

Specified by:

write in interface SessionOutputBuffer

Parameters:

b - the data.

Throws:

java.io.IOException - if an I/O error occurs.

write

public void write(int b)
           throws java.io.IOException

Deprecated.

Description copied from interface: SessionOutputBuffer

Writes the specified byte to this session buffer.

Specified by:

write in interface SessionOutputBuffer

Parameters:

b - the byte.

Throws:

java.io.IOException - if an I/O error occurs.

writeLine

public void writeLine(java.lang.String s)
               throws java.io.IOException

Deprecated.

Writes characters from the specified string followed by a line delimiter to this session buffer.

This method uses CR-LF as a line delimiter.

Specified by:

writeLine in interface SessionOutputBuffer

Parameters:

s - the line.

Throws:

java.io.IOException - if an I/O error occurs.

writeLine

public void writeLine(CharArrayBuffer charbuffer)
               throws java.io.IOException

Deprecated.

Writes characters from the specified char array followed by a line delimiter to this session buffer.

This method uses CR-LF as a line delimiter.

Specified by:

writeLine in interface SessionOutputBuffer

Parameters:

charbuffer - the buffer containing chars of the line.

Throws:

java.io.IOException - if an I/O error occurs.

writeEncoded

private void writeEncoded(java.nio.CharBuffer cbuf)
                   throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

handleEncodingResult

private void handleEncodingResult(java.nio.charset.CoderResult result)
                           throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

getMetrics

public HttpTransportMetrics getMetrics()

Deprecated.

Description copied from interface: SessionOutputBuffer

Returns HttpTransportMetrics for this session buffer.

Specified by:

getMetrics in interface SessionOutputBuffer

Returns:

transport metrics.