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.xml;
018
019import org.w3c.dom.Element;
020import java.util.Properties;
021
022/**
023 * When implemented by an object configured by DOMConfigurator,
024 * the handle method will be called when an unrecognized child
025 * element is encountered.  Unrecognized child elements of
026 * the log4j:configuration element will be dispatched to
027 * the logger repository if it supports this interface.
028 *
029 * @since 1.2.15
030 */
031public interface UnrecognizedElementHandler {
032    /**
033     * Called to inform a configured object when
034     * an unrecognized child element is encountered.
035     * @param element element, may not be null.
036     * @param props properties in force, may be null.
037     * @return true if configured object recognized the element
038     * @throws Exception throw an exception to prevent activation
039     * of the configured object.
040     */
041    boolean parseUnrecognizedElement(Element element, Properties props) throws Exception;
042}