MessageBeanClient.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2011 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 org.glassfish.ejb.spi;

import org.glassfish.ejb.api.MessageBeanProtocolManager;

/*
 * MessageBeanClient is an interface implemented by clients
 * of the MessageBeanContainer.  It contains lifecycle methods 
 * that allow the container to bootstrap the MessageBeanClient.
 * A MessageBeanClient is some part of the container that needs
 * to deliver messages to a message-driven bean.  
 *
 * @author Kenneth Saks
 */
public interface MessageBeanClient {

    /**
     * First method called by MessageBeanContainer during bootstrapping.
     * Allow the MessageBeanClient to initialize itself.  Message delivery
     * should not begin until start is called.  
     *
     * @param pm MessageBeanProtocolManager allows the MessageBeanClient to
     * access the services provided by the MessageBeanContainer.
     */
    void setup(MessageBeanProtocolManager pm) throws Exception;

    /**
     * MessageBeanContainer calls this when it is ready handle message delivery.
     */
    void start() throws Exception;

    /**
     * MessageBeanContainer calls this to shutdown MessageBeanClient.
     */
    void close();

}