1 /*
2 * Copyright 2012 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package org.jboss.netty.handler.codec.http.multipart;
17
18 import org.jboss.netty.handler.codec.http.HttpRequest;
19
20 import java.nio.charset.Charset;
21
22 /**
23 * Interface to enable creation of InterfaceHttpData objects
24 */
25 public interface HttpDataFactory {
26 /**
27 * To set a max size limitation on fields. Exceeding it will generate an ErrorDataDecoderException.
28 * A value of -1 means no limitation (default).
29 * @param max
30 */
31 void setMaxLimit(long max);
32
33 /**
34 *
35 * @param request associated request
36 * @return a new Attribute with no value
37 */
38 Attribute createAttribute(HttpRequest request, String name);
39
40 /**
41 *
42 * @param request associated request
43 * @return a new Attribute
44 */
45 Attribute createAttribute(HttpRequest request, String name, String value);
46
47 /**
48 * @param request associated request
49 * @param size the size of the Uploaded file
50 * @return a new FileUpload
51 */
52 FileUpload createFileUpload(HttpRequest request, String name, String filename,
53 String contentType, String contentTransferEncoding, Charset charset,
54 long size);
55
56 /**
57 * Remove the given InterfaceHttpData from clean list (will not delete the file, except if the file
58 * is still a temporary one as setup at construction)
59 * @param request associated request
60 */
61 void removeHttpDataFromClean(HttpRequest request, InterfaceHttpData data);
62
63 /**
64 * Remove all InterfaceHttpData from virtual File storage from clean list for the request
65 *
66 * @param request associated request
67 */
68 void cleanRequestHttpDatas(HttpRequest request);
69
70 /**
71 * Remove all InterfaceHttpData from virtual File storage from clean list for all requests
72 */
73 void cleanAllHttpDatas();
74 }