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 org.apache.logging.log4j.message.MessageFactory;
20
21 /**
22 * Anchor point for logging implementations.
23 */
24 public interface LoggerContext {
25
26 /**
27 * An anchor for some other context, such as a ClassLoader or ServletContext.
28 * @return The external context.
29 */
30 Object getExternalContext();
31
32 /**
33 * Returns a Logger.
34 * @param name The name of the Logger to return.
35 * @return The logger with the specified name.
36 */
37 ExtendedLogger getLogger(String name);
38
39 /**
40 * Returns a Logger.
41 * @param name The name of the Logger to return.
42 * @param messageFactory The message factory is used only when creating a logger, subsequent use does not change
43 * the logger but will log a warning if mismatched.
44 * @return The logger with the specified name.
45 */
46 ExtendedLogger getLogger(String name, MessageFactory messageFactory);
47
48 /**
49 * Detects if a Logger with the specified name exists.
50 * @param name The Logger name to search for.
51 * @return true if the Logger exists, false otherwise.
52 */
53 boolean hasLogger(String name);
54 }