1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* ============LICENSE_START==========================================
* ONAP Portal SDK
* ===================================================================
* Copyright © 2017 AT&T Intellectual Property. All rights reserved.
* ===================================================================
*
* Unless otherwise specified, all software contained herein is licensed
* under the Apache License, Version 2.0 (the "License");
* you may not use this software except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Unless otherwise specified, all documentation contained herein is licensed
* under the Creative Commons License, Attribution 4.0 Intl. (the "License");
* you may not use this documentation except in compliance with the License.
* You may obtain a copy of the License at
*
* https://creativecommons.org/licenses/by/4.0/
*
* Unless required by applicable law or agreed to in writing, documentation
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* ============LICENSE_END============================================
*
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
*/
package org.onap.portalsdk.core.objectcache.jcs;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import javax.annotation.PostConstruct;
import javax.servlet.ServletContext;
import org.apache.jcs.JCS;
import org.apache.jcs.access.exception.CacheException;
import org.apache.jcs.engine.CacheConstants;
import org.apache.jcs.engine.behavior.IElementAttributes;
import org.apache.jcs.engine.control.CompositeCacheManager;
import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.onap.portalsdk.core.objectcache.AbstractCacheManager;
import org.onap.portalsdk.core.service.DataAccessService;
import org.onap.portalsdk.core.util.SystemProperties;
import org.springframework.web.context.ServletContextAware;
public abstract class JCSCacheManager extends AbstractCacheManager implements CacheConstants, ServletContextAware {
private static final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(JCSCacheManager.class);
public static final String LOOKUP_OBJECT_CACHE_NAME = "lookUpObjectCache";
public static final String JCS_CONFIG_FILE_PATH = "cache_config_file_path";
public static final String CACHE_LOAD_ON_STARTUP = "cache_load_on_startup";
public static final String CACHE_PROPERTY_VALUE_TRUE = "true";
public static final String CACHE_CONTROL_SWITCH_ON = "1";
public static final String CACHE_CONTROL_SWITCH_OFF = "0";
public static final String CACHE_CONTROL_SWITCH = "cache_switch";
private JCS lookUpCache;
private ServletContext servletContext;
private Properties cacheConfigProperties = null;
private final ArrayList<String> jscManagedCacheList = new ArrayList<>();
private DataAccessService dataAccessService;
public JCSCacheManager() {
super();
jscManagedCacheList.add(LOOKUP_OBJECT_CACHE_NAME);
}
@Override
@PostConstruct
public void configure() throws IOException {
super.configure();
String jcsConfigFilePath = SystemProperties.getProperty(JCS_CONFIG_FILE_PATH);
// getProperty throws if the key is missing; but check anyhow.
if (jcsConfigFilePath == null || jcsConfigFilePath.length() == 0)
throw new IOException("configure: failed to get value for config property " + JCS_CONFIG_FILE_PATH);
InputStream jcsConfigInputStream = getServletContext().getResourceAsStream(jcsConfigFilePath);
if (jcsConfigInputStream == null)
throw new IOException("configure: failed to open stream for config property " + JCS_CONFIG_FILE_PATH
+ " with name " + jcsConfigFilePath);
logger.debug(EELFLoggerDelegate.debugLogger, "configure: loading cache properties from classpath resource {} ",
jcsConfigFilePath);
Properties p = new Properties();
p.load(jcsConfigInputStream);
jcsConfigInputStream.close();
CompositeCacheManager ccm = CompositeCacheManager.getUnconfiguredInstance();
ccm.configure(p);
setCacheConfigProperties(p);
try {
initializeLookUpCache();
} catch (CacheException ce) {
throw new IOException("configure: failed to initialize lookup cache", ce);
}
}
private void initializeLookUpCache() throws CacheException {
lookUpCache = JCS.getInstance(LOOKUP_OBJECT_CACHE_NAME);
JCSCacheEventHandler eventHandler = new JCSCacheEventHandler();
IElementAttributes elementAttributes = lookUpCache.getDefaultElementAttributes();
elementAttributes.addElementEventHandler(eventHandler);
lookUpCache.setDefaultElementAttributes(elementAttributes);
if (CACHE_PROPERTY_VALUE_TRUE.equalsIgnoreCase(SystemProperties.getProperty(CACHE_LOAD_ON_STARTUP))) {
loadDataOnStartUp();
}
}
@Override
public Object getObject(String key) {
if (CACHE_CONTROL_SWITCH_ON.equalsIgnoreCase(SystemProperties.getProperty(CACHE_CONTROL_SWITCH))) {
if (lookUpCache == null)
return null;
else
return lookUpCache.get(key);
} else
return null;
}
@Override
public void putObject(String key, Object objectToCache) {
try {
if (CACHE_CONTROL_SWITCH_ON.equalsIgnoreCase(SystemProperties.getProperty(CACHE_CONTROL_SWITCH))
&& lookUpCache != null) {
lookUpCache.put(key, objectToCache);
}
} catch (CacheException ce) {
logger.error(EELFLoggerDelegate.errorLogger, "putObject: failed to put the object with key " + key, ce);
}
}
public void clearCache(String region) {
try {
if (region.equals(LOOKUP_OBJECT_CACHE_NAME))
lookUpCache.clear();
} catch (CacheException ce) {
logger.error(EELFLoggerDelegate.errorLogger,
"clearCache: failed to clear the cache for the region " + region, ce);
}
}
@Override
public void clearCache() {
clearCache(LOOKUP_OBJECT_CACHE_NAME);
}
private void loadDataOnStartUp() {
loadLookUpCache();
}
public abstract void loadLookUpCache();
public void refreshLookUpCache() {
clearCache(LOOKUP_OBJECT_CACHE_NAME);
loadLookUpCache();
}
public Properties getCacheConfigProperties() {
return cacheConfigProperties;
}
public void setCacheConfigProperties(Properties cacheConfigProperties) {
this.cacheConfigProperties = cacheConfigProperties;
}
public List<String> getJscManagedCacheList() {
return jscManagedCacheList;
}
public DataAccessService getDataAccessService() {
return dataAccessService;
}
public void setDataAccessService(DataAccessService dataAccessService) {
this.dataAccessService = dataAccessService;
}
public ServletContext getServletContext() {
return servletContext;
}
@Override
public void setServletContext(ServletContext servletContext) {
this.servletContext = servletContext;
}
}
|
