com.phloc.web.fileupload.IRequestContext Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed 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 com.phloc.web.fileupload;

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

/**
 * 
 * Abstracts access to the request information needed for file uploads. This
 * interfsace should be implemented for each type of request that may be handled
 * by FileUpload, such as servlets and portlets.
 * 
 * 
 * @author Martin Cooper
 * @since FileUpload 1.1
 * @version $Id: RequestContext.java 479262 2006-11-26 03:09:24Z niallp $
 */
public interface IRequestContext
{
  /**
   * Retrieve the character encoding for the request.
   * 
   * @return The character encoding for the request.
   */
  String getCharacterEncoding ();

  /**
   * Retrieve the content type of the request.
   * 
   * @return The content type of the request.
   */
  String getContentType ();

  /**
   * Retrieve the content length of the request.
   * 
   * @return The content length of the request.
   */
  long getContentLength ();

  /**
   * Retrieve the input stream for the request.
   * 
   * @return The input stream for the request.
   * @throws IOException
   *         if a problem occurs.
   */
  InputStream getInputStream () throws IOException;
}