001/*-
002 * #%L
003 * HAPI FHIR Storage api
004 * %%
005 * Copyright (C) 2014 - 2025 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.broker.jms;
021
022import ca.uhn.fhir.i18n.Msg;
023import org.springframework.beans.factory.DisposableBean;
024import org.springframework.messaging.SubscribableChannel;
025import org.springframework.messaging.support.InterceptableChannel;
026
027/**
028 * Provide JMS Channel Receiver services for Spring Messaging.
029 */
030public interface ISpringMessagingChannelReceiver extends SubscribableChannel, InterceptableChannel, DisposableBean {
031        /**
032         * @return the name of the Queue this Channel Receiver consumes from
033         */
034        String getChannelName();
035
036        /**
037         * Pause the service (e.g. stop subscriber threads)
038         */
039        default void pause() {
040                throw new UnsupportedOperationException(Msg.code(2660));
041        }
042
043        /**
044         * Resume the service (e.g. start subscriber threads)
045         */
046        default void resume() {
047                throw new UnsupportedOperationException(Msg.code(2661));
048        }
049
050        /**
051         * Start the service (e.g. start the subscriber threads)
052         */
053        default void start() {
054                throw new UnsupportedOperationException(Msg.code(2662));
055        }
056}