1 /*
2 * Copyright (c) 2002-2021, City of 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.database;
35
36 import fr.paris.lutece.plugins.blobstore.business.BytesBlobStore;
37 import fr.paris.lutece.plugins.blobstore.business.InputStreamBlobStore;
38
39 import java.io.InputStream;
40
41 /**
42 * The Interface IDatabaseBlobStoreHome.
43 */
44 public interface IDatabaseBlobStoreHome
45 {
46 /**
47 * Get the last primary key.
48 *
49 * @return The last primary key
50 */
51 String getLastPrimaryKey( );
52
53 /**
54 * Creation of an instance of record physical file.
55 *
56 * @param blobStore
57 * The instance of the physical file which contains the informations to store
58 */
59 void create( BytesBlobStore blobStore );
60
61 /**
62 * Update of physical file which is specified in parameter.
63 *
64 * @param blobStore
65 * The instance of the record physicalFile which contains the informations to update
66 */
67 void update( BytesBlobStore blobStore );
68
69 /**
70 * Update of physical file which is specified in parameter.
71 *
72 * @param blobStore
73 * The instance of the record physicalFile which contains the informations to update
74 */
75 void updateInputStream( InputStreamBlobStore blobStore );
76
77 /**
78 * Delete the physical file whose identifier is specified in parameter.
79 *
80 * @param strKey
81 * The identifier of the record physical file
82 */
83 void remove( String strKey );
84
85 /**
86 * Returns an instance of a physical file whose identifier is specified in parameter.
87 *
88 * @param strKey
89 * The file primary key
90 * @return an instance of physical file
91 */
92 BytesBlobStore findByPrimaryKey( String strKey );
93
94 /**
95 * Returns an instance of a physical file whose identifier is specified in parameter.
96 *
97 * @param strKey
98 * The file primary key
99 * @return an instance of physical file
100 */
101 InputStream findByPrimaryKeyInputStream( String strKey );
102
103 /**
104 * Creation of an instance of record physical file.
105 *
106 * @param blobStore
107 * The instance of the physical file which contains the inputstream to store
108 */
109 void createInputStream( InputStreamBlobStore blobStore );
110 }