View Javadoc

1   /*
2    * Copyright 2001-2004 The Apache Software Foundation.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.log4j.spi;
18  
19  
20  import org.apache.log4j.spi.LoggerRepository;
21  import java.net.URL;
22  
23  /**
24     Implemented by classes capable of configuring log4j using a URL.
25  
26     @since 1.0
27     @author Anders Kristensen
28   */
29  public interface Configurator {
30  
31    /**
32       Special level value signifying inherited behaviour. The current
33       value of this string constant is <b>inherited</b>. {@link #NULL}
34       is a synonym.  */
35    public static final String INHERITED = "inherited";
36  
37    /**
38       Special level signifying inherited behaviour, same as {@link
39       #INHERITED}. The current value of this string constant is
40       <b>null</b>. */
41    public static final String NULL = "null";
42  
43  
44  
45    /**
46       Interpret a resource pointed by a URL and set up log4j accordingly.
47  
48       The configuration is done relative to the <code>hierarchy</code>
49       parameter.
50  
51       @param url The URL to parse
52       @param repository The hierarchy to operation upon.
53     */
54    void doConfigure(URL url, LoggerRepository repository);
55  }