001/*-
002 * #%L
003 * HAPI FHIR Storage api
004 * %%
005 * Copyright (C) 2014 - 2024 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.jpa.subscription.model.ResourceModifiedMessage;
023import ca.uhn.fhir.subscription.api.IResourceModifiedConsumerWithRetries;
024import org.springframework.messaging.MessageDeliveryException;
025
026/**
027 * The implementer of this interface should submit the result of an operation on a resource
028 * to the subscription processing pipeline.
029 */
030public interface IResourceModifiedConsumer {
031
032        /**
033         *  Process a message by submitting it to the processing pipeline.  The message is assumed to have been successfully
034         *  submitted unless a {@link MessageDeliveryException} is thrown by the underlying support.  The exception should be allowed to
035         *  propagate for client handling and potential re-submission through the {@link IResourceModifiedConsumerWithRetries}.
036         *
037         * @param theMsg The message to submit
038         *
039         * This is an internal API - Use with caution!
040         *
041         */
042        void submitResourceModified(ResourceModifiedMessage theMsg);
043}