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.jpa.subscription.match.matcher.matching;
021
022import ca.uhn.fhir.broker.api.ISendResult;
023import ca.uhn.fhir.jpa.subscription.model.ResourceModifiedMessage;
024import ca.uhn.fhir.rest.server.messaging.IMessage;
025import ca.uhn.fhir.subscription.api.IResourceModifiedConsumerWithRetries;
026import org.springframework.messaging.MessageDeliveryException;
027
028/**
029 * The implementer of this interface should submit the result of an operation on a resource
030 * to the subscription processing pipeline.
031 */
032public interface IResourceModifiedConsumer {
033
034        /**
035         * Process a message by submitting it to the processing pipeline.  The message is assumed to have been successfully
036         * submitted unless a {@link MessageDeliveryException} is thrown by the underlying support.  The exception should be allowed to
037         * propagate for client handling and potential re-submission through the {@link IResourceModifiedConsumerWithRetries}.
038         *
039         * @param theMsg The message to submit
040         *               <p>
041         *               This is an internal API - Use with caution!
042         * @return the result of the {@link ca.uhn.fhir.broker.api.IChannelProducer#send(IMessage)}
043         */
044        ISendResult submitResourceModified(ResourceModifiedMessage theMsg);
045}