1 /*
2 * Copyright (c) 2002-2017, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34
35 package fr.paris.lutece.plugins.myfiles.service.storage;
36
37 import fr.paris.lutece.plugins.myfiles.business.MyFileData;
38 import fr.paris.lutece.plugins.myfiles.business.MyFileLink;
39 import java.util.List;
40
41 /**
42 * FileStorage
43 */
44 public interface FileStorage
45 {
46
47 /**
48 * Add a file to a storage space of a given user
49 *
50 * @param strUserId
51 * The user ID
52 * @param myFileData
53 * File data
54 * @throws StorageException
55 * If an error occurs during the storage access
56 */
57 void addFile( String strUserId, MyFileData myFileData ) throws StorageException;
58
59 /**
60 * Create a storage for agiven user
61 *
62 * @param strNameId
63 * The User ID
64 * @throws StorageException
65 * If an error occurs during the storage access
66 */
67 void createStorage( String strNameId ) throws StorageException;
68
69 /**
70 * Gets a file for a given user
71 *
72 * @param strUserId
73 * The user ID
74 * @param strFilename
75 * The filename
76 * @return The file
77 * @throws NoStorageException
78 * If no storage available for the user
79 * @throws StorageException
80 * If an error occurs during the storage access
81 */
82 MyFileData getFile( String strUserId, String strFilename ) throws NoStorageException, StorageException;
83
84 /**
85 * Gets all files for a given user
86 *
87 * @param strUserId
88 * The user ID
89 * @return The lest of files
90 * @throws NoStorageException
91 * If no storage available for the user
92 * @throws StorageException
93 * If an error occurs during the storage access
94 */
95 List<MyFileLink> getFiles( String strUserId ) throws NoStorageException, StorageException;
96
97 /**
98 * Remove a file from the storage space of a given user
99 *
100 * @param strUserId
101 * The User ID
102 * @param strFilename
103 * The Filename
104 * @throws StorageException
105 * If an error occurs during the storage access
106 */
107 void removeFile( String strUserId, String strFilename ) throws StorageException;
108
109 }