All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.servlet.ServletInputStream Maven / Gradle / Ivy

The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 *
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * Copyright 2004 The Apache Software Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package javax.servlet;

import java.io.InputStream;
import java.io.IOException;

/**
 * 
 * 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 {@link 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 ServletRequest * */ public abstract class ServletInputStream extends InputStream { /** * Does nothing, because this is an abstract class. * */ protected ServletInputStream() { } /** * * 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. * * * * @param b an array of bytes into which data is read * * @param off an integer specifying the character at which * this method begins reading * * @param len an integer specifying the maximum number of * bytes to read * * @return an integer specifying the actual number of bytes * read, or -1 if the end of the stream is reached * * @exception IOException if an input or output exception has occurred * */ public int readLine(byte[] b, int off, int len) throws IOException { if (len <= 0) { return 0; } int count = 0, c; while ((c = read()) != -1) { b[off++] = (byte)c; count++; if (c == '\n' || count == len) { break; } } return count > 0 ? count : -1; } /** * Returns true when all the data from the stream has been read else * it returns false. * * @return true when all data for this particular request * has been read, otherwise returns false. * * @since Servlet 3.1 */ public abstract boolean isFinished(); /** * Returns true if data can be read without blocking else returns * false. * * @return true if data can be obtained without blocking, * otherwise returns false. * * @since Servlet 3.1 */ public abstract boolean isReady(); /** * Instructs the ServletInputStream to invoke the provided * {@link ReadListener} when it is possible to read * * @param readListener the {@link ReadListener} that should be notified * when it's possible to read. * * @exception 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. *
* * @throws NullPointerException if readListener is null * * @since Servlet 3.1 */ public abstract void setReadListener(ReadListener readListener); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy