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.QueueBrowser;
021import javax.jms.Session;
022
023/**
024 * Callback for browsing the messages in a JMS queue.
025 *
026 * <p>To be used with {@link JmsTemplate}'s callback methods that take a
027 * {@link BrowserCallback} argument, often implemented as an anonymous
028 * inner class or as a lambda expression.
029 *
030 * @author Juergen Hoeller
031 * @since 2.5.1
032 * @see JmsTemplate#browse(BrowserCallback)
033 * @see JmsTemplate#browseSelected(String, BrowserCallback)
034 */
035public interface BrowserCallback<T> {
036
037        /**
038         * Perform operations on the given {@link javax.jms.Session} and
039         * {@link javax.jms.QueueBrowser}.
040         * @param session the JMS {@code Session} object to use
041         * @param browser the JMS {@code QueueBrowser} object to use
042         * @return a result object from working with the {@code Session}, if any
043         * (or {@code null} if none)
044         * @throws javax.jms.JMSException if thrown by JMS API methods
045         */
046        T doInJms(Session session, QueueBrowser browser) throws JMSException;
047
048}