FileDocCategorySizeDatePackage
ApplicationClientEvent.javaAPI DocGlassfish v2 API4090Fri May 04 22:35:44 BST 2007com.sun.enterprise.server.event

ApplicationClientEvent.java

/*
 * 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.server.event;

import com.sun.enterprise.config.ConfigContext;
import com.sun.enterprise.deployment.Application;

/**
 *
 * ApplicationClientEvents are sent before/after an application client
 *  is loaded/unloaded.
 *
 * Listeners that are interested in getting ApplicationClientLaoderEvents
 *  can register with the ApplicationClientLoaderEventNotifier as follows:
 *
 *  ApplicationClientLoaderEventNotifier notifier =
 *	ApplicationClientLoaderEventNotifier.getInstance();
 *  notifier.addListener(listener);
 *
 * Application client events are sent even when app client modules are
 *  deployed / undeployed. 
 *
 * Generally, APPLICATION events are sent in the following order
 *  a) BEFORE_APPLICATION_CLIENT_LOAD
 *  b) AFTER_APPLICATION_CLIENT_LOAD
 *  c) BEFORE_APPLICATION_CLIENT_UNLOAD
 *  d) AFTER_APPLICATION_CLIENT_UNLOAD
 *  
 *Note that this class is basically a copy of the ApplicationEvent class, with
 *the key difference being the prefix assinged for the toString method.
 *
 *Also, this class defines a parallel set of constants named for application client
 *load and unload events for clarity in logic elsewhere that uses them.
 */
public class ApplicationClientEvent extends ApplicationEvent {

    /**
     *The following constants allow listeners for this type of event to
     *use names that reflect the client-related event types, even though they
     *convey essentially the same meaning as the application-related event types.
     */
    public static final int BEFORE_APPLICATION_CLIENT_LOAD = BEFORE_APPLICATION_LOAD;
    public static final int AFTER_APPLICATION_CLIENT_LOAD = AFTER_APPLICATION_LOAD;
    public static final int BEFORE_APPLICATION_CLIENT_UNLOAD = BEFORE_APPLICATION_UNLOAD;
    public static final int AFTER_APPLICATION_CLIENT_UNLOAD = AFTER_APPLICATION_UNLOAD;

    public ApplicationClientEvent(int eventType, Application application,
	    ClassLoader loader, ConfigContext configContext)
    {
	super(eventType, application, loader, configContext);
    }
    
    public String toString() {
        return toString(new StringBuffer("AppClientEvent: "));
    }

}