001/*
002 * Copyright 2002-2014 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.config;
018
019import org.springframework.jms.listener.MessageListenerContainer;
020
021/**
022 * Model for a JMS listener endpoint. Can be used against a
023 * {@link org.springframework.jms.annotation.JmsListenerConfigurer
024 * JmsListenerConfigurer} to register endpoints programmatically.
025 *
026 * @author Stephane Nicoll
027 * @since 4.1
028 */
029public interface JmsListenerEndpoint {
030
031        /**
032         * Return the id of this endpoint.
033         */
034        String getId();
035
036        /**
037         * Setup the specified message listener container with the model
038         * defined by this endpoint.
039         * <p>This endpoint must provide the requested missing option(s) of
040         * the specified container to make it usable. Usually, this is about
041         * setting the {@code destination} and the {@code messageListener} to
042         * use but an implementation may override any default setting that
043         * was already set.
044         * @param listenerContainer the listener container to configure
045         */
046        void setupListenerContainer(MessageListenerContainer listenerContainer);
047
048}