    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     */
    017    package org.apache.commons.fileupload.servlet;
    018
    019    import java.io.InputStream;
    020    import java.io.IOException;
    021    import javax.servlet.http.HttpServletRequest;
    022    import org.apache.commons.fileupload.RequestContext;
    023
    024    /**
    025     * <p>Provides access to the request information needed for a request made to
    026     * an HTTP servlet.</p>
    027     *
    028     * @author <a href="mailto:martinc@apache.org">Martin Cooper</a>
    029     *
    030     * @since FileUpload 1.1
    031     *
    032     * @version $Id: ServletRequestContext.java 479262 2006-11-26 03:09:24Z niallp $
    033     */
    034    public class ServletRequestContext implements RequestContext {
    035
    036        // ----------------------------------------------------- Instance Variables
    037
    038        /**
    039         * The request for which the context is being provided.
    040         */
    041        private HttpServletRequest request;
    042
    043
    044        // ----------------------------------------------------------- Constructors
    045
    046        /**
    047         * Construct a context for this request.
    048         *
    049         * @param request The request to which this context applies.
    050         */
    051        public ServletRequestContext(HttpServletRequest request) {
    052            this.request = request;
    053        }
    054
    055
    056        // --------------------------------------------------------- Public Methods
    057
    058        /**
    059         * Retrieve the character encoding for the request.
    060         *
    061         * @return The character encoding for the request.
    062         */
    063        public String getCharacterEncoding() {
    064            return request.getCharacterEncoding();
    065        }
    066
    067        /**
    068         * Retrieve the content type of the request.
    069         *
    070         * @return The content type of the request.
    071         */
    072        public String getContentType() {
    073            return request.getContentType();
    074        }
    075
    076        /**
    077         * Retrieve the content length of the request.
    078         *
    079         * @return The content length of the request.
    080         */
    081        public int getContentLength() {
    082            return request.getContentLength();
    083        }
    084
    085        /**
    086         * Retrieve the input stream for the request.
    087         *
    088         * @return The input stream for the request.
    089         *
    090         * @throws IOException if a problem occurs.
    091         */
    092        public InputStream getInputStream() throws IOException {
    093            return request.getInputStream();
    094        }
    095
    096        /**
    097         * Returns a string representation of this object.
    098         *
    099         * @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    }