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.cache;
35
36 import javax.servlet.http.HttpServletRequest;
37
38 /**
39 * Service interface for XPage path caching
40 */
41 public interface IPathCacheService
42 {
43
44 /** Bean name */
45 String BEAN_NAME = "pathCacheService";
46
47 /**
48 * Constructs a cache key
49 *
50 * @param strXPageName
51 * the XPage name
52 * @param nMode
53 * the mode
54 * @param request
55 * the request
56 * @return the cache key, or <code>null</code> if for instance the cache is not enabled
57 */
58 String getKey( String strXPageName, int nMode, HttpServletRequest request );
59
60 /**
61 * Constructs a cache key
62 *
63 * @param strXPageName
64 * the XPage name
65 * @param nMode
66 * the mode
67 * @param strTitlesUrls
68 * list of links (url and titles)
69 * @param request
70 * the request the request
71 * @return the cache key, or <code>null</code> if for instance the cache is not enabled
72 */
73 String getKey( String strXPageName, int nMode, String strTitlesUrls, HttpServletRequest request );
74
75 /**
76 * Get the path html from cache
77 *
78 * @param strKey
79 * the cache key
80 * @return the path html, or <code>null</code> if it's not in cache or the cache is not enabled
81 */
82 String getFromCache( String strKey );
83
84 /**
85 * Put a path in cache
86 *
87 * @param strKey
88 * the cache key
89 * @param path
90 * the path html
91 */
92 void putInCache( String strKey, String path );
93
94 }