https://projects.eclipse.org/projects/ee4j.servlet: Provides, via submodules, a base configuration for JBoss project builds, as well as a derived configuration supporting multi-release JARs (JBoss by Red Hat)
  • Ed Burns
  • Shing Wai Chan 
/*
 * Copyright (c) 2017, 2018 Oracle and/or its affiliates and others.
 * All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package javax.servlet;

import java.io.IOException;
import java.util.EventListener;



This class represents a call-back mechanism that will notify implementations as HTTP request data becomes available
to be read without blocking.



Since:Servlet 3.1
/**
 * <p>
 * This class represents a call-back mechanism that will notify implementations as HTTP request data becomes available
 * to be read without blocking.
 * </p>
 *
 * @since Servlet 3.1
 */
public interface ReadListener extends EventListener {

    
When an instance of the ReadListener is registered with a ServletInputStream, this method will be invoked by the container the first time when it is possible to read data. Subsequently the container will invoke this method if and only if the ServletInputStream.isReady() method has been called and has returned a value of false and data has subsequently become available to read.

Throws:
  • IOException – if an I/O related error has occurred during processing
/**
     * When an instance of the <code>ReadListener</code> is registered with a {@link ServletInputStream}, this method
     * will be invoked by the container the first time when it is possible to read data. Subsequently the container will
     * invoke this method if and only if the {@link javax.servlet.ServletInputStream#isReady()} method has been called
     * and has returned a value of <code>false</code> <em>and</em> data has subsequently become available to read.
     *
     * @throws IOException if an I/O related error has occurred during processing
     */
    public void onDataAvailable() throws IOException;

    
Invoked when all data for the current request has been read.

Throws:
  • IOException – if an I/O related error has occurred during processing
/**
     * Invoked when all data for the current request has been read.
     *
     * @throws IOException if an I/O related error has occurred during processing
     */
    public void onAllDataRead() throws IOException;

    
Invoked when an error occurs processing the request.

Params:
  • t – the throwable to indicate why the read operation failed
/**
     * Invoked when an error occurs processing the request.
     *
     * @param t the throwable to indicate why the read operation failed
     */
    public void onError(Throwable t);

}