FileDocCategorySizeDatePackage
ExceptionListener.javaAPI DocGlassfish v2 API3036Fri May 04 22:36:16 BST 2007javax.jms

ExceptionListener.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 javax.jms;


/** If a JMS provider detects a serious problem with a <CODE>Connection</CODE>
  * object, it informs the <CODE>Connection</CODE> object's 
  * <CODE>ExceptionListener</CODE>, if one has been registered. 
  * It does this by calling the listener's <CODE>onException</CODE> method, 
  * passing it a <CODE>JMSException</CODE> argument describing the problem.
  *
  * <P>An exception listener allows a client to be notified of a problem 
  * asynchronously. Some connections only consume messages, so they would have no
  * other way to learn that their connection has failed.
  *
  * <P>A JMS provider should attempt to resolve connection problems 
  * itself before it notifies the client of them.
  *
  * @version     1.0 - 9 March 1998
  * @author      Mark Hapner
  * @author      Rich Burridge
  *
  * @see javax.jms.Connection#setExceptionListener(ExceptionListener)
  */

public interface ExceptionListener {

    /** Notifies user of a JMS exception.
      *
      * @param exception the JMS exception
      */

    void 
    onException(JMSException exception);
}