ca.uhn.fhir.subscription.api.IResourceModifiedMessagePersistenceSvc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-storage Show documentation
This project provides services useful for fhir repository storage. Actual repository storage services are not in this project, just the api and helper libraries.
The newest version!
package ca.uhn.fhir.subscription.api;

/*-
 * #%L
 * HAPI FHIR Storage api
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import ca.uhn.fhir.jpa.model.entity.IPersistedResourceModifiedMessage;
import ca.uhn.fhir.jpa.model.entity.IPersistedResourceModifiedMessagePK;
import ca.uhn.fhir.jpa.subscription.model.ResourceModifiedMessage;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;

import java.util.Optional;

/**
 * An implementer of this interface will provide {@link ResourceModifiedMessage} persistence services.
 *
 * Client of this interface should persist ResourceModifiedMessage as part of the processing of an operation on
 * a resource.  Upon a successful submission to the subscription pipeline, the persisted message should be deleted.
 * When submission fails, the message should be left un-altered for re-submission at a later time (see {@link IResourceModifiedConsumerWithRetries}).
 */
public interface IResourceModifiedMessagePersistenceSvc {

	/**
	 * Find all persistedResourceModifiedMessage sorted by ascending created dates (oldest to newest).
	 * @param thePageable Page request
	 * @return A sorted list of persistedResourceModifiedMessage needing submission.
	 */
	Page findAllOrderedByCreatedTime(Pageable thePageable);

	/**
	 * Delete a persistedResourceModifiedMessage by its primary key.
	 *
	 * @param thePersistedResourceModifiedMessagePK The primary key of the persistedResourceModifiedMessage to delete.
	 * @return Whether the persistedResourceModifiedMessage pointed to by theResourceModifiedPK was deleted.
	 */
	boolean deleteByPK(IPersistedResourceModifiedMessagePK thePersistedResourceModifiedMessagePK);

	/**
	 * Persist a resourceModifiedMessage and return its resulting persisted representation.
	 *
	 * @param theMsg The resourceModifiedMessage to persist.
	 * @return The persisted representation of theMsg.
	 */
	IPersistedResourceModifiedMessage persist(ResourceModifiedMessage theMsg);

	/**
	 * Restore a resourceModifiedMessage to its pre persistence representation.
	 *
	 * @param theResourceModifiedMessage The message needing restoration.
	 * @return The resourceModifiedMessage in its pre persistence form.
	 */
	ResourceModifiedMessage inflatePersistedResourceModifiedMessage(ResourceModifiedMessage theResourceModifiedMessage);

	/**
	 * Restore a resourceModifiedMessage to its pre persistence representation or null if the resource does not exist.
	 *
	 * @param theResourceModifiedMessage
	 * @return An Optional containing The resourceModifiedMessage in its pre persistence form or null when the resource
	 * does not exist
	 */
	Optional inflatePersistedResourceModifiedMessageOrNull(
			ResourceModifiedMessage theResourceModifiedMessage);

	/**
	 * Create a ResourceModifiedMessage without its pre persistence representation, i.e. without the resource body in
	 * payload
	 *
	 * @param thePersistedResourceModifiedMessage The message needing creation
	 * @return The resourceModifiedMessage without its pre persistence form
	 */
	ResourceModifiedMessage createResourceModifiedMessageFromEntityWithoutInflation(
			IPersistedResourceModifiedMessage thePersistedResourceModifiedMessage);

	/**
	 *
	 * @return the number of persisted resourceModifiedMessage.
	 */
	long getMessagePersistedCount();
}