ch.qos.logback.tyler.base.handler.ImplicitModelHandler Maven / Gradle / Ivy
/*
* Copyright (c) 2024 QOS.ch Sarl (Switzerland)
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*
*
*/
package ch.qos.logback.tyler.base.handler;
import ch.qos.logback.core.Context;
import ch.qos.logback.core.joran.spi.NoAutoStartUtil;
import ch.qos.logback.core.joran.util.AggregationAssessor;
import ch.qos.logback.core.joran.util.beans.BeanDescriptionCache;
import ch.qos.logback.core.model.ImplicitModel;
import ch.qos.logback.core.model.Model;
import ch.qos.logback.core.model.ModelConstants;
import ch.qos.logback.core.model.processor.ModelHandlerBase;
import ch.qos.logback.core.model.processor.ModelHandlerException;
import ch.qos.logback.core.model.processor.ModelInterpretationContext;
import ch.qos.logback.core.spi.ContextAware;
import ch.qos.logback.core.spi.LifeCycle;
import ch.qos.logback.core.util.AggregationType;
import ch.qos.logback.core.util.Loader;
import ch.qos.logback.core.util.OptionHelper;
import ch.qos.logback.core.util.StringUtil;
import ch.qos.logback.tyler.base.TylerModelInterpretationContext;
import ch.qos.logback.tyler.base.util.StringToVariableStament;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.MethodSpec;
import java.lang.reflect.Method;
public class ImplicitModelHandler extends ModelHandlerBase {
boolean inError = false;
private final BeanDescriptionCache beanDescriptionCache;
ImplicitModelHandlerData implicitModelHandlerData;
AggregationAssessor aggregationAssessor;
static public final String IGNORING_UNKNOWN_PROP = "Ignoring unknown property";
public ImplicitModelHandler(Context context, BeanDescriptionCache beanDescriptionCache) {
super(context);
this.beanDescriptionCache = beanDescriptionCache;
}
static public ImplicitModelHandler makeInstance(Context context, ModelInterpretationContext mic) {
BeanDescriptionCache beanDescriptionCache = mic.getBeanDescriptionCache();
return new ImplicitModelHandler(context, beanDescriptionCache);
}
protected Class getSupportedModelClass() {
return ImplicitModel.class;
}
@Override
public void handle(ModelInterpretationContext mic, Model model) throws ModelHandlerException {
ImplicitModel implicitModel = (ImplicitModel) model;
TylerModelInterpretationContext tmic = (TylerModelInterpretationContext) mic;
// calling intercon.peekObject with an empty stack will throw an exception
if (mic.isObjectStackEmpty()) {
inError = true;
return;
}
String nestedElementTagName = implicitModel.getTag();
Object o = mic.peekObject();
if (o == null) {
addError("Null object at the top of the stack");
inError = true;
return;
}
if (!(o instanceof ImplicitModelHandlerData)) {
addError("Was expecting class of type " + ImplicitModelHandlerData.class.getName() + " but found"
+ o.getClass().getName());
inError = true;
return;
}
ImplicitModelHandlerData tylerImplicitData = (ImplicitModelHandlerData) o;
this.aggregationAssessor = new AggregationAssessor(beanDescriptionCache, tylerImplicitData.getParentObjectClass());
aggregationAssessor.setContext(context);
AggregationType aggregationType = aggregationAssessor.computeAggregationType(nestedElementTagName);
switch (aggregationType) {
case NOT_FOUND:
addWarn(IGNORING_UNKNOWN_PROP + " [" + nestedElementTagName + "] in [" + o.getClass().getName() + "]");
inError = true;
// no point in processing submodels
implicitModel.markAsSkipped();
return;
case AS_BASIC_PROPERTY:
case AS_BASIC_PROPERTY_COLLECTION:
doBasicProperty(mic, implicitModel, aggregationAssessor, tylerImplicitData, aggregationType);
return;
// we only push action data if NestComponentIA is applicable
case AS_COMPLEX_PROPERTY_COLLECTION:
case AS_COMPLEX_PROPERTY:
doComplex(tmic, implicitModel, aggregationAssessor, tylerImplicitData, aggregationType);
return;
default:
addError("PropertySetter.computeAggregationType returned " + aggregationType);
inError = true;
return;
}
}
private void doComplex(TylerModelInterpretationContext tmic, ImplicitModel implicitModel,
AggregationAssessor aggregationAssessor, ImplicitModelHandlerData classAndMethodSpecTuple,
AggregationType aggregationType) {
String className = implicitModel.getClassName();
String fqcn = tmic.getImport(className);
String nestedElementTagName = implicitModel.getTag();
Class componentClass = null;
try {
if (!OptionHelper.isNullOrEmptyOrAllSpaces(fqcn)) {
componentClass = Loader.loadClass(fqcn, context);
} else {
// guess class name via implicit rules
componentClass = aggregationAssessor.getClassNameViaImplicitRules(nestedElementTagName, aggregationType,
tmic.getDefaultNestedComponentRegistry());
}
if (componentClass == null) {
inError = true;
String errMsg = "Could not find an appropriate class for property [" + nestedElementTagName + "]";
addError(errMsg);
return;
}
if (OptionHelper.isNullOrEmptyOrAllSpaces(fqcn)) {
addInfo("Assuming default type [" + componentClass.getName() + "] for [" + nestedElementTagName
+ "] property");
}
this.implicitModelHandlerData = addJavaStatementForComplexProperty(tmic, implicitModel,
classAndMethodSpecTuple, componentClass);
tmic.pushObject(implicitModelHandlerData);
} catch (Exception oops) {
inError = true;
String msg = "Could not create component [" + implicitModel.getTag() + "] of type [" + fqcn + "]";
addError(msg, oops);
}
}
private ImplicitModelHandlerData addJavaStatementForComplexProperty(TylerModelInterpretationContext tmic,
ImplicitModel implicitModel, ImplicitModelHandlerData implicitModelHandlerData, Class componentClass) {
MethodSpec.Builder methodSpecBuilder = implicitModelHandlerData.methodSpecBuilder;
String parentVariableName = implicitModelHandlerData.getVariableName();
String variableName = StringUtil.lowercaseFirstLetter(componentClass.getSimpleName());
ClassName componentCN = ClassName.get(componentClass.getPackageName(), componentClass.getSimpleName());
methodSpecBuilder.addCode("\n");
methodSpecBuilder.addComment("Configure component of type $T", componentCN);
methodSpecBuilder.addStatement("$1T $2N = new $1T()", componentCN, variableName);
methodSpecBuilder.beginControlFlow("if ($N instanceof $T)", variableName, ContextAware.class);
methodSpecBuilder.addStatement("$N.setContext($N)", variableName, tmic.getContextFieldSpec());
methodSpecBuilder.endControlFlow();
ImplicitModelHandlerData cvnmsbt = new ImplicitModelHandlerData(parentVariableName, componentClass,
variableName, methodSpecBuilder);
return cvnmsbt;
}
private void doBasicProperty(ModelInterpretationContext mic, ImplicitModel implicitModel,
AggregationAssessor aggregationAssessor, ImplicitModelHandlerData classAndMethodSpecTuple,
AggregationType aggregationType) {
String finalBody = mic.subst(implicitModel.getBodyText());
String nestedElementTagName = implicitModel.getTag();
switch (aggregationType) {
case AS_BASIC_PROPERTY:
Method setterMethod = aggregationAssessor.findSetterMethod(nestedElementTagName);
Class[] paramTypes = setterMethod.getParameterTypes();
setPropertyJavaStatement(classAndMethodSpecTuple, setterMethod, finalBody, paramTypes[0]);
break;
case AS_BASIC_PROPERTY_COLLECTION:
//actionData.parentBean.addBasicProperty(actionData.propertyName, finalBody);
break;
default:
addError("Unexpected aggregationType " + aggregationType);
}
}
private void setPropertyJavaStatement(ImplicitModelHandlerData classAndMethodSpecTuple, Method setterMethod,
String value, Class type) {
MethodSpec.Builder methodSpecBuilder = classAndMethodSpecTuple.methodSpecBuilder;
String variableName = classAndMethodSpecTuple.getVariableName();
//String setterSuffix = StringUtil.capitalizeFirstLetter(nestedElementTagName);
String valuePart = StringToVariableStament.convertArg(type);
methodSpecBuilder.addStatement("$N.$N(" + valuePart + ")", variableName, setterMethod.getName(),
value.toLowerCase());
}
@Override
public void postHandle(ModelInterpretationContext mic, Model model) {
if (inError) {
return;
}
if (implicitModelHandlerData != null) {
postHandleComplex(mic, model);
}
}
private void postHandleComplex(ModelInterpretationContext mic, Model model) {
Object o = mic.peekObject();
if (o != implicitModelHandlerData) {
addError("The object on the top the of the stack is not the " + ImplicitModelHandlerData.class
+ " instance pushed earlier.");
} else {
mic.popObject();
ImplicitModel implicitModel = (ImplicitModel) model;
MethodSpec.Builder methodSpecBuilder = implicitModelHandlerData.methodSpecBuilder;
String parentVariableName = implicitModelHandlerData.getParentVariableName();
String variableName = implicitModelHandlerData.getVariableName();
Class objClass = implicitModelHandlerData.getParentObjectClass();
Method setterMethod = aggregationAssessor.findSetterMethod(implicitModel.getTag());
AggregationAssessor nestedAggregationAssessor = new AggregationAssessor(beanDescriptionCache, setterMethod.getParameterTypes()[0]);
nestedAggregationAssessor.setContext(context);
Method parentSetterMethod = nestedAggregationAssessor.findSetterMethod(ModelConstants.PARENT_PROPPERTY_KEY);
if(parentSetterMethod != null) {
methodSpecBuilder.addStatement("$N.$N($N)", variableName, parentSetterMethod.getName(),parentVariableName);
} else {
methodSpecBuilder.addComment("===========no parent setter");
}
methodSpecBuilder.addComment("start the complex property if it implements LifeCycle and is not");
methodSpecBuilder.addComment("marked with a @NoAutoStart annotation");
methodSpecBuilder.beginControlFlow("if(($1N instanceof $2T) && $3T.notMarkedWithNoAutoStart($1N))", variableName, LifeCycle.class,
NoAutoStartUtil.class);
methodSpecBuilder.addStatement("(($T) $N).start()", LifeCycle.class, variableName);
methodSpecBuilder.endControlFlow();
methodSpecBuilder.addComment("Inject component of type $T into parent", objClass);
methodSpecBuilder.addStatement("$N.$N($N)", parentVariableName, setterMethod.getName(), variableName);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy