/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/**
 * PROPRIETARY/CONFIDENTIAL.  Use of this product is subject to license terms.
 *
 * Copyright 2001-2002 by iPlanet/Sun Microsystems, Inc.,
 * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
 * All rights reserved.
 */
package com.sun.enterprise.admin.event;

import com.sun.enterprise.config.serverbeans.ServerTags;
import com.sun.enterprise.config.serverbeans.ServerXPathHelper;

/**
 * Listener for config changes handled by web core. Web core handles changes
 * to http-service and web-container elements of server.xml without restart.
 * This class allows Java notification framework to determine that all such
 * changes are handled dynamically.
 */
public class WebConfigChangeEventListener implements ConfigChangeEventListener {

    /**
     * Useful constant to denote one or more match in a regular expression
     */
    private static final String ONE_OR_MORE = ServerXPathHelper.REGEX_ONE_PLUS;

    /**
     * Regular expression for server.xml xpaths dynamically handled by web core
     * -- <code>/{1,}server/{1,}(http-service|web-container).*</code>
     */
    public static final String CATEGORY_REGEX =
            ServerXPathHelper.REGEX_XPATH_CONFIG
            + ServerXPathHelper.XPATH_SEPARATOR + ONE_OR_MORE
            + "(" + ServerTags.HTTP_SERVICE + "|" + ServerTags.WEB_CONTAINER
            + ").*";

    /**
     * Config change category handled by this listener. 
     */
    private ConfigChangeCategory category = new ConfigChangeCategory("webcore",
            CATEGORY_REGEX);

    /**
     * Handle config changes. If init.conf or obj.conf has changed for the
     * instance then set the status of "Restart Required".
     */
    public void configChanged(ConfigChangeEvent configChangeEvent)
            throws AdminEventListenerException {
        if (configChangeEvent.isInitOrObjConfChanged()) {
            AdminEventMulticaster.notifyFailure(configChangeEvent,
                    AdminEventResult.RESTART_NEEDED);
        }
    }

    /**
     * Get category handled by this listener. Used while registering the
     * event listener.
     */
    public ConfigChangeCategory getConfigChangeCategory() {
        return category;
    }
}
