jodd.servlet.filter

Class GzipResponseStream

java.lang.Object

java.io.OutputStream

javax.servlet.ServletOutputStream

jodd.servlet.filter.GzipResponseStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class GzipResponseStream
extends javax.servlet.ServletOutputStream

GZIP response stream.

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buffer The buffer through which all of our output bytes are passed.
protected int	bufferCount The number of data bytes currently in the buffer.
protected boolean	closed Has this stream been closed?
protected int	compressionThreshold The threshold number which decides to compress or not.
protected java.util.zip.GZIPOutputStream	gzipstream The underlying gzip output stream to which we should write data.
protected int	length The content length past which we will not write, or -1 if there is no defined content length.
protected javax.servlet.ServletOutputStream	output The underlying servlet output stream to which we should write data.
protected javax.servlet.http.HttpServletResponse	response The response with which this servlet output stream is associated.

Constructor Summary

Constructors

Constructor and Description
GzipResponseStream(javax.servlet.http.HttpServletResponse response) Constructs a servlet output stream associated with the specified Response.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this output stream, causing any buffered data to be flushed and any further output data to throw an IOException.
boolean	closed() Returns true if this response stream been closed.
void	flush() Flushes any buffered data for this output stream, which also causes the response to be committed.
void	flushToGZip()
boolean	isReady()
protected void	setBuffer(int threshold) Sets the compressionThreshold number and create buffer for this size.
void	setWriteListener(javax.servlet.WriteListener writeListener)
void	write(byte[] b) Writes b.length bytes from the specified byte array to our output stream.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array, starting at the specified offset, to our output stream.
void	write(int b) Writes the specified byte to our output stream.
void	writeToGZip(byte[] b, int off, int len) Writes byte array to gzip output stream.

Methods inherited from class javax.servlet.ServletOutputStream

print, print, print, print, print, print, print, println, println, println, println, println, println, println, println

Methods inherited from class java.lang.Object

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

Field Detail

compressionThreshold

protected int compressionThreshold

The threshold number which decides to compress or not.

buffer

protected byte[] buffer

The buffer through which all of our output bytes are passed.

bufferCount

protected int bufferCount

The number of data bytes currently in the buffer.

gzipstream

protected java.util.zip.GZIPOutputStream gzipstream

The underlying gzip output stream to which we should write data.

closed

protected boolean closed

Has this stream been closed?

length

protected int length

The content length past which we will not write, or -1 if there is no defined content length.

response

protected javax.servlet.http.HttpServletResponse response

The response with which this servlet output stream is associated.

output

protected javax.servlet.ServletOutputStream output

The underlying servlet output stream to which we should write data.

Constructor Detail

GzipResponseStream

public GzipResponseStream(javax.servlet.http.HttpServletResponse response)
                   throws java.io.IOException

Constructs a servlet output stream associated with the specified Response.

Throws:

java.io.IOException

Method Detail

setBuffer

protected void setBuffer(int threshold)

Sets the compressionThreshold number and create buffer for this size.

isReady

public boolean isReady()

Specified by:

isReady in class javax.servlet.ServletOutputStream

setWriteListener

public void setWriteListener(javax.servlet.WriteListener writeListener)

Specified by:

setWriteListener in class javax.servlet.ServletOutputStream

close

public void close()
           throws java.io.IOException

Closes this output stream, causing any buffered data to be flushed and any further output data to throw an IOException.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Flushes any buffered data for this output stream, which also causes the response to be committed.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

flushToGZip

public void flushToGZip()
                 throws java.io.IOException

Throws:

java.io.IOException

write

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

Writes the specified byte to our output stream.

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

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

Writes b.length bytes from the specified byte array to our output stream.

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

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

Writes len bytes from the specified byte array, starting at the specified offset, to our output stream.

Overrides:

write in class java.io.OutputStream

Parameters:

b - byte array containing the bytes to be written

off - zero-relative starting offset of the bytes to be written

len - number of bytes to be written

Throws:

java.io.IOException

writeToGZip

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

Writes byte array to gzip output stream. Creates new GZIPOutputStream if not created yet. Also sets the "Content-Encoding" header.

Throws:

java.io.IOException

closed

public boolean closed()

Returns true if this response stream been closed.