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 *
029 * @version $Id: RequestContext.java 1455861 2013-03-13 10:12:09Z simonetripodi $
030 */
031public interface RequestContext {
032
033    /**
034     * Retrieve the character encoding for the request.
035     *
036     * @return The character encoding for the request.
037     */
038    String getCharacterEncoding();
039
040    /**
041     * Retrieve the content type of the request.
042     *
043     * @return The content type of the request.
044     */
045    String getContentType();
046
047    /**
048     * Retrieve the content length of the request.
049     *
050     * @return The content length of the request.
051     * @deprecated 1.3 Use {@link UploadContext#contentLength()} instead
052     */
053    @Deprecated
054    int getContentLength();
055
056    /**
057     * Retrieve the input stream for the request.
058     *
059     * @return The input stream for the request.
060     *
061     * @throws IOException if a problem occurs.
062     */
063    InputStream getInputStream() throws IOException;
064
065}