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
19 import java.io.IOException;
20 import java.io.InputStream;
21 import java.nio.charset.Charset;
22 import java.nio.charset.UnsupportedCharsetException;
23
24 import org.apache.commons.io.Charsets;
25
26 /**
27 * Abstracts access to the request information needed for file uploads.
28 * <p>
29 * This interface should be implemented for each type of request that may be handled by FileUpload, such as servlets and portlets.
30 * </p>
31 */
32 public interface RequestContext {
33
34 /**
35 * Gets the character encoding for the request.
36 *
37 * @return The character encoding for the request.
38 */
39 String getCharacterEncoding();
40
41 /**
42 * Gets the character encoding for the request or null if unspecified.
43 *
44 * @return The character encoding for the request or null.
45 * @throws UnsupportedCharsetException If the named Charset is unavailable.
46 */
47 default Charset getCharset() throws UnsupportedCharsetException {
48 return Charsets.toCharset(getCharacterEncoding(), null);
49 }
50
51 /**
52 * Gets the content length of the request.
53 *
54 * @return The content length of the request.
55 */
56 long getContentLength();
57
58 /**
59 * Gets the content type of the request.
60 *
61 * @return The content type of the request.
62 */
63 String getContentType();
64
65 /**
66 * Gets the input stream for the request.
67 *
68 * @return The input stream for the request.
69 * @throws IOException if a problem occurs.
70 */
71 InputStream getInputStream() throws IOException;
72
73 }