FileStore


1   /* ***** BEGIN LICENSE BLOCK *****
2    * Version: MPL 1.1
3    * The contents of this file are subject to the Mozilla Public License Version
4    * 1.1 (the "License"); you may not use this file except in compliance with
5    * the License. You may obtain a copy of the License at
6    * http://www.mozilla.org/MPL/
7    * 
8    * Software distributed under the License is distributed on an "AS IS" basis,
9    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10   * for the specific language governing rights and limitations under the
11   * License.
12   * 
13   * The Original Code is Riot.
14   * 
15   * The Initial Developer of the Original Code is
16   * Neteye GmbH.
17   * Portions created by the Initial Developer are Copyright (C) 2006
18   * the Initial Developer. All Rights Reserved.
19   * 
20   * Contributor(s):
21   *   Felix Gnass [fgnass at neteye dot de]
22   * 
23   * ***** END LICENSE BLOCK ***** */
24  package org.riotfamily.common.web.file;
25  
26  import java.io.File  ;
27  import java.io.IOException  ;
28  
29  public interface FileStore {
30  
31      /**
32       * Moves the given file into the store and returns an URI that can be
33       * used to request the file via HTTP.
34       * <p>
35       * Implementors are expected to move the given file to a new location.
36       * </p>
37       * @param file The file to move into the store
38       * @param fileName The desired target file name, or <code>null</code> if it
39       *        should be up to the store to choose a name 
40       * @return The URI to access the stored file
41       */
42      public String   store(File   file, String   fileName) throws IOException  ;
43      
44      /**
45       * Retrieves a file from the store that was previously added via the
46       * {@link #store(File, String) store()} method. 
47       */
48      public File   retrieve(String   uri);
49      
50      /**
51       * Deletes the file denoted by the given URI from the store.
52       */
53      public void delete(String   uri);
54      
55  }
56
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags