org.springframework.jms.listener.SessionAwareMessageListener Maven / Gradle / Ivy
/*
* Copyright 2002-2007 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.listener;
import javax.jms.JMSException;
import javax.jms.Message;
import javax.jms.Session;
/**
* Variant of the standard JMS {@link javax.jms.MessageListener} interface,
* offering not only the received Message but also the underlying
* JMS Session object. The latter can be used to send reply messages,
* without the need to access an external Connection/Session,
* i.e. without the need to access the underlying ConnectionFactory.
*
* Supported by Spring's {@link DefaultMessageListenerContainer},
* {@link SimpleMessageListenerContainer} and
* {@link org.springframework.jms.listener.serversession.ServerSessionMessageListenerContainer},
* as direct alternative to the standard JMS MessageListener interface.
* Typically not supported by JCA-based listener containers:
* For maximum compatibility, implement a standard JMS MessageListener instead.
*
* @author Juergen Hoeller
* @since 2.0
* @see AbstractMessageListenerContainer#setMessageListener
* @see DefaultMessageListenerContainer
* @see SimpleMessageListenerContainer
* @see org.springframework.jms.listener.serversession.ServerSessionMessageListenerContainer
* @see javax.jms.MessageListener
*/
public interface SessionAwareMessageListener {
/**
* Callback for processing a received JMS message.
*
Implementors are supposed to process the given Message,
* typically sending reply messages through the given Session.
* @param message the received JMS message (never null)
* @param session the underlying JMS Session (never null)
* @throws JMSException if thrown by JMS methods
*/
void onMessage(Message message, Session session) throws JMSException;
}