001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements. See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache license, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License. You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the license for the specific language governing permissions and
015     * limitations under the license.
016     */
017    package org.apache.logging.log4j.spi;
018    
019    import java.net.URI;
020    
021    /**
022     * Implemented by factories that create {@link LoggerContext} objects.
023     */
024    public interface LoggerContextFactory {
025    
026        /**
027         * Creates a {@link LoggerContext}.
028         *
029         * @param fqcn The fully qualified class name of the caller.
030         * @param loader The ClassLoader to use or null.
031         * @param currentContext If true returns the current Context, if false returns the Context appropriate
032         * for the caller if a more appropriate Context can be determined.
033         * @param externalContext An external context (such as a ServletContext) to be associated with the LoggerContext.
034         * @return The LoggerContext.
035         */
036        LoggerContext getContext(String fqcn, ClassLoader loader, Object externalContext, boolean currentContext);
037    
038        /**
039         * Creates a {@link LoggerContext}.
040         *
041         * @param fqcn The fully qualified class name of the caller.
042         * @param loader The ClassLoader to use or null.
043         * @param currentContext If true returns the current Context, if false returns the Context appropriate
044         * for the caller if a more appropriate Context can be determined.
045         * @param configLocation The location of the configuration for the LoggerContext.
046         * @param externalContext An external context (such as a ServletContext) to be associated with the LoggerContext.
047         * @param name The name of the context or null.
048         * @return The LoggerContext.
049         */
050        LoggerContext getContext(String fqcn, ClassLoader loader, Object externalContext, boolean currentContext,
051                                 URI configLocation, String name);
052    
053        /**
054         * Removes knowledge of a LoggerContext.
055         *
056         * @param context The context to remove.
057         */
058        void removeContext(LoggerContext context);
059    }