RequestContext.java

  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.fileupload2.core;

  18. import java.io.IOException;
  19. import java.io.InputStream;
  20. import java.nio.charset.Charset;
  21. import java.nio.charset.UnsupportedCharsetException;

  22. import org.apache.commons.io.Charsets;

  23. /**
  24.  * Abstracts access to the request information needed for file uploads.
  25.  * <p>
  26.  * This interface should be implemented for each type of request that may be handled by FileUpload, such as servlets and portlets.
  27.  * </p>
  28.  */
  29. public interface RequestContext {

  30.     /**
  31.      * Gets the character encoding for the request.
  32.      *
  33.      * @return The character encoding for the request.
  34.      */
  35.     String getCharacterEncoding();

  36.     /**
  37.      * Gets the character encoding for the request or null if unspecified.
  38.      *
  39.      * @return The character encoding for the request or null.
  40.      * @throws UnsupportedCharsetException If the named Charset is unavailable.
  41.      */
  42.     default Charset getCharset() throws UnsupportedCharsetException {
  43.         return Charsets.toCharset(getCharacterEncoding(), null);
  44.     }

  45.     /**
  46.      * Gets the content length of the request.
  47.      *
  48.      * @return The content length of the request.
  49.      */
  50.     long getContentLength();

  51.     /**
  52.      * Gets the content type of the request.
  53.      *
  54.      * @return The content type of the request.
  55.      */
  56.     String getContentType();

  57.     /**
  58.      * Gets the input stream for the request.
  59.      *
  60.      * @return The input stream for the request.
  61.      * @throws IOException if a problem occurs.
  62.      */
  63.     InputStream getInputStream() throws IOException;

  64.     /**
  65.      * Is the Request of type {@code multipart/related}?
  66.      *
  67.      * @return the Request is of type {@code multipart/related}
  68.      * @since 2.0.0
  69.      */
  70.     boolean isMultipartRelated();
  71. }