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