/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.fileupload;

import java.io.InputStream;
import java.io.IOException;

Abstracts access to the request information needed for file uploads. This interface should be implemented for each type of request that may be handled by FileUpload, such as servlets and portlets.

Since:FileUpload 1.1
/** * <p>Abstracts access to the request information needed for file uploads. This * interface should be implemented for each type of request that may be * handled by FileUpload, such as servlets and portlets.</p> * * @since FileUpload 1.1 */
public interface RequestContext {
Retrieve the character encoding for the request.
Returns:The character encoding for the request.
/** * Retrieve the character encoding for the request. * * @return The character encoding for the request. */
String getCharacterEncoding();
Retrieve the content type of the request.
Returns:The content type of the request.
/** * Retrieve the content type of the request. * * @return The content type of the request. */
String getContentType();
Retrieve the content length of the request.
Returns:The content length of the request.
Deprecated:1.3 Use UploadContext.contentLength() instead
/** * Retrieve the content length of the request. * * @return The content length of the request. * @deprecated 1.3 Use {@link UploadContext#contentLength()} instead */
@Deprecated int getContentLength();
Retrieve the input stream for the request.
Throws:
Returns:The input stream for the request.
/** * Retrieve the input stream for the request. * * @return The input stream for the request. * * @throws IOException if a problem occurs. */
InputStream getInputStream() throws IOException; }