Class EntityInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.glassfish.jersey.message.internal.EntityInputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
- Direct Known Subclasses:
InboundMessageContext.EntityContent
public class EntityInputStream extends java.io.InputStream
-
-
Constructor Summary
Constructors Constructor Description EntityInputStream(java.io.InputStream input)
Extension constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
available()
void
close()
static EntityInputStream
create(java.io.InputStream inputStream)
Create an entity input stream instance wrapping the original input stream.void
ensureNotClosed()
Check that the entity input stream has not been closed yet.java.io.InputStream
getWrappedStream()
Get the wrapped input stream instance.boolean
isClosed()
Get the closed status of this input stream.boolean
isEmpty()
Check if the underlying entity stream is empty.void
mark(int readLimit)
boolean
markSupported()
int
read()
int
read(byte[] b)
int
read(byte[] b, int off, int len)
void
reset()
void
setWrappedStream(java.io.InputStream wrapped)
Set the wrapped input stream instance.long
skip(long n)
-
-
-
Method Detail
-
create
public static EntityInputStream create(java.io.InputStream inputStream)
Create an entity input stream instance wrapping the original input stream. In case the original entity stream is already of typeEntityInputStream
, the stream is returned without wrapping.- Parameters:
inputStream
- input stream.- Returns:
- entity input stream.
-
read
public int read() throws java.io.IOException
- Specified by:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
read
public int read(byte[] b) throws java.io.IOException
- Overrides:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
read
public int read(byte[] b, int off, int len) throws java.io.IOException
- Overrides:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
skip
public long skip(long n) throws java.io.IOException
- Overrides:
skip
in classjava.io.InputStream
- Throws:
java.io.IOException
-
available
public int available() throws java.io.IOException
- Overrides:
available
in classjava.io.InputStream
- Throws:
java.io.IOException
-
mark
public void mark(int readLimit)
- Overrides:
mark
in classjava.io.InputStream
-
markSupported
public boolean markSupported()
- Overrides:
markSupported
in classjava.io.InputStream
-
reset
public void reset()
The method is customized to not throw an
IOException
if the reset operation fails. Instead, a runtimeProcessingException
is thrown.- Overrides:
reset
in classjava.io.InputStream
- Throws:
javax.ws.rs.ProcessingException
- in case the reset operation on the underlying entity input stream failed.
-
close
public void close() throws javax.ws.rs.ProcessingException
The method is customized to not throw an
IOException
if the close operation fails. Instead, a warning message is logged.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classjava.io.InputStream
- Throws:
javax.ws.rs.ProcessingException
-
isEmpty
public boolean isEmpty()
Check if the underlying entity stream is empty.Note that the operation may need to block until a first byte (or EOF) is available in the stream.
- Returns:
true
if the entity stream is empty,false
otherwise.
-
ensureNotClosed
public void ensureNotClosed() throws java.lang.IllegalStateException
Check that the entity input stream has not been closed yet.- Throws:
java.lang.IllegalStateException
- in case the entity input stream has been closed.
-
isClosed
public boolean isClosed()
Get the closed status of this input stream.- Returns:
true
if the stream has been closed,false
otherwise.
-
getWrappedStream
public final java.io.InputStream getWrappedStream()
Get the wrapped input stream instance.- Returns:
- wrapped input stream instance.
-
setWrappedStream
public final void setWrappedStream(java.io.InputStream wrapped)
Set the wrapped input stream instance.- Parameters:
wrapped
- new input stream instance to be wrapped.
-
-