lib/servlet-api/javax/servlet/ReadListener.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17 package javax.servlet;
  18
  19 import java.io.IOException;
  20
  21 /**
  22  * Receives notification of read events when using non-blocking IO.
  23  *
  24  * @since Servlet 3.1
  25  */
  26 public interface ReadListener extends java.util.EventListener{
  27
  28     /**
  29      * Invoked when data is available to read. The container will invoke this
  30      * method the first time for a request as soon as there is data to read.
  31      * Subsequent invocations will only occur if a call to
  32      * {@link ServletInputStream#isReady()} has returned false and data has
  33      * subsequently become available to read.
  34      *
  35      * @throws IOException
  36      */
  37     public abstract void onDataAvailable() throws IOException;
  38
  39     /**
  40      * Invoked when the request body has been fully read.
  41      *
  42      * @throws IOException
  43      */
  44     public abstract void onAllDataRead() throws IOException;
  45
  46     /**
  47      * Invoked if an error occurs while reading the request body.
  48      *
  49      * @param throwable The exception that occurred
  50      */
  51     public abstract void onError(java.lang.Throwable throwable);
  52 }