Package com.ibm.wsspi.http
Class HttpOutputStream
- java.lang.Object
-
- java.io.OutputStream
-
- com.ibm.wsspi.http.HttpOutputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.io.Flushable
,java.lang.AutoCloseable
public abstract class HttpOutputStream extends java.io.OutputStream
-
-
Constructor Summary
Constructors Constructor Description HttpOutputStream()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract void
clear()
Clear any current buffer content in the stream.abstract void
flush(boolean ignoreFlag)
abstract void
flushBuffers()
Flush the output array of buffers to the network below.abstract void
flushHeaders()
Write the current set of response headers.abstract long
getBufferedCount()
Query the amount of bytes currently buffered so far.abstract int
getBufferSize()
Query the amount of data this stream is configured to buffer before an automatic write happens.abstract long
getBytesWritten()
Query the amount of bytes written so far.abstract boolean
hasBufferedContent()
Test whether this stream has any current data buffered, waiting to be written out.abstract boolean
isClosed()
Query whether this stream is closed already or not.abstract void
setBufferSize(int size)
Set the amount of data to buffer internally before the stream itself initiates a flush.abstract void
setContentLength(long length)
abstract void
setIsClosing(boolean b)
abstract void
writeFile(java.nio.channels.FileChannel fc)
Write a file channel onto the output stream.
-
-
-
Method Detail
-
setIsClosing
public abstract void setIsClosing(boolean b)
-
getBufferSize
public abstract int getBufferSize()
Query the amount of data this stream is configured to buffer before an automatic write happens.- Returns:
- int
-
setBufferSize
public abstract void setBufferSize(int size)
Set the amount of data to buffer internally before the stream itself initiates a flush. A zero size means no buffer is done, each write call will flush data.- Parameters:
size
-- Throws:
java.lang.IllegalStateException
- if already writing data or closed
-
clear
public abstract void clear()
Clear any current buffer content in the stream.
-
getBytesWritten
public abstract long getBytesWritten()
Query the amount of bytes written so far.- Returns:
- long
-
getBufferedCount
public abstract long getBufferedCount()
Query the amount of bytes currently buffered so far.- Returns:
- long
-
hasBufferedContent
public abstract boolean hasBufferedContent()
Test whether this stream has any current data buffered, waiting to be written out.- Returns:
- boolean
-
writeFile
public abstract void writeFile(java.nio.channels.FileChannel fc) throws java.io.IOException
Write a file channel onto the output stream.- Parameters:
fc
-- Throws:
java.io.IOException
-
flushHeaders
public abstract void flushHeaders() throws java.io.IOException
Write the current set of response headers. If the headers have already been sent, this is a no-op.- Throws:
java.io.IOException
-
flushBuffers
public abstract void flushBuffers() throws java.io.IOException
Flush the output array of buffers to the network below.- Throws:
java.io.IOException
-
isClosed
public abstract boolean isClosed()
Query whether this stream is closed already or not.- Returns:
- boolean
-
flush
public abstract void flush(boolean ignoreFlag) throws java.io.IOException
- Parameters:
ignoreFlag
-- Throws:
java.io.IOException
-
setContentLength
public abstract void setContentLength(long length)
- Parameters:
length
-
-
-