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.log4j.spi;
18
19 import org.apache.log4j.Appender;
20 import org.apache.log4j.Category;
21 import org.apache.log4j.Level;
22 import org.apache.log4j.Logger;
23
24 import java.util.Enumeration;
25
26 /**
27 * A <code>LoggerRepository</code> is used to create and retrieve
28 * <code>Loggers</code>. The relation between loggers in a repository
29 * depends on the repository but typically loggers are arranged in a
30 * named hierarchy.
31 * <p/>
32 * <p>In addition to the creational methods, a
33 * <code>LoggerRepository</code> can be queried for existing loggers,
34 * can act as a point of registry for events related to loggers.
35 *
36 * @since 1.2
37 */
38 public interface LoggerRepository {
39
40 /**
41 * Add a {@link HierarchyEventListener} event to the repository.
42 */
43 void addHierarchyEventListener(HierarchyEventListener listener);
44
45 /**
46 * Returns whether this repository is disabled for a given
47 * level. The answer depends on the repository threshold and the
48 * <code>level</code> parameter. See also {@link #setThreshold}
49 * method.
50 */
51 boolean isDisabled(int level);
52
53 /**
54 * Set the repository-wide threshold. All logging requests below the
55 * threshold are immediately dropped. By default, the threshold is
56 * set to <code>Level.ALL</code> which has the lowest possible rank.
57 */
58 void setThreshold(Level level);
59
60 /**
61 * Another form of {@link #setThreshold(Level)} accepting a string
62 * parameter instead of a <code>Level</code>.
63 */
64 void setThreshold(String val);
65
66 void emitNoAppenderWarning(Category cat);
67
68 /**
69 * Get the repository-wide threshold. See {@link
70 * #setThreshold(Level)} for an explanation.
71 */
72 Level getThreshold();
73
74 Logger getLogger(String name);
75
76 Logger getLogger(String name, LoggerFactory factory);
77
78 Logger getRootLogger();
79
80 abstract Logger exists(String name);
81
82 abstract void shutdown();
83
84 Enumeration getCurrentLoggers();
85
86 /**
87 * Deprecated. Please use {@link #getCurrentLoggers} instead.
88 */
89 Enumeration getCurrentCategories();
90
91
92 abstract void fireAddAppenderEvent(Category logger, Appender appender);
93
94 abstract void resetConfiguration();
95
96 }