1   /*
2    * Logback: the reliable, generic, fast and flexible logging framework.
3    * Copyright (C) 1999-2026, QOS.ch. All rights reserved.
4    *
5    * This program and the accompanying materials are dual-licensed under
6    * either the terms of the Eclipse Public License v2.0 as published by
7    * the Eclipse Foundation
8    *
9    *   or (per the licensee's choosing)
10   *
11   * under the terms of the GNU Lesser General Public License version 2.1
12   * as published by the Free Software Foundation.
13   */
14  
15  package ch.qos.logback.core.joran;
16  
17  import ch.qos.logback.core.Context;
18  import ch.qos.logback.core.model.*;
19  import ch.qos.logback.core.model.conditional.ByPropertiesConditionModel;
20  import ch.qos.logback.core.model.conditional.ElseModel;
21  import ch.qos.logback.core.model.conditional.IfModel;
22  import ch.qos.logback.core.model.conditional.ThenModel;
23  import ch.qos.logback.core.model.processor.*;
24  import ch.qos.logback.core.model.processor.conditional.ByPropertiesConditionModelHandler;
25  import ch.qos.logback.core.model.processor.conditional.ElseModelHandler;
26  import ch.qos.logback.core.model.processor.conditional.IfModelHandler;
27  import ch.qos.logback.core.model.processor.conditional.ThenModelHandler;
28  import ch.qos.logback.core.sift.SiftModelHandler;
29  
30  /**
31   * For a given DefaultProcessor instance link a {@link ch.qos.logback.core.model.Model Model} class to
32   * a {@link ch.qos.logback.core.model.processor.ModelHandlerBase ModelHandler} instance in logback-core.
33   *
34   * <p>Derived classes are likely to add further links.</p>
35   *
36   * @since 1.3.9/1.4.9
37   */
38  public class ModelClassToModelHandlerLinkerBase {
39  
40  
41      protected Context context;
42  
43      public ModelClassToModelHandlerLinkerBase(Context context) {
44          this.context = context;
45      }
46  
47      public void link(DefaultProcessor defaultProcessor) {
48          defaultProcessor.addHandler(ImportModel.class, ImportModelHandler::makeInstance);
49  
50          defaultProcessor.addHandler(ShutdownHookModel.class, ShutdownHookModelHandler::makeInstance);
51          defaultProcessor.addHandler(SequenceNumberGeneratorModel.class, SequenceNumberGeneratorModelHandler::makeInstance);
52          defaultProcessor.addHandler(SerializeModelModel.class, SerializeModelModelHandler::makeInstance);
53  
54          defaultProcessor.addHandler(EventEvaluatorModel.class, EventEvaluatorModelHandler::makeInstance);
55          defaultProcessor.addHandler(ConversionRuleModel.class, ConversionRuleModelHandler::makeInstance);
56  
57          defaultProcessor.addHandler(DefineModel.class, DefineModelHandler::makeInstance);
58          defaultProcessor.addHandler(IncludeModel.class, IncludeModelHandler::makeInstance);
59  
60  
61          defaultProcessor.addHandler(ParamModel.class, ParamModelHandler::makeInstance);
62          defaultProcessor.addHandler(PropertyModel.class, PropertyModelHandler::makeInstance);
63          defaultProcessor.addHandler(TimestampModel.class, TimestampModelHandler::makeInstance);
64          defaultProcessor.addHandler(StatusListenerModel.class, StatusListenerModelHandler::makeInstance);
65          defaultProcessor.addHandler(ImplicitModel.class, ImplicitModelHandler::makeInstance);
66  
67  
68          defaultProcessor.addHandler(ByPropertiesConditionModel.class, ByPropertiesConditionModelHandler::makeInstance);
69          defaultProcessor.addHandler(IfModel.class, IfModelHandler::makeInstance);
70          defaultProcessor.addHandler(ThenModel.class, ThenModelHandler::makeInstance);
71          defaultProcessor.addHandler(ElseModel.class, ElseModelHandler::makeInstance);
72  
73          defaultProcessor.addHandler(SiftModel.class, SiftModelHandler::makeInstance);
74      }
75  
76      // The final filters in the two filter chain are rather crucial.
77      // They ensure that only Models attached to the firstPhaseFilter will
78      // be handled in the first phase and all models not previously handled
79      // in the second phase will be handled in a catch-all fallback case.
80      protected void sealModelFilters(DefaultProcessor defaultProcessor) {
81          defaultProcessor.getPhaseOneFilter().denyAll();
82          defaultProcessor.getPhaseTwoFilter().allowAll();
83      }
84  }