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
18 package org.apache.log4j.spi;
19
20 import java.net.URL;
21
22 /**
23 Implemented by classes capable of configuring log4j using a URL.
24
25 @since 1.0
26 @author Anders Kristensen
27 */
28 public interface Configurator {
29
30 /**
31 Special level value signifying inherited behaviour. The current
32 value of this string constant is <b>inherited</b>. {@link #NULL}
33 is a synonym. */
34 public static final String INHERITED = "inherited";
35
36 /**
37 Special level signifying inherited behaviour, same as {@link
38 #INHERITED}. The current value of this string constant is
39 <b>null</b>. */
40 public static final String NULL = "null";
41
42
43
44 /**
45 Interpret a resource pointed by a URL and set up log4j accordingly.
46
47 The configuration is done relative to the <code>hierarchy</code>
48 parameter.
49
50 @param url The URL to parse
51 @param repository The hierarchy to operation upon.
52 */
53 void doConfigure(URL url, LoggerRepository repository);
54 }