All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.aspectran.core.component.translet.TransletRuleRegistry Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2023 The Aspectran Project
*
* 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.aspectran.core.component.translet;
import com.aspectran.core.adapter.ApplicationAdapter;
import com.aspectran.core.component.AbstractComponent;
import com.aspectran.core.component.translet.scan.TransletScanFilter;
import com.aspectran.core.component.translet.scan.TransletScanner;
import com.aspectran.core.context.ActivityContext;
import com.aspectran.core.context.expr.token.Token;
import com.aspectran.core.context.expr.token.Tokenizer;
import com.aspectran.core.context.rule.IllegalRuleException;
import com.aspectran.core.context.rule.RequestRule;
import com.aspectran.core.context.rule.ResponseRule;
import com.aspectran.core.context.rule.TransletRule;
import com.aspectran.core.context.rule.assistant.AssistantLocal;
import com.aspectran.core.context.rule.assistant.DefaultSettings;
import com.aspectran.core.context.rule.params.FilterParameters;
import com.aspectran.core.context.rule.type.MethodType;
import com.aspectran.core.context.rule.type.TokenType;
import com.aspectran.core.util.ClassUtils;
import com.aspectran.core.util.PrefixSuffixPattern;
import com.aspectran.core.util.StringUtils;
import com.aspectran.core.util.logging.Logger;
import com.aspectran.core.util.logging.LoggerFactory;
import com.aspectran.core.util.wildcard.WildcardPattern;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
/**
* The Class TransletRuleRegistry.
*/
public class TransletRuleRegistry extends AbstractComponent {
private static final Logger logger = LoggerFactory.getLogger(TransletRuleRegistry.class);
private final Map transletRuleMap = new LinkedHashMap<>();
private final Map getTransletRuleMap = new HashMap<>();
private final Map postTransletRuleMap = new HashMap<>();
private final Map putTransletRuleMap = new HashMap<>();
private final Map patchTransletRuleMap = new HashMap<>();
private final Map deleteTransletRuleMap = new HashMap<>();
private final Comparator comparator = new WeightComparator();
private final Set wildGetTransletRuleSet = new TreeSet<>(comparator);
private final Set wildPostTransletRuleSet = new TreeSet<>(comparator);
private final Set wildPutTransletRuleSet = new TreeSet<>(comparator);
private final Set wildPatchTransletRuleSet = new TreeSet<>(comparator);
private final Set wildDeleteTransletRuleSet = new TreeSet<>(comparator);
private final Set etcTransletRuleSet = new TreeSet<>(comparator);
private final String basePath;
private final ClassLoader classLoader;
private AssistantLocal assistantLocal;
public TransletRuleRegistry(ApplicationAdapter applicationAdapter) {
this.basePath = applicationAdapter.getBasePath();
this.classLoader = applicationAdapter.getClassLoader();
}
public void setAssistantLocal(AssistantLocal assistantLocal) {
this.assistantLocal = assistantLocal;
}
public Collection getTransletRules() {
return transletRuleMap.values();
}
public TransletRule getTransletRule(String transletName) {
return getTransletRule(transletName, MethodType.GET);
}
public TransletRule getTransletRule(String transletName, MethodType requestMethod) {
if (transletName == null) {
throw new IllegalArgumentException("transletName must not be null");
}
if (requestMethod == null) {
throw new IllegalArgumentException("requestMethod must not be null");
}
TransletRule transletRule;
switch (requestMethod) {
case GET:
transletRule = getTransletRuleMap.get(transletName);
if (transletRule == null) {
transletRule = retrieveWildTransletRule(wildGetTransletRuleSet, transletName);
}
break;
case POST:
transletRule = postTransletRuleMap.get(transletName);
if (transletRule == null) {
transletRule = retrieveWildTransletRule(wildPostTransletRuleSet, transletName);
}
break;
case PUT:
transletRule = putTransletRuleMap.get(transletName);
if (transletRule == null) {
transletRule = retrieveWildTransletRule(wildPutTransletRuleSet, transletName);
}
break;
case PATCH:
transletRule = patchTransletRuleMap.get(transletName);
if (transletRule == null) {
transletRule = retrieveWildTransletRule(wildPatchTransletRuleSet, transletName);
}
break;
case DELETE:
transletRule = deleteTransletRuleMap.get(transletName);
if (transletRule == null) {
transletRule = retrieveWildTransletRule(wildDeleteTransletRuleSet, transletName);
}
break;
default:
transletRule = retrieveEtcTransletRule(transletName, requestMethod);
}
if (transletRule == null && requestMethod != MethodType.GET) {
transletRule = transletRuleMap.get(transletName);
if (transletRule == null) {
transletRule = retrieveWildTransletRule(wildGetTransletRuleSet, transletName);
}
}
return transletRule;
}
private TransletRule retrieveWildTransletRule(Set transletRuleSet, String transletName) {
if (!transletRuleSet.isEmpty()) {
for (TransletRule transletRule : transletRuleSet) {
WildcardPattern namePattern = transletRule.getNamePattern();
if (namePattern != null) {
if (namePattern.matches(transletName)) {
return transletRule;
}
} else {
if (transletName.equals(transletRule.getName())) {
return transletRule;
}
}
}
}
return null;
}
private TransletRule retrieveEtcTransletRule(String transletName, MethodType requestMethod) {
if (!etcTransletRuleSet.isEmpty()) {
for (TransletRule transletRule : etcTransletRuleSet) {
if (requestMethod.containsTo(transletRule.getAllowedMethods())) {
WildcardPattern namePattern = transletRule.getNamePattern();
if (namePattern != null) {
if (namePattern.matches(transletName)) {
return transletRule;
}
} else {
if (transletName.equals(transletRule.getName())) {
return transletRule;
}
}
}
}
}
return null;
}
public boolean contains(String transletName) {
return contains(transletName, MethodType.GET);
}
public boolean contains(String transletName, MethodType requestMethod) {
return (getTransletRule(transletName, requestMethod) != null);
}
public void addTransletRule(TransletRule transletRule) throws IllegalRuleException {
if (transletRule == null) {
throw new IllegalArgumentException("transletRule must not be null");
}
String scanPath = transletRule.getScanPath();
if (scanPath != null) {
TransletScanner scanner = createTransletScanner(transletRule);
PrefixSuffixPattern prefixSuffixPattern = new PrefixSuffixPattern(transletRule.getName());
scanner.scan(scanPath, (filePath, scannedFile) -> {
TransletRule newTransletRule = TransletRule.replicate(transletRule, filePath);
if (prefixSuffixPattern.isSplitted()) {
newTransletRule.setName(prefixSuffixPattern.join(filePath));
} else if (transletRule.getName() != null) {
newTransletRule.setName(transletRule.getName() + filePath);
}
dissectTransletRule(newTransletRule);
});
} else {
dissectTransletRule(transletRule);
}
}
private TransletScanner createTransletScanner(TransletRule transletRule) throws IllegalRuleException {
TransletScanner scanner = new TransletScanner(basePath);
if (transletRule.getFilterParameters() != null) {
FilterParameters filterParameters = transletRule.getFilterParameters();
String transletScanFilterClassName = filterParameters.getString(FilterParameters.filterClass);
if (transletScanFilterClassName != null) {
TransletScanFilter transletScanFilter;
try {
Class filterClass = classLoader.loadClass(transletScanFilterClassName);
transletScanFilter = (TransletScanFilter)ClassUtils.createInstance(filterClass);
} catch (Exception e) {
throw new IllegalRuleException("Failed to instantiate TransletScanFilter [" +
transletScanFilterClassName + "]", e);
}
scanner.setTransletScanFilter(transletScanFilter);
}
String[] excludePatterns = filterParameters.getStringArray(FilterParameters.exclude);
if (excludePatterns != null) {
scanner.setExcludePatterns(excludePatterns);
}
}
if (transletRule.getMaskPattern() != null) {
scanner.setTransletNameMaskPattern(transletRule.getMaskPattern());
} else {
scanner.setTransletNameMaskPattern(transletRule.getScanPath());
}
return scanner;
}
private void dissectTransletRule(TransletRule transletRule) {
if (transletRule.getRequestRule() == null) {
RequestRule requestRule = new RequestRule(false);
transletRule.setRequestRule(requestRule);
}
List responseRuleList = transletRule.getResponseRuleList();
if (responseRuleList == null || responseRuleList.isEmpty()) {
saveTransletRule(transletRule);
} else if (responseRuleList.size() == 1) {
transletRule.setResponseRule(responseRuleList.get(0));
saveTransletRule(transletRule);
} else {
// Grouped translets
ResponseRule defaultResponseRule = null;
for (ResponseRule responseRule : responseRuleList) {
String responseName = responseRule.getName();
if (responseName == null || responseName.isEmpty()) {
if (defaultResponseRule != null) {
logger.warn("Ignore duplicated default response rule " + defaultResponseRule +
" of transletRule " + transletRule);
}
defaultResponseRule = responseRule;
} else {
TransletRule subTransletRule = transletRule.replicate();
subTransletRule.setResponseRule(responseRule);
saveTransletRule(subTransletRule);
}
}
if (defaultResponseRule != null) {
transletRule.setResponseRule(defaultResponseRule);
saveTransletRule(transletRule);
}
}
}
private void saveTransletRule(TransletRule transletRule) {
transletRule.determineResponseRule();
String transletName = applyTransletNamePattern(transletRule.getName());
transletRule.setName(transletName);
MethodType[] allowedMethods = transletRule.getAllowedMethods();
if (hasPathVariables(transletName)) {
savePathVariables(transletRule);
if (allowedMethods != null) {
String restfulTransletName = assembleTransletName(transletName, allowedMethods);
transletRuleMap.put(restfulTransletName, transletRule);
for (MethodType methodType : allowedMethods) {
switch (methodType) {
case GET:
wildGetTransletRuleSet.add(transletRule);
break;
case POST:
wildPostTransletRuleSet.add(transletRule);
break;
case PUT:
wildPutTransletRuleSet.add(transletRule);
break;
case PATCH:
wildPatchTransletRuleSet.add(transletRule);
break;
case DELETE:
wildDeleteTransletRuleSet.add(transletRule);
break;
default:
etcTransletRuleSet.add(transletRule);
}
}
} else {
transletRuleMap.put(transletName, transletRule);
wildGetTransletRuleSet.add(transletRule);
}
} else {
if (WildcardPattern.hasWildcards(transletRule.getName())) {
WildcardPattern namePattern = WildcardPattern.compile(transletRule.getName(),
ActivityContext.NAME_SEPARATOR_CHAR);
transletRule.setNamePattern(namePattern);
}
if (allowedMethods != null) {
String restfulTransletName = assembleTransletName(transletName, allowedMethods);
transletRuleMap.put(restfulTransletName, transletRule);
for (MethodType methodType : allowedMethods) {
switch (methodType) {
case GET:
getTransletRuleMap.put(transletName, transletRule);
break;
case POST:
postTransletRuleMap.put(transletName, transletRule);
break;
case PUT:
putTransletRuleMap.put(transletName, transletRule);
break;
case PATCH:
patchTransletRuleMap.put(transletName, transletRule);
break;
case DELETE:
deleteTransletRuleMap.put(transletName, transletRule);
break;
default:
etcTransletRuleSet.add(transletRule);
}
}
} else {
transletRuleMap.put(transletName, transletRule);
getTransletRuleMap.put(transletName, transletRule);
}
}
if (logger.isTraceEnabled()) {
logger.trace("add TransletRule " + transletRule);
}
}
private void savePathVariables(TransletRule transletRule) {
final String transletName = transletRule.getName();
List tokenList = Tokenizer.tokenize(transletName, false);
Token[] nameTokens = tokenList.toArray(new Token[0]);
StringBuilder sb = new StringBuilder(transletName.length());
for (Token token : nameTokens) {
if (token.getType() == TokenType.PARAMETER || token.getType() == TokenType.ATTRIBUTE) {
sb.append(WildcardPattern.STAR_CHAR);
} else {
String tokenString = token.stringify();
sb.append(tokenString);
}
}
String wildTransletName = sb.toString();
if (WildcardPattern.hasWildcards(wildTransletName)) {
WildcardPattern namePattern = WildcardPattern.compile(wildTransletName,
ActivityContext.NAME_SEPARATOR_CHAR);
transletRule.setNamePattern(namePattern);
transletRule.setNameTokens(nameTokens);
}
}
private boolean hasPathVariables(String transletName) {
return ((transletName.contains("${") || transletName.contains("@{")) && transletName.contains("}"));
}
private String assembleTransletName(String transletName, MethodType[] allowedMethods) {
if (allowedMethods != null) {
if (allowedMethods.length > 1) {
int len = transletName.length() + (allowedMethods.length * 8);
StringBuilder sb = new StringBuilder(len);
for (MethodType type : allowedMethods) {
sb.append(type).append(" ");
}
sb.append(transletName);
return sb.toString();
} else if (allowedMethods.length == 1) {
return assembleRestfulTransletName(transletName, allowedMethods[0]);
}
}
return assembleRestfulTransletName(transletName, MethodType.GET);
}
private String assembleRestfulTransletName(String transletName, MethodType requestMethod) {
return (requestMethod + " " + transletName);
}
/**
* Returns the translet name of the prefix and suffix are combined.
*
* @param transletName the translet name
* @return the new translet name
*/
public String applyTransletNamePattern(String transletName) {
return applyTransletNamePattern(transletName, false);
}
/**
* Returns the translet name of the prefix and suffix are combined.
*
* @param transletName the translet name
* @param absolutely whether to allow absolutely name for translet
* @return the new translet name
*/
public String applyTransletNamePattern(String transletName, boolean absolutely) {
DefaultSettings defaultSettings = assistantLocal.getDefaultSettings();
if (defaultSettings == null) {
return transletName;
}
if (defaultSettings.getTransletNamePrefix() == null
&& defaultSettings.getTransletNameSuffix() == null) {
return transletName;
}
if (StringUtils.startsWith(transletName, ActivityContext.NAME_SEPARATOR_CHAR)) {
if (absolutely) {
return transletName;
}
transletName = transletName.substring(1);
}
StringBuilder sb = new StringBuilder();
if (defaultSettings.getTransletNamePrefix() != null) {
sb.append(defaultSettings.getTransletNamePrefix());
}
if (transletName != null) {
sb.append(transletName);
}
if (defaultSettings.getTransletNameSuffix() != null) {
sb.append(defaultSettings.getTransletNameSuffix());
}
return sb.toString();
}
@Override
protected void doInitialize() {
// Nothing to do
}
@Override
protected void doDestroy() {
transletRuleMap.clear();
getTransletRuleMap.clear();
postTransletRuleMap.clear();
putTransletRuleMap.clear();
patchTransletRuleMap.clear();
deleteTransletRuleMap.clear();
wildGetTransletRuleSet.clear();
wildPostTransletRuleSet.clear();
wildPutTransletRuleSet.clear();
wildPatchTransletRuleSet.clear();
wildDeleteTransletRuleSet.clear();
etcTransletRuleSet.clear();
}
static class WeightComparator implements Comparator {
@Override
public int compare(TransletRule tr1, TransletRule tr2) {
if (tr1.getNamePattern() != null && tr2.getNamePattern() != null) {
float weight1 = tr1.getNamePattern().getWeight();
float weight2 = tr2.getNamePattern().getWeight();
int cmp = Float.compare(weight2, weight1);
if (cmp == 0) {
cmp = tr1.getNamePattern().toString().compareTo(tr2.getNamePattern().toString());
}
return cmp;
} else if (tr1.getNamePattern() != null) {
return tr2.getName().compareTo(tr1.getNamePattern().toString());
} else if (tr2.getNamePattern() != null) {
return tr1.getName().compareTo(tr2.getNamePattern().toString());
} else {
return tr2.getName().compareTo(tr1.getName());
}
}
}
}
