Top Description Fields Constructors Methods
org.glassfish.grizzly.http.multipart

pack-priv final Class MultipartEntryNIOInputStream

extends NIOInputStream
Class Inheritance
Imports
java.io.IOException, org.glassfish.grizzly.Buffer, .ReadHandler, org.glassfish.grizzly.http.io.NIOInputStream

Stream implementation to read MultipartEntry content in the binary mode.
Since
2.0.1

Field Summary

Modifier and TypeField and Description
private ReadHandler
private boolean
private final MultipartEntry
private NIOInputStream
private int

Constructor Summary

AccessConstructor and Description
public
MultipartEntryNIOInputStream(final MultipartEntry
MultipartEntry the {@link NIOInputStream belongs to.
multipartEntry
)

Constructs a new NIOInputStream using the specified parentNIOInputStream

Method Summary

Modifier and TypeMethod and Description
public int
available()

Overrides java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.

public void
close()

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Closes this input stream and releases any system resources associated with the stream.

public Buffer
getBuffer()

Implements org.glassfish.grizzly.http.io.BinaryNIOInputSource.getBuffer.

Returns the the duplicate of the underlying org.glassfish.grizzly.Buffer that backs this InputSource.

protected void
initialize(final NIOInputStream
the Request NIOInputStream from which binary content will be supplied
parentNIOInputStream
)

public boolean
public boolean
public void
mark(final int readlimit)

Overrides java.io.InputStream.mark.

Marks the current position in this input stream.

public boolean

Returns:

true
markSupported
()

Overrides java.io.InputStream.markSupported.

This InputStream implementation supports marking.

public void
notifyAvailable(final ReadHandler handler)

Implements org.glassfish.grizzly.InputSource.notifyAvailable.

Notify the specified ReadHandler when any number of bytes or characters can be read without blocking.

public void
notifyAvailable(final ReadHandler handler, final int size)

Implements org.glassfish.grizzly.InputSource.notifyAvailable.

Notify the specified ReadHandler when the number of bytes that can be read without blocking is greater or equal to the specified size.

pack-priv void
onDataCame()

Append available bytes to the input stream

public int
read()

Implements abstract java.io.InputStream.read.

Reads the next byte of data from the input stream.

public int
read(final byte[] b, final int off, final int len)

Overrides java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes.

public Buffer
readBuffer()

Implements org.glassfish.grizzly.http.io.BinaryNIOInputSource.readBuffer.

Returns the underlying org.glassfish.grizzly.Buffer that backs this InputSource.

public Buffer
readBuffer(final int size)

Implements org.glassfish.grizzly.http.io.BinaryNIOInputSource.readBuffer.

Returns the org.glassfish.grizzly.Buffer of a given size, which represents a chunk of the underlying org.glassfish.grizzly.Buffer that backs this InputSource.

public int
protected void
public void
reset()

Overrides java.io.InputStream.reset.

Repositions this stream to the position at the time the mark method was last called on this input stream.

private static boolean
shouldNotifyNow(final int
the amount of data that must be available for a ReadHandler to be notified.
size
,
final int
the amount of data currently available.
available
)

Returns: true if the handler should be notified during a call to notifyAvailable(ReadHandler) or notifyAvailable(ReadHandler, int), otherwise false

public long
skip(final long n)

Overrides java.io.InputStream.skip.

Skips over and discards n bytes of data from this input stream.

Field Detail

handlerback to summary
private ReadHandler handler
isClosedback to summary
private boolean isClosed
multipartEntryback to summary
private final MultipartEntry multipartEntry
parentNIOInputStreamback to summary
private NIOInputStream parentNIOInputStream
requestedSizeback to summary
private int requestedSize

Constructor Detail

MultipartEntryNIOInputStreamback to summary
public MultipartEntryNIOInputStream(final MultipartEntry multipartEntry)

Constructs a new NIOInputStream using the specified parentNIOInputStream

Parameters
multipartEntry:MultipartEntry

MultipartEntry the {@link NIOInputStream belongs to.

Method Detail

availableback to summary
public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
closeback to summary
public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
getBufferback to summary
public Buffer getBuffer()

Implements org.glassfish.grizzly.http.io.BinaryNIOInputSource.getBuffer.

Doc from org.glassfish.grizzly.http.io.BinaryNIOInputSource.getBuffer.

Returns the the duplicate of the underlying org.glassfish.grizzly.Buffer that backs this InputSource. The content of the returned buffer will be that of the underlying buffer. Changes to returned buffer's content will be visible in the underlying buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

Annotations
@Override
initializeback to summary
protected void initialize(final NIOInputStream parentNIOInputStream)
Parameters
parentNIOInputStream:NIOInputStream

the Request NIOInputStream from which binary content will be supplied

isFinishedback to summary
public boolean isFinished()

Implements org.glassfish.grizzly.InputSource.isFinished.

Annotations
@Override
isReadyback to summary
public boolean isReady()

Implements org.glassfish.grizzly.InputSource.isReady.

Annotations
@Override
markback to summary
public void mark(final int readlimit)

Overrides java.io.InputStream.mark.

Doc from java.io.InputStream.mark.

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit arguments tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

The general contract of mark is that, if the method markSupported returns true, the stream somehow remembers all the bytes read after the call to mark and stands ready to supply those same bytes again if and whenever the method reset is called. However, the stream is not required to remember any data at all if more than readlimit bytes are read from the stream before reset is called.

Marking a closed stream should not have any effect on the stream.

Annotations
@Override
markSupportedback to summary
public boolean markSupported()

Overrides java.io.InputStream.markSupported.

This InputStream implementation supports marking.

Returns:boolean

true

Annotations
@Override
notifyAvailableback to summary
public void notifyAvailable(final ReadHandler handler)

Implements org.glassfish.grizzly.InputSource.notifyAvailable.

Doc from org.glassfish.grizzly.InputSource.notifyAvailable.

Notify the specified ReadHandler when any number of bytes or characters can be read without blocking.

Invoking this method is equivalent to calling: notifyAvailable(handler, 1).

Annotations
@Override
notifyAvailableback to summary
public void notifyAvailable(final ReadHandler handler, final int size)

Implements org.glassfish.grizzly.InputSource.notifyAvailable.

Doc from org.glassfish.grizzly.InputSource.notifyAvailable.

Notify the specified ReadHandler when the number of bytes that can be read without blocking is greater or equal to the specified size.

Annotations
@Override
onDataCameback to summary
pack-priv void onDataCame() throws Exception

Append available bytes to the input stream

readback to summary
public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readback to summary
public int read(final byte[] b, final int off, final int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Annotations
@Override
Exceptions
IOException:
If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.
readBufferback to summary
public Buffer readBuffer()

Implements org.glassfish.grizzly.http.io.BinaryNIOInputSource.readBuffer.

Doc from org.glassfish.grizzly.http.io.BinaryNIOInputSource.readBuffer.

Returns the underlying org.glassfish.grizzly.Buffer that backs this InputSource. Unlike getBuffer(), this method detaches the returned Buffer, so user becomes responsible for handling the Buffer's life-cycle.

Annotations
@Override
readBufferback to summary
public Buffer readBuffer(final int size)

Implements org.glassfish.grizzly.http.io.BinaryNIOInputSource.readBuffer.

Doc from org.glassfish.grizzly.http.io.BinaryNIOInputSource.readBuffer.

Returns the org.glassfish.grizzly.Buffer of a given size, which represents a chunk of the underlying org.glassfish.grizzly.Buffer that backs this InputSource. Unlike getBuffer(), this method detaches the returned Buffer, so user becomes responsible for handling the Buffer's life-cycle.

Annotations
@Override
readyDataback to summary
public int readyData()

Implements org.glassfish.grizzly.InputSource.readyData.

Annotations
@Override
recycleback to summary
protected void recycle()
resetback to summary
public void reset() throws IOException

Overrides java.io.InputStream.reset.

Doc from java.io.InputStream.reset.

Repositions this stream to the position at the time the mark method was last called on this input stream.

The general contract of reset is:

  • If the method markSupported returns true, then:
    • If the method mark has not been called since the stream was created, or the number of bytes read from the stream since mark was last called is larger than the argument to mark at that last call, then an IOException might be thrown.
    • If such an IOException is not thrown, then the stream is reset to a state such that all the bytes read since the most recent call to mark (or since the start of the file, if mark has not been called) will be resupplied to subsequent callers of the read method, followed by any bytes that otherwise would have been the next input data as of the time of the call to reset.
  • If the method markSupported returns false, then:
    • The call to reset may throw an IOException.
    • If an IOException is not thrown, then the stream is reset to a fixed state that depends on the particular type of the input stream and how it was created. The bytes that will be supplied to subsequent callers of the read method depend on the particular type of the input stream.
Annotations
@Override
Exceptions
IOException:
if this stream has not been marked or if the mark has been invalidated.
shouldNotifyNowback to summary
private static boolean shouldNotifyNow(final int size, final int available)
Parameters
size:int

the amount of data that must be available for a ReadHandler to be notified.

available:int

the amount of data currently available.

Returns:boolean

true if the handler should be notified during a call to notifyAvailable(ReadHandler) or notifyAvailable(ReadHandler, int), otherwise false

skipback to summary
public long skip(final long n) throws IOException

Overrides java.io.InputStream.skip.

Doc from java.io.InputStream.skip.

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, the skip method for class InputStream always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.