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