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.servlet;
    18
    19  import java.io.InputStream;
    20  import java.io.IOException;
    21  import javax.servlet.http.HttpServletRequest;
    22  import org.apache.commons.fileupload.RequestContext;
    23
    24  /**
    25   * <p>Provides access to the request information needed for a request made to
    26   * an HTTP servlet.</p>
    27   *
    28   * @author <a href="mailto:martinc@apache.org">Martin Cooper</a>
    29   *
    30   * @since FileUpload 1.1
    31   *
    32   * @version $Id: ServletRequestContext.java 479262 2006-11-26 03:09:24Z niallp $
    33   */
    34  public class ServletRequestContext implements RequestContext {
    35
    36      // ----------------------------------------------------- Instance Variables
    37
    38      /**
    39       * The request for which the context is being provided.
    40       */
    41      private HttpServletRequest request;
    42
    43
    44      // ----------------------------------------------------------- Constructors
    45
    46      /**
    47       * Construct a context for this request.
    48       *
    49       * @param request The request to which this context applies.
    50       */
    51      public ServletRequestContext(HttpServletRequest request) {
    52          this.request = request;
    53      }
    54
    55
    56      // --------------------------------------------------------- Public Methods
    57
    58      /**
    59       * Retrieve the character encoding for the request.
    60       *
    61       * @return The character encoding for the request.
    62       */
    63      public String getCharacterEncoding() {
    64          return request.getCharacterEncoding();
    65      }
    66
    67      /**
    68       * Retrieve the content type of the request.
    69       *
    70       * @return The content type of the request.
    71       */
    72      public String getContentType() {
    73          return request.getContentType();
    74      }
    75
    76      /**
    77       * Retrieve the content length of the request.
    78       *
    79       * @return The content length of the request.
    80       */
    81      public int getContentLength() {
    82          return request.getContentLength();
    83      }
    84
    85      /**
    86       * Retrieve the input stream for the request.
    87       *
    88       * @return The input stream for the request.
    89       *
    90       * @throws IOException if a problem occurs.
    91       */
    92      public InputStream getInputStream() throws IOException {
    93          return request.getInputStream();
    94      }
    95
    96      /**
    97       * Returns a string representation of this object.
    98       *
    99       * @return a string representation of this object.
    100      */
    101     public String toString() {
    102         return "ContentLength="
    103             + this.getContentLength()
    104             + ", ContentType="
    105             + this.getContentType();
    106     }
    107 }