com.ibm.fhir.persistence.jdbc.util.ParameterNamesCache Maven / Gradle / Ivy
/*
* (C) Copyright IBM Corp. 2017,2019
*
* SPDX-License-Identifier: Apache-2.0
*/
package com.ibm.fhir.persistence.jdbc.util;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.ibm.fhir.config.FHIRRequestContext;
import com.ibm.fhir.persistence.jdbc.dao.api.ParameterDAO;
import com.ibm.fhir.persistence.jdbc.exception.FHIRPersistenceDBConnectException;
import com.ibm.fhir.persistence.jdbc.exception.FHIRPersistenceDataAccessException;
/**
* This class provides a static cache for FHIR Search Parameter names.
*/
public class ParameterNamesCache {
private static final String CLASSNAME = ParameterNamesCache.class.getName();
private static final Logger log = Logger.getLogger(CLASSNAME);
private static boolean enabled = true;
/**
* The following is a map of parameter name maps. Each FHIR tenant/datastore combination will have its own
* mapping of parameter-name to parameter-name-id.
*/
private static ConcurrentHashMap> parameterNameIdMaps = new ConcurrentHashMap<>();
/**
* Retrieves the id for the name contained in the passed Parameter, for the current tenant-datastore.
* If not found, null is returned.
* @param parameterName A valid FHIR search parameter name.
* @return Integer The id corresponding to the parameter name.
* @throws FHIRPersistenceDataAccessException
* @throws FHIRPersistenceDBConnectException
*/
public static Integer getParameterNameId(String parameterName) {
String tenantDatstoreCacheName = getCacheNameForTenantDatastore();
ConcurrentHashMap currentDsMap;
Integer parameterNameId = null;
if (enabled) {
currentDsMap = parameterNameIdMaps.putIfAbsent(tenantDatstoreCacheName, new ConcurrentHashMap());
if (currentDsMap == null) {
log.fine("getParameterNameId() - Added new cache map for tennantDatastore=" + tenantDatstoreCacheName);
}
currentDsMap = parameterNameIdMaps.get(tenantDatstoreCacheName);
parameterNameId = currentDsMap.get(parameterName);
}
return parameterNameId;
}
/**
* Adds the passed parameter name and id to the current tenant-datastore cache.
* @param tenantDatastoreCacheName The name of the datastore-specific cache the entry should be added to.
* @param parameterName A valid search parameter name.
* @param parameterId The id associated with the passed parameter name.
*/
public static void putParameterNameId(String tenantDatastoreCacheName, String parameterName, Integer parameterId) {
ConcurrentHashMap currentDsMap;
Integer tempValue;
if (enabled) {
currentDsMap = parameterNameIdMaps.putIfAbsent(tenantDatastoreCacheName, new ConcurrentHashMap());
if (currentDsMap == null) {
log.fine("putParameterNameId() - Added new cache map for tennantDatastore=" + tenantDatastoreCacheName);
}
currentDsMap = parameterNameIdMaps.get(tenantDatastoreCacheName);
tempValue = currentDsMap.putIfAbsent(parameterName, parameterId);
if (tempValue == null) {
log.fine("putParameterNameId() - Added new cache entry, key=" + parameterName + " value=" + parameterId + " tenantDatstoreCacheName=" + tenantDatastoreCacheName);
}
}
}
/**
* Adds the passed search parameter name/id pairs to the the current tenant-datastore cache.
* @param tenantDatastoreCacheName The name of the datastore-specific cache the entry should be added to.
* @param newParameters A Map containing parameter name/id pairs.
*/
public static void putParameterNameIds(String tenantDatastoreCacheName, Map newParameters) {
if (enabled) {
for (Map.Entry entry : newParameters.entrySet()) {
putParameterNameId(tenantDatastoreCacheName, entry.getKey(), entry.getValue());
}
}
}
/**
* Returns a String containing a combination of the current tenantId and datastoreId.
* @return
*/
public static String getCacheNameForTenantDatastore() {
StringBuilder cacheName = new StringBuilder();
cacheName.append(FHIRRequestContext.get().getTenantId())
.append("~")
.append(FHIRRequestContext.get().getDataStoreId());
return cacheName.toString();
}
/**
*
* @return String - A formatted representation of the entire cache managed by this class.
*/
public static String dumpCacheContents() {
return CacheUtil.dumpCacheContents("ParameterNamesCache", parameterNameIdMaps);
}
/**
* Determines and reports any discrepancies between the current thread's Parameter Names cache and the contents of the database PARAMETER_NAMES table.
* @param dao A Parameter DAO instance
* @return String - A report detailing cache/db discrepancies.
*/
public static String reportCacheDiscrepancies(ParameterDAO dao) {
String tenantDatstoreCacheName = getCacheNameForTenantDatastore();
ConcurrentHashMap cachedMap = parameterNameIdMaps.get(tenantDatstoreCacheName);
Map dbMap;
String discrepancies = "";
if (enabled) {
try {
dbMap = dao.readAllSearchParameterNames();
discrepancies = CacheUtil.reportCacheDiscrepancies("ParameterNamesCache", cachedMap, dbMap);
}
catch (FHIRPersistenceDBConnectException | FHIRPersistenceDataAccessException e) {
log.log(Level.SEVERE, "Failure obtaining all search parameter names." , e);
discrepancies = CacheUtil.NEWLINE + "Could not report on ParameterNames cache discrepancies." + CacheUtil.NEWLINE;
}
}
return discrepancies;
}
public static boolean isEnabled() {
return enabled;
}
public static void setEnabled(boolean newEnabled) {
if (newEnabled != enabled) {
synchronized(CodeSystemsCache.class) {
enabled = newEnabled;
// When enabling the cache, clear out any old stuff.
if (newEnabled) {
parameterNameIdMaps.clear();
}
}
}
}
}