com.fitbur.glassfish.hk2.utilities.DefaultTopicDistributionErrorService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of external-docker-java Show documentation
There is a newer version: 1.0.0
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2014 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 com.fitburpliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.com.fitburv.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 com.fitbursignates 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 com.fitburcision 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.fitbur.glassfish.hk2.utilities;

import com.fitbur.glassfish.hk2.api.MultiException;
import com.fitbur.glassfish.hk2.api.messaging.Topic;
import com.fitbur.jvnet.hk2.annotations.Contract;

/**
 * When using the TopicDistributionService added with
 * {@link ServiceLocatorUtilities#enableTopicDistribution(com.fitbur.glassfish.hk2.api.ServiceLocator)}
 * if a subscriber throws an exception this service will be called.
 * All implementation of this service will be called.
 * 
 * @author jwells
 */
@Contract
public interface DefaultTopicDistributionErrorService {
    /**
     * This method will be called once per {@link Topic#publish(Object)}
     * call after the message has been distributed to all subscribers.
     * The {@link MultiException} will contain the errors from any
     * subscribers that threw exceptions.  This method will
     * not be called if no subscribers threw exceptions
     * 
     * @param topic The topic that the message was sent to
     * @param message The message that was sent to the topic
     * @param error The exceptions thrown by the subscribers of this {@link Topic}
     */
    public void subscribersFailed(Topic topic, Object message, MultiException error);

}