001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.log4j.spi;
018
019import java.io.InputStream;
020import java.net.URL;
021
022import org.apache.logging.log4j.core.LoggerContext;
023
024/**
025 * Log4j 1.x Configurator interface.
026 */
027public interface Configurator {
028
029    public static final String INHERITED = "inherited";
030
031    public static final String NULL = "null";
032
033
034    /**
035     Interpret a resource pointed by a InputStream and set up log4j accordingly.
036
037     The configuration is done relative to the <code>hierarchy</code>
038     parameter.
039
040     @param inputStream The InputStream to parse
041
042     @since 1.2.17
043     */
044    void doConfigure(InputStream inputStream, final LoggerContext loggerContext);
045
046    /**
047     Interpret a resource pointed by a URL and set up log4j accordingly.
048
049     The configuration is done relative to the <code>hierarchy</code>
050     parameter.
051
052     @param url The URL to parse
053     */
054    void doConfigure(URL url, final LoggerContext loggerContext);
055}