Interface OMRSAuditLogStore

  • All Known Implementing Classes:
    OMRSAuditLogStoreConnectorBase

    public interface OMRSAuditLogStore
    OMRSAuditLogStore is the specialized data API for an Audit Log destination connector.
    • Method Detail

      • getDestinationName

        java.lang.String getDestinationName()
        Return the name of this audit log destination.
        Returns:
        string display name suitable for messages.
      • getSupportedSeverities

        java.util.List<java.lang.String> getSupportedSeverities()
        Return the list of supported severities that this destination is configured to support.
        Returns:
        list of severity names (see OMRSAuditLogRecordSeverity)
      • storeLogRecord

        java.lang.String storeLogRecord​(OMRSAuditLogRecord logRecord)
                                 throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Store the audit log record in the audit log store.
        Parameters:
        logRecord - log record to store
        Returns:
        unique identifier assigned to the log record
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - indicates that the logRecord parameter is invalid.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - indicates that the audit log store is not available or has an error.
      • getAuditLogRecord

        OMRSAuditLogRecord getAuditLogRecord​(java.lang.String logRecordId)
                                      throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                             org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException,
                                             org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Retrieve a specific audit log record.
        Parameters:
        logRecordId - unique identifier for the log record
        Returns:
        requested audit log record
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - indicates that the logRecordId parameter is invalid.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException - indicates that the audit log store does not support queries.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - indicates that the audit log store is not available or has an error.
      • getAuditLogRecordsByTimeStamp

        java.util.List<OMRSAuditLogRecord> getAuditLogRecordsByTimeStamp​(java.util.Date startDate,
                                                                         java.util.Date endDate,
                                                                         int offset,
                                                                         int maximumRecords)
                                                                  throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                                                         org.odpi.openmetadata.repositoryservices.ffdc.exception.PagingErrorException,
                                                                         org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException,
                                                                         org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Retrieve a list of log records written in a specified time period. The offset and maximumRecords parameters support a paging
        Parameters:
        startDate - start of time period
        endDate - end of time period
        offset - offset of full collection to begin the return results
        maximumRecords - maximum number of log records to return
        Returns:
        list of log records from the specified time period
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - indicates that the start and/or end date parameters are invalid.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PagingErrorException - indicates that the offset or the maximumRecords parameters are invalid.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException - indicates that the audit log store does not support queries.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - indicates that the audit log store is not available or has an error.
      • getAuditLogRecordsBySeverity

        java.util.List<OMRSAuditLogRecord> getAuditLogRecordsBySeverity​(java.lang.String severity,
                                                                        java.util.Date startDate,
                                                                        java.util.Date endDate,
                                                                        int offset,
                                                                        int maximumRecords)
                                                                 throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                                                        org.odpi.openmetadata.repositoryservices.ffdc.exception.PagingErrorException,
                                                                        org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException,
                                                                        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Retrieve a list of log records that have specific severity. The offset and maximumRecords parameters support a paging model.
        Parameters:
        severity - the severity value of messages to return
        startDate - start of time period
        endDate - end of time period
        offset - offset of full collection to begin the return results
        maximumRecords - maximum number of log records to return
        Returns:
        list of log records from the specified time period
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - indicates that the severity, start and/or end date parameters are invalid.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PagingErrorException - indicates that the offset or the maximumRecords parameters are invalid.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException - indicates that the audit log store does not support queries.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - indicates that the audit log store is not available or has an error.
      • getAuditLogRecordsByComponent

        java.util.List<OMRSAuditLogRecord> getAuditLogRecordsByComponent​(java.lang.String component,
                                                                         java.util.Date startDate,
                                                                         java.util.Date endDate,
                                                                         int offset,
                                                                         int maximumRecords)
                                                                  throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                                                         org.odpi.openmetadata.repositoryservices.ffdc.exception.PagingErrorException,
                                                                         org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException,
                                                                         org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Retrieve a list of log records written by a specific component. The offset and maximumRecords parameters support a paging model.
        Parameters:
        component - name of the component to retrieve events from
        startDate - start of time period
        endDate - end of time period
        offset - offset of full collection to begin the return results
        maximumRecords - maximum number of log records to return
        Returns:
        list of log records from the specified time period
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - indicates that the component, start and/or end date parameters are invalid.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PagingErrorException - indicates that the offset or the maximumRecords parameters are invalid.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException - indicates that the audit log store does not support queries.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - indicates that the audit log store is not available or has an error.