org.josef.web.servlet

Class GZipResponseStream

java.lang.Object

java.io.OutputStream

javax.servlet.ServletOutputStream

org.josef.web.servlet.GZipResponseStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class GZipResponseStream
extends javax.servlet.ServletOutputStream

A servlet response stream that writes compressed data.

Author:

Jayson Falkner, Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
GZipResponseStream(javax.servlet.http.HttpServletResponse response, int threshold) Constructs this GZipResponseStream from the supplied response.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this stream and writes the actual response.
boolean	closed() Determines whether this stream is closed or not.
void	write(byte[] byteArray) Writes the supplied byteArray to the intermediary output stream.
void	write(byte[] byteArray, int offset, int length) Writes length bytes from the supplied byteArray, with the supplied offset, to the intermediary output stream.
void	write(int b) Writes the supplied byte to the intermediary 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.io.OutputStream

flush

Methods inherited from class java.lang.Object

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

Constructor Detail

GZipResponseStream

public GZipResponseStream(javax.servlet.http.HttpServletResponse response,
                          int threshold)
                   throws IOException

Constructs this GZipResponseStream from the supplied response.

Parameters:

response - The response to zip.

threshold - The minimum threshold for compression.
A response with a size less than this threshold will not be compressed.

Throws:

IOException - When an error occurs during the creation of the output stream.

Method Detail

close

public void close()
           throws IOException

Closes this stream and writes the actual response.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException - When this stream can't be closed or when the response could not be written.

write

public void write(int b)
           throws IOException

Writes the supplied byte to the intermediary output stream.

Specified by:

write in class OutputStream

Parameters:

b - The byte to write.

Throws:

IOException - When the byte could not be written.

write

public void write(byte[] byteArray)
           throws IOException

Writes the supplied byteArray to the intermediary output stream.

Overrides:

write in class OutputStream

Parameters:

byteArray - The byte array to write.

Throws:

IOException - When the supplied byteArray could not be written.

write

public void write(byte[] byteArray,
                  int offset,
                  int length)
           throws IOException

Writes length bytes from the supplied byteArray, with the supplied offset, to the intermediary output stream.

Overrides:

write in class OutputStream

Parameters:

byteArray - The byte array to write.

offset - The offset from the supplied byteArray.

length - The number of bytes to write.

Throws:

IOException - When the supplied byteArray could not be written.

closed

public boolean closed()

Determines whether this stream is closed or not.

Returns:

True when closed, otherwise false.