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.triggering;
021
022import ca.uhn.fhir.rest.api.server.RequestDetails;
023import jakarta.annotation.Nullable;
024import org.hl7.fhir.instance.model.api.IBaseParameters;
025import org.hl7.fhir.instance.model.api.IIdType;
026import org.hl7.fhir.instance.model.api.IPrimitiveType;
027
028import java.util.List;
029
030public interface ISubscriptionTriggeringSvc {
031
032        IBaseParameters triggerSubscription(
033                        @Nullable List<IPrimitiveType<String>> theResourceIds,
034                        @Nullable List<IPrimitiveType<String>> theSearchUrls,
035                        @Nullable IIdType theSubscriptionId,
036                        RequestDetails theRequestDetails);
037
038        @Deprecated(forRemoval = true)
039        /**
040         * Use {@link ISubscriptionTriggeringSvc#triggerSubscription(List, List, IIdType, RequestDetails)} instead.
041         * This implementation uses a SystemRequestDetails for All Partitions, as the previous behaviour did.
042         */
043        IBaseParameters triggerSubscription(
044                        @Nullable List<IPrimitiveType<String>> theResourceIds,
045                        @Nullable List<IPrimitiveType<String>> theSearchUrls,
046                        @Nullable IIdType theSubscriptionId);
047
048        void runDeliveryPass();
049}