1   /*
2    * Logback: the reliable, generic, fast and flexible logging framework.
3    * Copyright (C) 1999-2023, 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 v1.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  package ch.qos.logback.classic.spi;
15  
16  import ch.qos.logback.classic.LoggerContext;
17  import ch.qos.logback.core.spi.ContextAware;
18  
19  
20  /**
21   * <p>Allows programmatic initialization and configuration of Logback. The
22   * ServiceLoader is typically used to instantiate implementations and thus
23   * implementations will need to follow the guidelines of the ServiceLoader,
24   * in particular the no-arg constructor requirement.</p>
25   *
26   * <p>The return type of {@link #configure(LoggerContext)  configure} was changed from 'void' to
27   * {@link ExecutionStatus} in logback version 1.3.0.
28   * </p>
29   */
30  public interface Configurator extends ContextAware {
31  
32      enum ExecutionStatus {
33          NEUTRAL, // let the caller decide
34          INVOKE_NEXT_IF_ANY, // invoke other
35          DO_NOT_INVOKE_NEXT_IF_ANY // the caller should not invoke further configurators even some are available
36      }
37  
38      /**
39       * Implementations of this method may expect that the {@link LoggerContext} is set with
40       * {@link ContextAware#setContext} before this method is invoked.
41       *
42       */
43      ExecutionStatus configure(LoggerContext context);
44  
45  }