javax.servlet

Class ServletInputStream

Contents
  • 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 efficient readLine method for reading data one line at a time. With some protocols, such as HTTP POST and PUT, a ServletInputStream object can be used to read data sent from the client.

    A ServletInputStream object is normally retrieved via the ServletRequest.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 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 read
        off - an integer specifying the character at which this method begins reading
        len - 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 returns false.
        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 returns false.
        Since:
        Servlet 3.1

      • setReadListener

        public abstract void setReadListener(ReadListener readListener)
        Instructs the ServletInputStream to invoke the provided ReadListener when it is possible to read
        Parameters:
        readListener - the ReadListener 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

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/servlet/ServletInputStream.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, ServletInputStream (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.