001/**
002 * Logback: the reliable, generic, fast and flexible logging framework.
003 * Copyright (C) 1999-2015, 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 v1.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 */
014package ch.qos.logback.classic.spi;
015
016import ch.qos.logback.classic.LoggerContext;
017import ch.qos.logback.core.spi.ContextAware;
018
019/**
020 * Allows programmatic initialization and configuration of Logback. The
021 * ServiceLoader is typically used to instantiate implementations and thus
022 * implementations will need to follow the guidelines of the ServiceLoader
023 * specifically a no-arg constructor is required.
024 *
025 * The return type of {@link #configure(LoggerContext)  configure} was changed from 'void' to
026 * {@link ExecutionStatus) in logback version 1.3.0.
027 */
028public interface Configurator extends ContextAware {
029
030    enum ExecutionStatus {
031        NEUTRAL, // let the caller decide
032        INVOKE_NEXT_IF_ANY, // invoke other
033        DO_NOT_INVOKE_NEXT_IF_ANY
034    }
035    /**
036     * The context will also be set before this method is called via
037     * {@link ContextAware#setContext(ch.qos.logback.core.Context)}.
038     */
039    ExecutionStatus configure(LoggerContext loggerContext);
040
041}