001/*
002 * Copyright 2002-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.jms.core;
018
019import javax.jms.JMSException;
020import javax.jms.MessageProducer;
021import javax.jms.Session;
022
023/**
024 * Callback for sending a message to a JMS destination.
025 *
026 * <p>To be used with {@link JmsTemplate}'s callback methods that take a
027 * {@link ProducerCallback} argument, often implemented as an anonymous
028 * inner class or as a lambda expression.
029 *
030 * <p>The typical implementation will perform multiple operations on the
031 * supplied JMS {@link Session} and {@link MessageProducer}.
032 *
033 * @author Mark Pollack
034 * @since 1.1
035 * @see JmsTemplate#execute(ProducerCallback)
036 * @see JmsTemplate#execute(javax.jms.Destination, ProducerCallback)
037 * @see JmsTemplate#execute(String, ProducerCallback)
038 */
039public interface ProducerCallback<T> {
040
041        /**
042         * Perform operations on the given {@link Session} and {@link MessageProducer}.
043         * <p>The message producer is not associated with any destination unless
044         * when specified in the JmsTemplate call.
045         * @param session the JMS {@code Session} object to use
046         * @param producer the JMS {@code MessageProducer} object to use
047         * @return a result object from working with the {@code Session}, if any
048         * (or {@code null} if none)
049         * @throws javax.jms.JMSException if thrown by JMS API methods
050         */
051        T doInJms(Session session, MessageProducer producer) throws JMSException;
052
053}