mq5.0-source.main.mq-direct.src.main.java.com.sun.messaging.jmq.jmsservice.Consumer Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2000-2013 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.
 */

/*
 * @(#)Consumer.java	1.4 06/29/07
 */ 

package com.sun.messaging.jmq.jmsservice;

import com.sun.messaging.jmq.io.JMSPacket;
/**
 *
 */
public interface Consumer {

    /**
     *  Deliver a message to the consumer to be processed.
     *  Except in the special case of consumer in closing and the message is
     *  neither delivered nor acked to throw a ConsumerClosedNoDeliveryException,
     *  the implementation of this method must not throw any exceptions, and 
     *  it must catch any exceptions, and either redeliver the message
     *  according to the redelivery configuration or it must acknowledge this
     *  message. It can acknowledge this message to the dead message queue if
     *  the redelivery attempts are unsuccessful.
     *
     *  @param  msgPkt The MJMSPacketto be processed
     *
     *  @return The JMSAck if the delivered message is to be acknowledged
     *          upon returning from this method.

     *          If this is {@code null} then the message will be acknowledged
     *          separately.
     * @throw ConsumerClosedRuntimeException
     */
    public JMSAck deliver(JMSPacket msgPkt) throws ConsumerClosedNoDeliveryException;

}