org.springframework.jms.core.ProducerCallback Maven / Gradle / Ivy
/*
* Copyright 2002-2006 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.jms.core;
import javax.jms.JMSException;
import javax.jms.MessageProducer;
import javax.jms.Session;
/**
* Callback for sending a message to a JMS destination.
*
* To be used with the {@link JmsTemplate#execute(ProducerCallback)}
* method, often implemented as an anonymous inner class.
*
*
The typical implementation will perform multiple operations on the
* supplied JMS {@link Session} and {@link MessageProducer}. When used with
* a 1.0.2 provider, you need to downcast to the appropriate domain
* implementation, either {@link javax.jms.QueueSender} or
* {@link javax.jms.TopicPublisher}, to actually send a message.
*
* @author Mark Pollack
* @since 1.1
* @see JmsTemplate#execute(ProducerCallback)
*/
public interface ProducerCallback {
/**
* Perform operations on the given {@link Session} and {@link MessageProducer}.
*
The message producer is not associated with any destination.
* @param session the JMS Session object to use
* @param producer the JMS MessageProducer object to use
* @return a result object from working with the Session, if any (can be null)
* @throws javax.jms.JMSException if thrown by JMS API methods
*/
Object doInJms(Session session, MessageProducer producer) throws JMSException;
}