View Javadoc
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.fileupload;
18  
19  /**
20   * Interface that will indicate that {@link FileItem} or {@link FileItemStream}
21   * implementations will accept the headers read for the item.
22   *
23   * @since 1.2.1
24   * @see FileItem
25   * @see FileItemStream
26   */
27  public interface FileItemHeadersSupport {
28  
29      /**
30       * Returns the collection of headers defined locally within this item.
31       *
32       * @return the {@link FileItemHeaders} present for this item.
33       */
34      FileItemHeaders getHeaders();
35  
36      /**
37       * Sets the headers read from within an item.  Implementations of
38       * {@link FileItem} or {@link FileItemStream} should implement this
39       * interface to be able to get the raw headers found within the item
40       * header block.
41       *
42       * @param headers the instance that holds onto the headers
43       *         for this instance.
44       */
45      void setHeaders(FileItemHeaders headers);
46  
47  }