Package org.linuxforhealth.fhir.audit

Interface AuditLogService

  • All Known Implementing Classes:
    KafkaService, NopService
    public interface AuditLogService
    Defines the internal FHIR Server APIs for audit logging

    • Method Detail

      • isEnabled

        boolean isEnabled()
        Returns:
        true if the audit log service is enabled; false if not enabled.

      • initialize

        void initialize​(PropertyGroup auditLogProperties)
         throws java.lang.Exception
        Performs any required audit log service initialization using the passed Properties file.
        Parameters:
        auditLogProperties - - Contains audit log related properties which are configured in fhir-server-config.json.
        Throws:
        java.lang.Exception - - Any non-recoverable exception thrown during audit log service initialization.

      • stop

        void stop​(PropertyGroup auditLogProperties)
   throws java.lang.Exception
        Performs any required audit log service stops
        Parameters:
        auditLogProperties - - Contains audit log related properties which are configured in fhir-server-config.json.
        Throws:
        java.lang.Exception - - Any non-recoverable exception thrown during audit log service initialization.

      • logEntry

        void logEntry​(AuditLogEntry logEntry)
       throws java.lang.Exception
        Persists the passed audit log entry in a location determined by the log service.
        Parameters:
        logEntry - - The audit log entry to be saved.
        Throws:
        java.lang.Exception

      • isLoggableOperation

        default boolean isLoggableOperation​(AuditLogEntry logEntry)
        Checks if the current logEntry is loggable.
        Parameters:
        logEntry -
        Returns: