1 /*
2 * Copyright (c) 2002-2022, 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.portal.service.file;
35
36 import java.io.Serializable;
37 import java.util.Map;
38 import javax.servlet.http.HttpServletRequest;
39
40 import fr.paris.lutece.portal.service.util.AppPropertiesService;
41
42 /**
43 *
44 * Builds download Url. Useful when we want to share a http link, ftp link, or fylesystem link.
45 *
46 * @see JSPBlobStoreDownloadUrlService
47 */
48 public interface IFileDownloadUrlService extends Serializable
49 {
50 static final int LINK_VALIDITY_TIME = AppPropertiesService.getPropertyInt( "lutece.file.download.validity", 0 );
51
52 /**
53 * get Front Office user download URL
54 *
55 * @param strFileKey
56 * the file key
57 * @return the url
58 */
59 String getFileDownloadUrlFO( String strFileKey, String strFileStorageServiceProviderName );
60
61 /**
62 * get Front Office user download URL
63 *
64 * @param strFileKey
65 * the file key
66 * @param additionnalData
67 * the data used to build the url
68 * @return the url
69 */
70 String getFileDownloadUrlFO( String strFileKey, Map<String, String> additionnalData, String strFileStorageServiceProviderName );
71
72 /**
73 * get Back Office user download URL
74 *
75 * @param strFileKey
76 * the file key
77 * @return the url
78 */
79 String getFileDownloadUrlBO( String strFileKey, String strFileStorageServiceProviderName );
80
81 /**
82 * get Back Office user download URL
83 *
84 * @param strFileKey
85 * the file key
86 * @param additionnalData
87 * the data used to build the url
88 * @return the url
89 */
90 String getFileDownloadUrlBO( String strFileKey, Map<String, String> additionnalData, String strFileStorageServiceProviderName );
91
92 /**
93 * get service name
94 *
95 * @return the service name
96 */
97 String getName( );
98
99 /**
100 * get BO file data from request
101 *
102 * @param request
103 * @return the map of file data
104 */
105 Map<String, String> getRequestDataBO( HttpServletRequest request );
106
107 /**
108 * get FO file data from request
109 *
110 * @param request
111 * @return the map of file data
112 */
113 Map<String, String> getRequestDataFO( HttpServletRequest request );
114
115 /**
116 * check link validity
117 *
118 * @param fileData
119 * @throws ExpiredLinkException
120 * if link is invadid
121 */
122 void checkLinkValidity( Map<String, String> fileData ) throws ExpiredLinkException;
123
124 /**
125 * Return the validity duration of a link (in minutes) <br />
126 * if equal to 0, there is no limit
127 *
128 * @return
129 */
130 default int getValidityTime( )
131 {
132 return LINK_VALIDITY_TIME;
133 }
134 }