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 fr.paris.lutece.portal.service.util.LuteceService;
37
38 import java.util.List;
39
40 /**
41 * Base interface of Lutece services that provide a cache
42 */
43 public interface CacheableService extends LuteceService
44 {
45 /**
46 * Gets the current cache status.
47 *
48 * @return true if enable, otherwise false
49 */
50 boolean isCacheEnable( );
51
52 /**
53 * Gets the number of item currently in the cache.
54 *
55 * @return the number of item currently in the cache.
56 */
57 int getCacheSize( );
58
59 /**
60 * Reset the cache.
61 */
62 void resetCache( );
63
64 /**
65 * Enable the cache
66 *
67 * @param bEnable
68 * true to enable, false to disable
69 */
70 void enableCache( boolean bEnable );
71
72 /**
73 * Gets all keys in the cache
74 *
75 * @return The List
76 */
77 List<String> getKeys( );
78
79 /**
80 * Returns maximum elements accepted into the cache
81 *
82 * @return The max elements
83 */
84 int getMaxElements( );
85
86 /**
87 * Returns the time to live for objects in the cache
88 *
89 * @return The time to live in seconds
90 */
91 long getTimeToLive( );
92
93 /**
94 * Return the memory size
95 *
96 * @return the memory size
97 */
98 long getMemorySize( );
99
100 /**
101 * Returns cache infos
102 *
103 * @return cache infos
104 */
105 String getInfos( );
106 }