View Javadoc
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 io.netty.handler.codec.http.multipart;
17  
18  import io.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      /**
28       * To set a max size limitation on fields. Exceeding it will generate an ErrorDataDecoderException.
29       * A value of -1 means no limitation (default).
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       * @param request associated request
42       * @return a new Attribute
43       */
44      Attribute createAttribute(HttpRequest request, String name, String value);
45  
46      /**
47       * @param request associated request
48       * @param size the size of the Uploaded file
49       * @return a new FileUpload
50       */
51      FileUpload createFileUpload(HttpRequest request, String name, String filename,
52                                  String contentType, String contentTransferEncoding, Charset charset,
53                                  long size);
54  
55      /**
56       * Remove the given InterfaceHttpData from clean list (will not delete the file, except if the file
57       * is still a temporary one as setup at construction)
58       * @param request associated request
59       */
60      void removeHttpDataFromClean(HttpRequest request, InterfaceHttpData data);
61  
62      /**
63       * Remove all InterfaceHttpData from virtual File storage from clean list for the request
64       *
65       * @param request associated request
66       */
67      void cleanRequestHttpData(HttpRequest request);
68  
69      /**
70       * Remove all InterfaceHttpData from virtual File storage from clean list for all requests
71       */
72      void cleanAllHttpData();
73  }