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.plugins.resource.service;
35
36 import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
37
38 /**
39 * Cache service for resources, resource types and resources providers
40 */
41 public final class ResourceCacheService extends AbstractCacheableService
42 {
43 private static final String CACHE_SERVICE_NAME = "resource.resourceCacheService";
44 private static final String CACHE_KEY_RESOURCE_TYPE_PROVIDER = "resource.provider.resourceType.";
45 private static final String CACHE_KEY_RESOURCE_TYPE_LIST = "resource.resourceTypes.list";
46 private static final String CACHE_KEY_RESOURCE_DATABASE = "resource.resource.";
47 private static final String CACHE_KEY_RESOURCE_TYPE = "resource.resourceType.";
48 private static final String CACHE_KEY_RESOURCE = "resource.resource.type.";
49 private static final String CONSTANT_POINT = ".";
50 private static final ResourceCacheServicee/ResourceCacheService.html#ResourceCacheService">ResourceCacheService _instance = new ResourceCacheService( );
51
52 /**
53 * Default constructor
54 */
55 private ResourceCacheService( )
56 {
57 initCache( );
58 }
59
60 /**
61 * Get the instance of the service
62 *
63 * @return The instance of the service
64 */
65 public static ResourceCacheService getInstance( )
66 {
67 return _instance;
68 }
69
70 /**
71 * {@inheritDoc}
72 */
73 @Override
74 public String getName( )
75 {
76 return CACHE_SERVICE_NAME;
77 }
78
79 /**
80 * Get the cache key of the association between a resource provider and a resource type
81 *
82 * @param strResourceType
83 * The resource type
84 * @return The cache key of the association between a resource provider and a resource type
85 */
86 public static String getResourceTypeProviderCacheKey( String strResourceType )
87 {
88 return CACHE_KEY_RESOURCE_TYPE_PROVIDER + strResourceType;
89 }
90
91 /**
92 * Get the cache key for the list of resource types
93 *
94 * @return The cache key for the list of resource types
95 */
96 public static String getResourceTypesListCacheKey( )
97 {
98 return CACHE_KEY_RESOURCE_TYPE_LIST;
99 }
100
101 /**
102 * Get the cache key for resources
103 *
104 * @param strIdResource
105 * The id of the resource
106 * @param strResourceType
107 * The resource type
108 * @return The cache key for the given resource
109 */
110 public static String getResourceCacheKey( String strIdResource, String strResourceType )
111 {
112 StringBuilder sbCacheKey = new StringBuilder( CACHE_KEY_RESOURCE );
113 sbCacheKey.append( strResourceType );
114 sbCacheKey.append( CONSTANT_POINT );
115 sbCacheKey.append( strIdResource );
116
117 return sbCacheKey.toString( );
118 }
119
120 /**
121 * Get the cache key for resources. This method should only be used to manage database resource type keys. <br />
122 * To cache resources of any other providers, use the {@link #getResourceCacheKey(String strIdResource, String strResourceType)} method.
123 *
124 * @param strIdResource
125 * The id of the resource
126 * @return The cache key for the given resource
127 */
128 public static String getDatabaseResourceCacheKey( String strIdResource )
129 {
130 return CACHE_KEY_RESOURCE_DATABASE + strIdResource;
131 }
132
133 /**
134 * Get the cache for resource types
135 *
136 * @param strResourceType
137 * The resource type
138 * @return The cache key for the given resource type
139 */
140 public static String getResourceTypeCacheKey( String strResourceType )
141 {
142 return CACHE_KEY_RESOURCE_TYPE + strResourceType;
143 }
144 }