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.messaging.core;
018
019import org.springframework.lang.Nullable;
020import org.springframework.messaging.Message;
021import org.springframework.messaging.MessagingException;
022
023/**
024 * Extends {@link MessageReceivingOperations} and adds operations for receiving messages
025 * from a destination specified as a (resolvable) String name.
026 *
027 * @author Mark Fisher
028 * @author Rossen Stoyanchev
029 * @since 4.0
030 * @param <D> the type of destination to receive messages from
031 * @see DestinationResolver
032 */
033public interface DestinationResolvingMessageReceivingOperations<D> extends MessageReceivingOperations<D> {
034
035        /**
036         * Resolve the given destination name and receive a message from it.
037         * @param destinationName the destination name to resolve
038         */
039        @Nullable
040        Message<?> receive(String destinationName) throws MessagingException;
041
042        /**
043         * Resolve the given destination name, receive a message from it,
044         * convert the payload to the specified target type.
045         * @param destinationName the destination name to resolve
046         * @param targetClass the target class for the converted payload
047         */
048        @Nullable
049        <T> T receiveAndConvert(String destinationName, Class<T> targetClass) throws MessagingException;
050
051}