Package com.helger.servlet.response.gzip

Class AbstractCompressedServletOutputStream

java.lang.Object

java.io.OutputStream

jakarta.servlet.ServletOutputStream

com.helger.servlet.io.AbstractServletOutputStream

com.helger.servlet.response.gzip.AbstractCompressedServletOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

DeflateResponse.DeflateServletOutputStream, GZIPResponse.GZIPServletOutputStream

public abstract class AbstractCompressedServletOutputStream
extends AbstractServletOutputStream

Special ServletOutputStream that knows whether it is closed or not

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
AbstractCompressedServletOutputStream(jakarta.servlet.http.HttpServletRequest aHttpRequest, jakarta.servlet.http.HttpServletResponse aHttpResponse, String sContentEncoding, long nContentLength, long nMinCompressSize)

Method Summary

Modifier and Type	Method	Description
void	close()
protected abstract DeflaterOutputStream	createDeflaterOutputStream(OutputStream aOS)
void	doCompress(String sDebugInfo)
void	doNotCompress(String sDebugInfo)
void	finishAndClose()
void	flush()
OutputStream	getOutputStream()
boolean	isClosed()
void	resetBuffer()
void	setContentLength(long nLength)
void	write(byte[] aBytes)
void	write(byte[] aBytes, int nOfs, int nLen)
void	write(int nByte)

Methods inherited from class com.helger.servlet.io.AbstractServletOutputStream

isReady, setWriteListener

Methods inherited from class jakarta.servlet.ServletOutputStream

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

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCompressedServletOutputStream

public AbstractCompressedServletOutputStream(@Nonnull
                                             jakarta.servlet.http.HttpServletRequest aHttpRequest,
                                             @Nonnull
                                             jakarta.servlet.http.HttpServletResponse aHttpResponse,
                                             @Nonnull
                                             String sContentEncoding,
                                             long nContentLength,
                                             @Nonnegative
                                             long nMinCompressSize)
                                      throws IOException

Throws:

IOException

Method Detail

resetBuffer

public final void resetBuffer()

setContentLength

public final void setContentLength(long nLength)

createDeflaterOutputStream

@Nonnull
protected abstract DeflaterOutputStream createDeflaterOutputStream(@Nonnull
                                                                   OutputStream aOS)
                                                            throws IOException

Throws:

IOException

doCompress

public final void doCompress(@Nullable
                             String sDebugInfo)
                      throws IOException

Throws:

IOException

doNotCompress

public final void doNotCompress(String sDebugInfo)
                         throws IOException

Throws:

IOException

flush

public final void flush()
                 throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public final void close()
                 throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

isClosed

public final boolean isClosed()

finishAndClose

public final void finishAndClose()
                          throws IOException

Throws:

IOException

write

public final void write(int nByte)
                 throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public final void write(@Nonnull
                        byte[] aBytes)
                 throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public final void write(@Nonnull
                        byte[] aBytes,
                        @Nonnegative
                        int nOfs,
                        @Nonnegative
                        int nLen)
                 throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

getOutputStream

@Nullable
public final OutputStream getOutputStream()