com.centurylink.mdw.cache.impl.AssetCache Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mdw-common Show documentation
Show all versions of mdw-common Show documentation
MDW is a microservices based workflow framework
/*
* Copyright (C) 2017 CenturyLink, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file 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.
*/
package com.centurylink.mdw.cache.impl;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import com.centurylink.mdw.cache.CachingException;
import com.centurylink.mdw.cache.PreloadableCache;
import com.centurylink.mdw.dataaccess.AssetRef;
import com.centurylink.mdw.dataaccess.DataAccess;
import com.centurylink.mdw.dataaccess.DataAccessException;
import com.centurylink.mdw.model.asset.Asset;
import com.centurylink.mdw.model.asset.AssetVersionSpec;
import com.centurylink.mdw.model.workflow.Package;
import com.centurylink.mdw.util.AssetRefConverter;
import com.centurylink.mdw.util.log.LoggerUtil;
import com.centurylink.mdw.util.log.StandardLogger;
public class AssetCache implements PreloadableCache {
private static StandardLogger logger = LoggerUtil.getStandardLogger();
private static Map assetMap;
private static List allAssets; // initially unpopulated
private static List latestAssets;
private static List jarAssets;
private List preLoaded;
public void initialize(Map params) {
if (params != null) {
String preLoadString = params.get("PreInitialized");
if (preLoadString != null && preLoadString.trim().length() > 0) {
String[] preLoadedArr = preLoadString.split("\\\n");
for (String preLoad : preLoadedArr) {
if (preLoad.trim().length() > 0) {
if (preLoaded == null)
preLoaded = new ArrayList();
preLoaded.add(preLoad.trim());
}
}
}
}
}
public int getCacheSize() {
return getAssetMap().size();
}
public void clearCache() {
allAssets = null;
latestAssets = null;
assetMap = null;
jarAssets = null;
}
public static boolean isLoaded() {
return assetMap != null || latestAssets != null || allAssets != null;
}
public void loadCache() throws CachingException {
// load is performed lazily unless preloads are specified
if (preLoaded != null && preLoaded.size() > 0) {
try {
for (String preLoad : preLoaded) {
if (preLoad.length() > 0) {
Class preLoadExecCls = Class.forName(preLoad);
Method initMethod = preLoadExecCls.getMethod("initialize");
initMethod.invoke(null, (Object[])null);
}
}
}
catch (Exception ex) {
logger.severeException(ex.getMessage(), ex);
}
}
}
public synchronized void refreshCache() throws CachingException {
clearCache();
loadCache();
}
public static synchronized Map getAssetMap() {
if (assetMap == null) {
assetMap = Collections.synchronizedMap(new TreeMap());
}
return assetMap;
}
public static Asset getAsset(Long id) {
return getAsset(new AssetKey(id));
}
public static Asset getAsset(String name) {
return getAsset(new AssetKey(name));
}
public static Asset getAsset(String name, String language) {
return getAsset(new AssetKey(name, language));
}
public static Asset getAsset(String name, String[] languages) {
for (String language : languages) {
Asset asset = getAsset(new AssetKey(name, language));
if (asset != null)
return asset;
}
return null; // not found
}
public static Asset getAsset(String name, String language, int version) {
return getAsset(new AssetKey(name, language, version));
}
/**
* Either a specific version number can be specified, or a Smart Version can be specified which designates an allowable range.
*/
public static Asset getAsset(AssetVersionSpec spec) {
Asset match = null, assetVO = null;
try {
// Get asset from package based on asset version spec
if (spec.getPackageName() != null) {
// get all the versions of packages based on package name
List allPackgeVOs = PackageCache.getAllPackages(spec.getPackageName());
for (Package pkgVO : allPackgeVOs) {
for (Asset asset : pkgVO.getAssets()) {
if (spec.getName().equals(asset.getName())) {
if (asset.meetsVersionSpec(spec.getVersion()) && (match == null || asset.getVersion() > match.getVersion()))
match = asset;
}
}
}
if (match != null) {
if (!match.isLoaded())
assetVO = DataAccess.getProcessLoader().getAsset(match.getId());
else
assetVO = match;
}
else if (!spec.getVersion().equals("0")) { // check ASSET_REF DB table to retrieve from git history
AssetRef ref = AssetRefCache.getAssetRef(spec);
if (ref != null)
assetVO = AssetRefConverter.getAsset(ref);
}
return assetVO;
}
for (Asset asset : getAllAssets()) {
if (spec.getName().equals(asset.getName())) {
if (asset.meetsVersionSpec(spec.getVersion()) && (match == null || asset.getVersion() > match.getVersion()))
match = asset;
}
}
if (match != null && !match.isLoaded()) {
assetVO = DataAccess.getProcessLoader().getAsset(match.getId());
}
// If match == null, check ASSET_REF DB table to retrieve from git history
if (match == null && !spec.getVersion().equals("0")) {
AssetRef ref = AssetRefCache.getAssetRef(spec);
if (ref != null)
assetVO = AssetRefConverter.getAsset(ref);
}
} catch (Exception ex) {
logger.severeException("Failed to load asset: "+spec.toString()+ " : "+ex.getMessage(), ex);
}
return assetVO;
}
/**
* Get the asset based on version spec whose name and custom attributes match the parameters.
*/
public static Asset getAsset(AssetVersionSpec spec, Map attributeValues) {
Asset match = null;
try {
for (Asset asset : getAllAssets()) {
if (spec.getName().equals(asset.getName())) {
if (asset.meetsVersionSpec(spec.getVersion()) && (match == null || asset.getVersion() > match.getVersion())) {
boolean attrsMatch = true;
for (String attrName : attributeValues.keySet()) {
String attrValue = attributeValues.get(attrName);
String rsValue = asset.getAttribute(attrName);
if (rsValue == null || !rsValue.equals(attrValue)) {
attrsMatch = false;
break;
}
}
if (attrsMatch && (match == null || match.getVersion() < asset.getVersion())) {
if (!asset.isLoaded()) {
Asset loaded = getAsset(asset.getId());
asset.setStringContent(loaded.getStringContent());
}
match = asset;
}
}
}
}
// TODO If match == null, check ASSET_REF DB table to retrieve from git history - For when Asset attributes are implemented
} catch (DataAccessException ex) {
logger.severeException("Failed to load asset: "+spec.toString()+ " : "+ex.getMessage(), ex);
}
return match;
}
/**
* Asset names like 'myPackage/myAsset.ext' designate package-specific versions.
* (or myPackage.MyCustomJavaClass for dynamic Java or Script).
*/
public static Asset getAsset(AssetKey key) {
int delimIdx = getDelimIndex(key);
if (delimIdx > 0) {
// look in package rule sets
String pkgName = key.getName().substring(0, delimIdx);
String assetName = key.getName().substring(delimIdx + 1);
try {
Package pkgVO = PackageCache.getPackage(pkgName);
if (pkgVO != null) {
for (Asset asset : pkgVO.getAssets()) {
if (asset.getName().equals(assetName))
return getAsset(new AssetKey(asset.getId()));
if (Asset.JAVA.equals(key.getLanguage()) && asset.getName().equals(assetName + ".java"))
return getAsset(new AssetKey(asset.getId()));
if (Asset.GROOVY.equals(key.getLanguage()) && asset.getName().equals(assetName + ".groovy"))
return getAsset(new AssetKey(asset.getId()));
}
}
}
catch (CachingException ex) {
logger.severeException(ex.getMessage(), ex);
}
// try to load (for archived compatibility case)
Asset asset = loadAsset(key);
if (asset != null) {
getAssetMap();
synchronized(assetMap) {
assetMap.put(new AssetKey(asset), asset);
}
return asset;
}
return null; // not found
}
getAssetMap();
synchronized(assetMap) {
for (AssetKey mapKey : assetMap.keySet()) {
if (key.equals(mapKey))
return assetMap.get(mapKey);
}
}
Asset asset = null;
asset = loadAsset(key);
if (asset != null) {
synchronized(assetMap) {
assetMap.put(new AssetKey(asset), asset);
}
}
return asset;
}
private static int getDelimIndex(AssetKey key) {
int delimIdx = -1;
String name = key.getName();
if (name != null) {
if (Asset.JAVA.equals(key.getLanguage())) {
delimIdx = name.endsWith(".java") ? name.substring(0, name.length() - 6).lastIndexOf('.') : name.lastIndexOf('.');
}
else if (Asset.GROOVY.equals(key.getLanguage())) {
delimIdx = name.endsWith(".groovy") ? name.substring(0, 8).lastIndexOf('.') : name.lastIndexOf('.');
}
else {
delimIdx = key.getName().indexOf('/');
}
}
return delimIdx;
}
public static List getAssets(String language) {
List assets = new ArrayList();
try {
for (Asset asset : getLatestAssets()) {
if (asset.getLanguage() != null && asset.getLanguage().equals(language)) {
Asset fullAsset = getAsset(asset.getId());
assets.add(fullAsset);
}
}
}
catch (Exception ex) {
logger.severeException(ex.getMessage(), ex);
}
return assets;
}
public static synchronized List getLatestAssets() throws DataAccessException, CachingException {
if (latestAssets == null) {
latestAssets = new ArrayList();
for (Asset asset : getAllAssets()) {
Package assetPkg = PackageCache.getAssetPackage(asset.getId());
// relies on getAllAssets() being ordered by version descending
boolean already = false;
for (Asset rs : latestAssets) {
Package rsPkg = PackageCache.getAssetPackage(rs.getId());
if (rs.getName().equals(asset.getName())) {
// potential match
boolean languageMatch = false;
if (rs.getLanguage() == null)
languageMatch = asset.getLanguage() == null;
else
languageMatch = rs.getLanguage().equals(asset.getLanguage());
boolean packageMatch = false;
if (rsPkg == null)
packageMatch = assetPkg == null;
else if (assetPkg == null)
packageMatch = true; // earlier version in default package should be ignored
else
packageMatch = rsPkg.getName().equals(assetPkg.getName());
if (languageMatch && packageMatch) {
already = true;
break;
}
}
}
if (!already)
latestAssets.add(asset);
}
}
return latestAssets;
}
/**
* Get the latest asset whose name and custom attributes match the parameters.
* Asset names like 'my.pkg/myAsset.ext' designate package-specific versions;
* however, package is ignored when selecting by custom attributes.
*/
public static Asset getLatestAssets(String name, String language, Map attributeValues) {
String assetName = name;
if (name.indexOf('/') > 0)
assetName = name.substring(name.indexOf('/') + 1);
Asset asset = null;
try {
for (Asset potentialMatch : getAllAssets()) {
if (potentialMatch.getName().equals(assetName) && potentialMatch.getLanguage().equals(language)) {
boolean attrsMatch = true;
for (String attrName : attributeValues.keySet()) {
String attrValue = attributeValues.get(attrName);
String rsValue = potentialMatch.getAttribute(attrName);
if (rsValue == null || !rsValue.equals(attrValue)) {
attrsMatch = false;
break;
}
}
if (attrsMatch && (asset == null || asset.getVersion() < potentialMatch.getVersion())) {
if (!potentialMatch.isLoaded()) {
Asset loaded = getAsset(potentialMatch.getId());
potentialMatch.setStringContent(loaded.getStringContent());
}
asset = potentialMatch;
}
}
}
}
catch (DataAccessException ex) {
logger.severeException(ex.getMessage(), ex);
}
return asset;
}
public static Set getRuleNames(String ruleNameRegex) {
Set matchedRuleNames = new HashSet();
try {
for(Asset asset : getAllAssets()){
if(asset.getName().matches(ruleNameRegex)){
matchedRuleNames.add(asset.getName());
}
}
}
catch (DataAccessException ex) {
logger.severeException(ex.getMessage(), ex);
}
return matchedRuleNames;
}
private static Asset loadAsset(AssetKey key) {
try {
for (Asset asset : getAllAssets()) {
if (key.equals(new AssetKey(asset))) {
return DataAccess.getProcessLoader().getAsset(asset.getId());
}
}
// If didn't find it, check ASSET_REF DB table to retrieve from git history
AssetRef ref = null;
if (key.getId() != null && key.getId() > 0L) // We have a specific ID we are looking for
ref = AssetRefCache.getAssetRef(key.getId());
else if (key.getVersion() > 0) { // We have a full name (pkg + asset) and specific version we are looking for
int delimIdx = getDelimIndex(key);
if (delimIdx > 0) {
String pkgName = key.getName().substring(0, delimIdx);
String assetName = key.getName().substring(delimIdx + 1);
String version = Asset.formatVersion(key.getVersion());
ref = AssetRefCache.getAssetRef(pkgName + "/" + assetName + " v" + version);
}
}
if (ref != null)
return AssetRefConverter.getAsset(ref);
return null;
}
catch (Exception ex) {
logger.severeException(ex.getMessage(), ex);
return null;
}
}
public static synchronized List getAllAssets() throws DataAccessException {
if (allAssets == null) {
allAssets = DataAccess.getProcessLoader().getAssets();
try {
for (Asset asset : allAssets) {
Package pkg = PackageCache.getAssetPackage(asset.getId());
if (pkg != null)
asset.setPackageName(pkg.getName());
}
}
catch (CachingException ex) {
throw new DataAccessException(ex.getMessage(), ex);
}
}
return allAssets;
}
// This is used by CloudClassLoader to search all JAR file assets
public static synchronized List getJarAssets() {
if (jarAssets == null) {
jarAssets = getAssets(Asset.JAR);
}
return jarAssets;
}
}
class AssetKey implements Comparable {
private Long id;
public Long getId() { return id; }
public void setId(Long id) { this.id = id; }
private String name;
public String getName() { return name; }
public void setName(String name) { this.name = name; }
private String language;
public String getLanguage() { return language; }
public void setLanguage(String language) { this.language = language; }
private int version;
public int getVersion() { return version; }
public void setVersion(int version) { this.version = version; }
public AssetKey(Long id) {
this.id = id;
}
public AssetKey(String name, String language, int version) {
this.name = name;
this.language = language;
this.version = version;
}
public AssetKey(String name, String language) {
this.name = name;
this.language = language;
}
public AssetKey(String name) {
this.name = name;
}
public AssetKey(Asset asset) {
this.id = asset.getId();
this.name = asset.getName();
this.language = asset.getLanguage();
this.version = asset.getVersion();
}
public boolean equals(Object other) {
AssetKey otherKey = (AssetKey) other;
if (id != null && otherKey!=null)
return id.equals(otherKey.getId()); // if id is specified, base equality only on that
return compareTo(otherKey) == 0;
}
public int compareTo(AssetKey otherKey) {
if (id != null && otherKey!=null)
return -id.compareTo(otherKey.getId()); // id is specified so compare based on that (reverse order)
if (name == null && otherKey.getName() != null)
return -1;
if (otherKey.getName() == null && name != null)
return 1;
if ((name!=null) && (!name.equals(otherKey.getName())))
return name.compareTo(otherKey.getName());
if (otherKey.getLanguage() == null)
otherKey.setLanguage(language); // language not specified
if (language == null && otherKey.getLanguage() != null)
return -1;
if (otherKey.getLanguage() == null && language != null)
return 1;
if ((language != null) &&(!language.equals(otherKey.getLanguage())))
return language.compareTo(otherKey.getLanguage());
if (version == 0 && (id == null || name == null))
return 0; // search for latest version
if (otherKey.getVersion() == 0 && (otherKey.getId() == null || otherKey.getName() == null))
return 0; // search for latest version
// name and language are the same, sort by version descending
return otherKey.getVersion() - version;
}
public String toString() {
return "id: '" + id + "' name: '" + name + "' language: '" + language + "' version: " + version;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy