001/*
002 * Logback: the reliable, generic, fast and flexible logging framework.
003 * Copyright (C) 1999-2026, QOS.ch. All rights reserved.
004 *
005 * This program and the accompanying materials are dual-licensed under
006 * either the terms of the Eclipse Public License v2.0 as published by
007 * the Eclipse Foundation
008 *
009 *   or (per the licensee's choosing)
010 *
011 * under the terms of the GNU Lesser General Public License version 2.1
012 * as published by the Free Software Foundation.
013 */
014
015package ch.qos.logback.core.model.processor;
016
017import ch.qos.logback.core.Appender;
018import ch.qos.logback.core.Context;
019import ch.qos.logback.core.joran.JoranConstants;
020import ch.qos.logback.core.model.AppenderRefModel;
021import ch.qos.logback.core.model.Model;
022import ch.qos.logback.core.spi.AppenderAttachable;
023
024import java.util.Map;
025
026import static ch.qos.logback.core.model.processor.AppenderDeclarationAnalyser.isAppenderDeclared;
027
028public class AppenderRefModelHandler extends ModelHandlerBase {
029    boolean inError = false;
030
031    public AppenderRefModelHandler(Context context) {
032        super(context);
033    }
034
035    static public ModelHandlerBase makeInstance(Context context, ModelInterpretationContext ic) {
036        return new AppenderRefModelHandler(context);
037    }
038
039    @Override
040    protected Class<? extends AppenderRefModel> getSupportedModelClass() {
041        return AppenderRefModel.class;
042    }
043
044    @Override
045    public void handle(ModelInterpretationContext interpContext, Model model) throws ModelHandlerException {
046
047        Object o = interpContext.peekObject();
048
049        if (!(o instanceof AppenderAttachable)) {
050            inError = true;
051            String errMsg = "Could not find an AppenderAttachable at the top of execution stack. Near "
052                    + model.idString();
053            addError(errMsg);
054            return;
055        }
056
057        AppenderRefModel appenderRefModel = (AppenderRefModel) model;
058        AppenderAttachable<?> appenderAttachable = (AppenderAttachable<?>) o;
059
060        attachReferencedAppenders(interpContext, appenderRefModel, appenderAttachable);
061
062    }
063
064    @SuppressWarnings({ "unchecked", "rawtypes" })
065    void attachReferencedAppenders(ModelInterpretationContext mic, AppenderRefModel appenderRefModel,
066            AppenderAttachable<?> appenderAttachable) {
067        String appenderName = mic.subst(appenderRefModel.getRef());
068
069        if(!isAppenderDeclared(mic, appenderName)) {
070            addWarn("Appender named [" + appenderName + "] could not be found. Skipping attachment to "+appenderAttachable+".");
071            return;
072        }
073
074        Map<String, Appender> appenderBag = (Map<String, Appender>) mic.getObjectMap().get(JoranConstants.APPENDER_BAG);
075
076        Appender appender = appenderBag.get(appenderName);
077        if (appender == null) {
078            addError("Failed to find appender named [" + appenderName + "]");
079        } else {
080            addInfo("Attaching appender named [" + appenderName + "] to " + appenderAttachable);
081            appenderAttachable.addAppender(appender);
082        }
083
084    }
085}