View Javadoc
1   /**
2    * Logback: the reliable, generic, fast and flexible logging framework.
3    * Copyright (C) 1999-2015, 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   * Allows programmatic initialization and configuration of Logback. The
21   * ServiceLoader is typically used to instantiate implementations and thus
22   * implementations will need to follow the guidelines of the ServiceLoader
23   * specifically a no-arg constructor is required.
24   *
25   * The return type of {@link #configure(LoggerContext)  configure} was changed from 'void' to
26   * {@link ExecutionStatus) in logback version 1.3.0.
27   */
28  public interface Configurator extends ContextAware {
29  
30      enum ExecutionStatus {
31          NEUTRAL, // let the caller decide
32          INVOKE_NEXT_IF_ANY, // invoke other
33          DO_NOT_INVOKE_NEXT_IF_ANY
34      }
35      /**
36       * The context will also be set before this method is called via
37       * {@link ContextAware#setContext(ch.qos.logback.core.Context)}.
38       */
39      ExecutionStatus configure(LoggerContext loggerContext);
40  
41  }