001package ca.uhn.fhir.subscription.api;
002
003/*-
004 * #%L
005 * HAPI FHIR Storage api
006 * %%
007 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import ca.uhn.fhir.jpa.model.entity.IPersistedResourceModifiedMessage;
024import ca.uhn.fhir.jpa.subscription.match.matcher.matching.IResourceModifiedConsumer;
025
026/**
027 * The implementer of this interface participates in the retry upon failure mechanism for messages submitted
028 * to the subscription processing pipeline.
029 */
030public interface IResourceModifiedConsumerWithRetries {
031
032        /**
033         * The implementer of this method should submit the ResourceModifiedMessage represented the IPersistedResourceModifiedMessage
034         * to a broker (see {@link IResourceModifiedConsumer}) and if submission succeeds, delete the IPersistedResourceModifiedMessage.
035         *
036         * @param thePersistedResourceModifiedMessage A IPersistedResourceModifiedMessage requiring submission.
037         * @return Whether the message was successfully submitted to the broker.
038         */
039        boolean submitPersisedResourceModifiedMessage(
040                        IPersistedResourceModifiedMessage thePersistedResourceModifiedMessage);
041}