Package com.ibm.fhir.persistence.interceptor

Interface FHIRPersistenceInterceptor

  • All Known Implementing Classes:
    AuthzPolicyEnforcementPersistenceInterceptor, FHIRNotificationService, ServerRegistryResourceProvider
    public interface FHIRPersistenceInterceptor
    This interface describes a persistence interceptor. Persistence interceptors are invoked by the FHIR Server to allow users to inject business logic into the REST API processing flow. To make use of this interceptor, develop a class that implements this interface, then store your implementation class name in a file called META-INF/services/com.ibm.fhir.persistence.FHIRPersistenceInterceptor within your jar file.

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default void afterCreate​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'create' REST API invocation, immediately after the new resource has been stored by the persistence layer.
      default void afterDelete​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'delete' REST API invocation, immediately after the resource has been deleted by the persistence layer.
      default void afterHistory​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'history' REST API invocation, immediately after the resource's history has been read by the persistence layer.
      default void afterPatch​(FHIRPersistenceEvent event)
      This method is called during the processing of an 'patch' REST API invocation, immediately after the updated resource has been stored by the persistence layer.
      default void afterRead​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'read' REST API invocation, immediately after the resource has been read by the persistence layer.
      default void afterSearch​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'search' REST API invocation, immediately after the search has been performed by the persistence layer.
      default void afterUpdate​(FHIRPersistenceEvent event)
      This method is called during the processing of an 'update' REST API invocation, immediately after the updated resource has been stored by the persistence layer.
      default void afterVread​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'vread' REST API invocation, immediately after the resource has been read by the persistence layer.
      default void beforeCreate​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'create' REST API invocation, immediately before the new resource is stored by the persistence layer.
      default void beforeDelete​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'delete' REST API invocation, immediately before the resource is deleted by the persistence layer.
      default void beforeHistory​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'history' REST API invocation, immediately before the resource's history is read by the persistence layer.
      default void beforePatch​(FHIRPersistenceEvent event)
      This method is called during the processing of an 'patch' REST API invocation, immediately before the updated resource is stored by the persistence layer.
      default void beforeRead​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'read' REST API invocation, immediately before the resource is read by the persistence layer.
      default void beforeSearch​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'search' REST API invocation, immediately before the search is performed by the persistence layer.
      default void beforeUpdate​(FHIRPersistenceEvent event)
      This method is called during the processing of an 'update' REST API invocation, immediately before the updated resource is stored by the persistence layer.
      default void beforeVread​(FHIRPersistenceEvent event)
      This method is called during the processing of a 'vread' (versioned read) REST API invocation, immediately before the resource is read by the persistence layer.