View Javadoc

    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 org.apache.commons.fileupload;
    18
    19  import java.io.InputStream;
    20  import java.io.IOException;
    21
    22  /**
    23   * <p>Abstracts access to the request information needed for file uploads. This
    24   * interfsace should be implemented for each type of request that may be
    25   * handled by FileUpload, such as servlets and portlets.</p>
    26   *
    27   * @author <a href="mailto:martinc@apache.org">Martin Cooper</a>
    28   *
    29   * @since FileUpload 1.1
    30   *
    31   * @version $Id: RequestContext.java 479262 2006-11-26 03:09:24Z niallp $
    32   */
    33  public interface RequestContext {
    34
    35      /**
    36       * Retrieve the character encoding for the request.
    37       *
    38       * @return The character encoding for the request.
    39       */
    40      String getCharacterEncoding();
    41
    42      /**
    43       * Retrieve the content type of the request.
    44       *
    45       * @return The content type of the request.
    46       */
    47      String getContentType();
    48
    49      /**
    50       * Retrieve the content length of the request.
    51       *
    52       * @return The content length of the request.
    53       */
    54      int getContentLength();
    55
    56      /**
    57       * Retrieve the input stream for the request.
    58       *
    59       * @return The input stream for the request.
    60       *
    61       * @throws IOException if a problem occurs.
    62       */
    63      InputStream getInputStream() throws IOException;
    64  }