View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.custom.fileupload;
20  
21  import java.io.IOException;
22  import java.io.InputStream;
23  import java.io.Serializable;
24  
25  
26  
27  /**
28   * @author Manfred Geiler (latest modification by $Author: mmarinschek $)
29   * @version $Revision: 599022 $ $Date: 2007-11-28 10:14:17 -0500 (Wed, 28 Nov 2007) $
30   */
31  public interface UploadedFile extends Serializable
32  {
33  
34  
35      /**
36       * Answer the uploaded file contents.
37       *
38       * @return file contents
39       */
40      byte[] getBytes() throws IOException;
41  
42  
43      /**
44       * Answer the uploaded file contents input stream
45       *
46       * @throws IOException
47       * @return InputStream
48       */
49      InputStream getInputStream() throws IOException;
50  
51  
52      /**
53       * @return Returns the contentType.
54       */
55      String getContentType();
56  
57  
58  
59      /**
60       * @return Returns the name.
61       */
62      String getName();
63  
64  
65      /**
66       * Returns the size of this file.
67       * @return long
68       */
69      long getSize();
70      
71      /**Allows to get more information/interact more with the file, depending
72       * on where it is stored
73       * 
74       * @return StorageStrategy the storage strategy of this file, 
75       */
76      StorageStrategy getStorageStrategy();
77  }