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 */
017package org.apache.logging.log4j.core.selector;
018
019import java.net.URI;
020import java.util.List;
021
022import org.apache.logging.log4j.core.LoggerContext;
023
024/**
025 * Interface used to locate a LoggerContext.
026 */
027public interface ContextSelector {
028
029    /**
030     * Returns the LoggerContext.
031     * @param fqcn The fully qualified class name of the caller.
032     * @param loader ClassLoader to use or null.
033     * @param currentContext If true returns the current Context, if false returns the Context appropriate
034     * for the caller if a more appropriate Context can be determined.
035     * @return The LoggerContext.
036     */
037    LoggerContext getContext(String fqcn, ClassLoader loader, boolean currentContext);
038
039    /**
040     * Returns the LoggerContext.
041     * @param fqcn The fully qualified class name of the caller.
042     * @param loader 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     * @return The LoggerContext.
047     */
048    LoggerContext getContext(String fqcn, ClassLoader loader, boolean currentContext, URI configLocation);
049
050    /**
051     * Returns a List of all the available LoggerContexts.
052     * @return The List of LoggerContexts.
053     */
054    List<LoggerContext> getLoggerContexts();
055
056    /**
057     * Remove any references to the LoggerContext.
058     * @param context The context to remove.
059     */
060    void removeContext(LoggerContext context);
061}