/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2000-2009 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 mq/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 mq/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. 
 */

/*
 * @(#)ConnectionEvent.java	1.4 07/02/07
 */ 

package com.sun.messaging.jms.notification;

import com.sun.messaging.jms.Connection;

/**
 * MQ Connection Event.  This is the super class for all MQ connection
 * events. MQ may notify an application when a connection event is
 * about to occur or occurred.
 *
 * <p>
 * The following are a list of connection
 * notification types that defined in MQ hawk release:
 * <p>
 *
 * 1. Connection closing in "time period":
 * <UL>
 *    <li>SHUTDOWN (admin requested shutdown)
 * </UL>
 * <p>
 *
 * 2. Connection closed because of:
 * <UL>
 *   <li>    SHUTDOWN (admin requested shutdown)
 *   <li>    RESTART (admin requested restart)
 *   <li>    ERROR (server error, e.g. out of memory)
 *   <li>    ADMIN  (admin killed connection)
 *   <li>    BROKER_DOWN (broker crash)
 * </UL>
 *<p>
 *
 *
 * 3. Reconnected:
 * <UL>
 *   <li>    RECONNECTED to a broker
 * </UL>
 * <p>
 *
 * 4. Reconnect Failed:
 * <UL>
 *   <li>    RECONNECT_FAILED to a broker
 * </UL>
 */
public class ConnectionEvent extends Event {

    private String brokerAddress = null;

    /**
     * The connection object that associated with this event.
     */
    protected transient Connection connection = null;

    /**
     * Construct a MQ connection event.
     *
     * @param conn the connection associated with this event object.
     * @param evCode the event code that represents the this event object.
     * @param evMessage the event message that describes this event object.

     */
    public ConnectionEvent (Connection conn, String evCode, String evMessage) {
        super (conn, evCode, evMessage);

        this.connection = conn;
        this.brokerAddress = conn.getBrokerAddress();
    }

    /**
     * Get the current connection associated with this event.
     * @return the current connection associated with this event.
     */
    public Connection getConnection() {
        return this.connection;
    }

    /**
     * Get the broker's address that the event is associated with.
     *
     * @return the broker's address that the event is associated with.
     */
    public String getBrokerAddress() {
        return this.brokerAddress;
    }

    /**
     * Return com.sun.messaging.jms.Connection object.
     * @return the connection object associated with this event.
     */
    public Object getSource() {
        return this.getConnection();
    }
}
