- java.lang.Object
-
- java.io.InputStream
-
- javax.servlet.ServletInputStream
-
- All Implemented Interfaces:
- Closeable, AutoCloseable
public abstract class ServletInputStream extends InputStream
Provides an input stream for reading binary data from a client request, including an efficientreadLine
method for reading data one line at a time. With some protocols, such as HTTP POST and PUT, aServletInputStream
object can be used to read data sent from the client.A
ServletInputStream
object is normally retrieved via theServletRequest.getInputStream()
method.This is an abstract class that a servlet container implements. Subclasses of this class must implement the
java.io.InputStream.read()
method.- Author:
- Various
- See Also:
ServletRequest
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
ServletInputStream()
Does nothing, because this is an abstract class.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and Description abstract boolean
isFinished()
Returns true when all the data from the stream has been read else it returns false.abstract boolean
isReady()
Returns true if data can be read without blocking else returns false.int
readLine(byte[] b, int off, int len)
Reads the input stream, one line at a time.abstract void
setReadListener(ReadListener readListener)
Instructs theServletInputStream
to invoke the providedReadListener
when it is possible to read
-
-
-
Constructor Detail
-
ServletInputStream
protected ServletInputStream()
Does nothing, because this is an abstract class.
-
-
Method Detail
-
readLine
public int readLine(byte[] b, int off, int len) throws IOException
Reads the input stream, one line at a time. Starting at an offset, reads bytes into an array, until it reads a certain number of bytes or reaches a newline character, which it reads into the array as well.This method returns -1 if it reaches the end of the input stream before reading the maximum number of bytes.
- Parameters:
b
- an array of bytes into which data is readoff
- an integer specifying the character at which this method begins readinglen
- an integer specifying the maximum number of bytes to read- Returns:
- an integer specifying the actual number of bytes read, or -1 if the end of the stream is reached
- Throws:
IOException
- if an input or output exception has occurred
-
isFinished
public abstract boolean isFinished()
Returns true when all the data from the stream has been read else it returns false.- Returns:
true
when all data for this particular request has been read, otherwise returnsfalse
.- Since:
- Servlet 3.1
-
isReady
public abstract boolean isReady()
Returns true if data can be read without blocking else returns false.- Returns:
true
if data can be obtained without blocking, otherwise returnsfalse
.- Since:
- Servlet 3.1
-
setReadListener
public abstract void setReadListener(ReadListener readListener)
Instructs theServletInputStream
to invoke the providedReadListener
when it is possible to read- Parameters:
readListener
- theReadListener
that should be notified when it's possible to read.- Throws:
IllegalStateException
- if one of the following conditions is true- the associated request is neither upgraded nor the async started
- setReadListener is called more than once within the scope of the same request.
NullPointerException
- if readListener is null- Since:
- Servlet 3.1
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/servlet/servletinputstream.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.