View Javadoc

1   /*
2    * Copyright (c) 2002-2014, 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  package fr.paris.lutece.plugins.blobstore.business.filesystem;
35  
36  import fr.paris.lutece.plugins.blobstore.business.BytesBlobStore;
37  import fr.paris.lutece.plugins.blobstore.business.InputStreamBlobStore;
38  
39  import java.io.IOException;
40  import java.io.InputStream;
41  
42  
43  /**
44   *
45   * Uses filesystem to store blobs.
46   *
47   */
48  public interface IFileSystemBlobStoreDAO
49  {
50      /**
51       * Inserts the blobStore.
52       *
53       * @param blobStore blobStore
54       * @param strBasePath base directory
55       * @param depth the depth
56       * @throws IOException ioexception
57       * @throws FileAlreadyExistsException if the file already exists
58       */
59      void insert( BytesBlobStore blobStore, String strBasePath, Integer depth )
60          throws IOException, FileAlreadyExistsException;
61  
62      /**
63       * Inserts the InputStreamDatabaseBlobStore.
64       *
65       * @param blobStore blobStore
66       * @param strBasePath base directory
67       * @param depth the depth
68       * @throws FileAlreadyExistsException if the file already exists
69       * @throws IOException ioexception
70       */
71      void insert( InputStreamBlobStore blobStore, String strBasePath, Integer depth )
72          throws FileAlreadyExistsException, IOException;
73  
74      /**
75       * Load the data from the table.
76       *
77       * @param strId            The identifier
78       * @param strBasePath            base directory
79       * @param depth the depth
80       * @return the instance of the DatabaseBlobStore
81       * @throws IOException             ioexception
82       */
83      BytesBlobStore load( String strId, String strBasePath, Integer depth )
84          throws IOException;
85  
86      /**
87       * Loads the InputStreamDatabaseBlobStore.
88       *
89       * @param strId            id
90       * @param strBasePath            base path
91       * @param depth the depth
92       * @return the InputStreamDatabaseBlobStore
93       * @throws IOException             ioexception
94       */
95      InputStream loadInputStream( String strId, String strBasePath, Integer depth )
96          throws IOException;
97  
98      /**
99       * Updates the file.
100      *
101      * @param blobStore the blob
102      * @param strBasePath the base directory
103      * @param depth the depth
104      * @throws IOException ioexception
105      */
106     void store( BytesBlobStore blobStore, String strBasePath, Integer depth )
107         throws IOException;
108 
109     /**
110      * Updates the file.
111      *
112      * @param blobStore the blob
113      * @param strBasePath the base directory
114      * @param depth the depth
115      * @throws IOException ioexception
116      */
117     void storeInputStream( InputStreamBlobStore blobStore, String strBasePath, Integer depth )
118         throws IOException;
119 
120     /**
121      * Removes the file.
122      *
123      * @param strKey the key
124      * @param strBasePath the base directory
125      * @param depth the depth
126      * @return <code>true</code> if the file is deleted, <code>false</code> otherwise
127      * @throws IOException ioexception
128      */
129     boolean delete( String strKey, String strBasePath, Integer depth )
130         throws IOException;
131 }