View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.spi;
18  
19  import java.net.URI;
20  
21  /**
22   * Implemented by factories that create {@link LoggerContext} objects.
23   */
24  public interface LoggerContextFactory {
25  
26      /**
27       * Creates a {@link LoggerContext}.
28       *
29       * @param fqcn The fully qualified class name of the caller.
30       * @param loader The ClassLoader to use or null.
31       * @param currentContext If true returns the current Context, if false returns the Context appropriate
32       * for the caller if a more appropriate Context can be determined.
33       * @param externalContext An external context (such as a ServletContext) to be associated with the LoggerContext.
34       * @return The LoggerContext.
35       */
36      LoggerContext getContext(String fqcn, ClassLoader loader, Object externalContext, boolean currentContext);
37  
38      /**
39       * Creates a {@link LoggerContext}.
40       *
41       * @param fqcn The fully qualified class name of the caller.
42       * @param loader The ClassLoader to use or null.
43       * @param currentContext If true returns the current Context, if false returns the Context appropriate
44       * for the caller if a more appropriate Context can be determined.
45       * @param configLocation The location of the configuration for the LoggerContext.
46       * @param externalContext An external context (such as a ServletContext) to be associated with the LoggerContext.
47       * @param name The name of the context or null.
48       * @return The LoggerContext.
49       */
50      LoggerContext getContext(String fqcn, ClassLoader loader, Object externalContext, boolean currentContext,
51                               URI configLocation, String name);
52  
53      /**
54       * Removes knowledge of a LoggerContext.
55       *
56       * @param context The context to remove.
57       */
58      void removeContext(LoggerContext context);
59  }