javax.jms.ExceptionListener Maven / Gradle / Ivy

Go to download

/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright (c) 1997-2012 Oracle and/or its affiliates. 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_1_1.html * or packager/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 packager/legal/LICENSE.txt. * * GPL Classpath Exception: * Oracle designates this particular file as subject to the "Classpath" * exception as provided by Oracle in the GPL Version 2 section of the License * file that accompanied this code. * * Modifications: * If applicable, add the following below the License Header, with the fields * enclosed by brackets [] replaced by your own identifying information: * "Portions Copyright [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 Connection * object, it informs the Connection object's * ExceptionListener, if one has been registered. * It does this by calling the listener's onException method, * passing it a JMSException argument describing the problem. * * 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. * *

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); }