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.service;
35
36 import org.apache.commons.fileupload.FileItem;
37
38 /**
39 *
40 * IBlobStoreClientService
41 *
42 */
43 public interface IBlobStoreClientService
44 {
45 /**
46 * Get the file name given an url
47 *
48 * @param strUrl
49 * the url
50 * @return the file name
51 * @throws BlobStoreClientException
52 * exception if there is an issue
53 */
54 String getFileName( String strUrl ) throws BlobStoreClientException;
55
56 /**
57 * Do delete a file in the blobstore webapp
58 *
59 * @param strBaseUrl
60 * the base url
61 * @param strBlobStore
62 * the blobstore service name
63 * @param strBlobKey
64 * the blob key
65 * @return the deleted blob key
66 * @throws BlobStoreClientException
67 * exception if there is an issue
68 */
69 String doDeleteFile( String strBaseUrl, String strBlobStore, String strBlobKey ) throws BlobStoreClientException;
70
71 /**
72 * Do upload a file in the blobstore webapp
73 *
74 * @param strBaseUrl
75 * the base url
76 * @param fileItem
77 * the file to upload
78 * @param strBlobStore
79 * the blobstore service name
80 * @return the uploaded file blob key
81 * @throws BlobStoreClientException
82 * exception if there is an issue
83 */
84 String doUploadFile( String strBaseUrl, FileItem fileItem, String strBlobStore ) throws BlobStoreClientException;
85
86 /**
87 * Get the file url
88 *
89 * @param strBaseUrl
90 * the base url
91 * @param strBlobStore
92 * the blobstore service name
93 * @param strBlobKey
94 * the blob key
95 * @return the file url
96 * @throws BlobStoreClientException
97 * exception if there is an issue
98 */
99 String getFileUrl( String strBaseUrl, String strBlobStore, String strBlobKey ) throws BlobStoreClientException;
100
101 /**
102 * Download the file to the file path
103 *
104 * @param strUrl
105 * the url of the file
106 * @param strFilePath
107 * the file path
108 * @throws BlobStoreClientException
109 * exception if there is an error
110 */
111 void doDownloadFile( String strUrl, String strFilePath ) throws BlobStoreClientException;
112
113 /**
114 * Download the file
115 *
116 * @param strUrl
117 * the url of the file
118 * @return a {@link FileItem}
119 * @throws BlobStoreClientException
120 * exception if there is an error
121 */
122 FileItem doDownloadFile( String strUrl ) throws BlobStoreClientException;
123 }