/*
 * 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.
 */
package com.sun.enterprise.admin.event;

import java.util.List;
import java.util.ArrayList;
import com.sun.enterprise.config.ConfigContext;

/**
 * This object encapsulates event related information in the thread local.
 *
 * @author Nazrul Islam
 * @since  JDK1.4
 */
public class EventStack {

    /**
     * Returns the config changes associated with this event.
     * @return  list of config changes
     */
    public List getConfigChangeList() {
        return _configChangeList;
    }

    /**
     * Sets the config changes for this event.
     * @param  list  list of config changes
     */
    public void setConfigChangeList(List list) {
        _configChangeList = list;
    }

    /**
     * Returns the target for this event.
     * @return  the target for this event
     */
    public String getTarget() {
        return _target;
    }

    /**
     * Sets the target destination for this event.
     * @param  target  target destination of the event
     */
    public void setTarget(String target) {
        _target = target;
    }

    public String getXPath() {
        return _xPath;
    }

    public void setXPath(String xPath) {
        _xPath = xPath;
    }

    /**
     * Returns all events from the stack.
     * @return  list of events from the stack
     */
    public List getEvents() {
        return _events;
    }

    /**
     * Adds an event to the event stack.
     * @param  event  newly created event 
     */
    public void addEvent(AdminEvent event) {
        _events.add(event);
    }

    /** 
     * Returns the admin config context associated with this event.
     * @return  admin config context
     */
    public ConfigContext getConfigContext() {
        return _ctx;
    }

    /**
     * Sets the admin config context to the event stack.
     * @param  ctx  admin config context
     */
    public void setConfigContext(ConfigContext ctx) {
        _ctx = ctx;
    }

    /**
     * resets the events in the event stack.
     */
    public void resetEvents() {
        _events.clear();
    }
    
    // ---- VARIABLES - PRIVATE --------------------------- 
    private List _configChangeList = new ArrayList();
    private String _target         = null;
    private String _xPath          = null;
    private List _events           = new ArrayList();
    private ConfigContext _ctx     = null;
}