    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.fileupload;
    018
    019import java.io.InputStream;
    020import java.io.IOException;
    021
    022/**
    023 * <p>Abstracts access to the request information needed for file uploads. This
    024 * interface should be implemented for each type of request that may be
    025 * handled by FileUpload, such as servlets and portlets.</p>
    026 *
    027 * @since FileUpload 1.1
    028 */
    029public interface RequestContext {
    030
    031    /**
    032     * Retrieve the character encoding for the request.
    033     *
    034     * @return The character encoding for the request.
    035     */
    036    String getCharacterEncoding();
    037
    038    /**
    039     * Retrieve the content type of the request.
    040     *
    041     * @return The content type of the request.
    042     */
    043    String getContentType();
    044
    045    /**
    046     * Retrieve the content length of the request.
    047     *
    048     * @return The content length of the request.
    049     * @deprecated 1.3 Use {@link UploadContext#contentLength()} instead
    050     */
    051    @Deprecated
    052    int getContentLength();
    053
    054    /**
    055     * Retrieve the input stream for the request.
    056     *
    057     * @return The input stream for the request.
    058     *
    059     * @throws IOException if a problem occurs.
    060     */
    061    InputStream getInputStream() throws IOException;
    062
    063}