Package com.i2group.disco.audit.spi

Interface IAuditLogger

All Known Implementing Classes:
NoOpAuditLogger
public interface IAuditLogger
A provider of audit logging functionality to i2 Analyze and the Information Store.

i2 Analyze calls an implementation of this interface first to determine what logging functionality is available, and then to use it. To implement the interface, override related pairs of methods. i2 Analyze only calls a log...() method when its companion is...AuditEnabled() returns true.

Unless they are explicitly overridden, all is...AuditEnabled() methods return false, and all log...() methods redirect to logDefault(IAuditEvent), which does nothing.

Since:
8.0

  • Method Details

    • isQueryAuditEnabled

      default boolean isQueryAuditEnabled()
      Indicates whether audit logging of "quick search", "expand", "find path", "geospatial search", "visual query", and "highlight query" operations is enabled.

      Note: Audit logging takes place after the operation in all cases except visual query, where it happens before the operation. For audit logging of completed visual queries, use isVisualQueryCompletedAuditEnabled().

      Returns:
      true if audit logging is enabled; false otherwise.

    • isVisualQueryCompletedAuditEnabled

      default boolean isVisualQueryCompletedAuditEnabled()
      Indicates whether audit logging of completed "visual query" operations is enabled.
      Returns:
      true if audit logging is enabled; false otherwise.

    • isRecordRetrievalAuditEnabled

      default boolean isRecordRetrievalAuditEnabled()
      Indicates whether audit logging of "record retrieval" operations is enabled when users view records in any context apart from search results.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      9.0

    • isQueryResultRecordRetrievalAuditEnabled

      default boolean isQueryResultRecordRetrievalAuditEnabled()
      Indicates whether audit logging of "record retrieval" operations is enabled when users view the results of "quick search" or "visual query" operations.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      13.5

    • isRecordUploadAuditEnabled

      @Deprecated default boolean isRecordUploadAuditEnabled()
      Deprecated.
      Use isRecordCUDAuditEnabled() instead.
      Indicates whether audit logging of "record upload" operations is enabled.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      10.0

    • isRecordCUDAuditEnabled

      default boolean isRecordCUDAuditEnabled()
      Indicates whether audit logging of "record create", "record update", and "record delete" operations is enabled.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      10.1

    • isChartCRUDAuditEnabled

      default boolean isChartCRUDAuditEnabled()
      Indicates whether audit logging of "chart create", "chart read", "chart update", "chart delete" and "chart undo delete" operations is enabled.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      11.2

    • isDAODAuditEnabled

      default boolean isDAODAuditEnabled()
      Indicates whether audit logging of "data acquisition" operations, including deleting the result sets from those operations, is enabled.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      10.2

    • isAuthenticationAuditEnabled

      default boolean isAuthenticationAuditEnabled()
      Indicates whether audit logging of "login" and "logout" operations, and users' acceptance of privacy agreements, is enabled.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      13.0

    • isChartletAuditEnabled

      default boolean isChartletAuditEnabled()
      Indicates whether audit logging of "chartlet create" and "chartlet read" operations is enabled.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      13.2

    • isSavedArtifactCRUDEnabled

      default boolean isSavedArtifactCRUDEnabled()
      Indicates whether audit logging of "saved artifact create", "saved artifact read", "saved artifact update" and "saved artifact delete" operations is enabled.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      13.3

    • isChartBinaryTransferAuditEnabled

      default boolean isChartBinaryTransferAuditEnabled()
      Indicates whether audit logging of "chart binary transfer" operations on web charts is enabled.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      13.5

    • isProvisioningAuditEnabled

      default boolean isProvisioningAuditEnabled()
      Indicates whether audit logging of "provisioning" operations for users and groups is enabled.
      Returns:
      true if audit logging is enabled; false otherwise.
      Since:
      13.3

    • logVisualQuery

      default void logVisualQuery(IVisualQueryAuditEvent auditEvent)
      Logs information about a "visual query" operation. i2 Analyze calls this method only if isQueryAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IVisualQueryAuditEvent that contains information about a "visual query" operation against the Information Store.
      Since:
      9.0

    • logVisualQueryCompleted

      default void logVisualQueryCompleted(IVisualQueryCompletedAuditEvent auditEvent)
      Logs information about a completed "visual query" operation. i2 Analyze calls this method only if isVisualQueryCompletedAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IVisualQueryCompletedAuditEvent that contains information about a completed "visual query" operation against the Information Store.
      Since:
      13.3

    • logFindPath

      default void logFindPath(IFindPathAuditEvent auditEvent)
      Logs information about a "find path" operation. i2 Analyze calls this method only if isQueryAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IFindPathAuditEvent that contains information about a "find path" operation against the Information Store.
      Since:
      9.2

    • logQuickSearch

      default void logQuickSearch(IQuickSearchAuditEvent auditEvent)
      Logs information about a "quick search" operation. i2 Analyze calls this method only if isQueryAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IQuickSearchAuditEvent that contains information about a "quick search" operation against the Information Store.

    • logHighlightQuery

      default void logHighlightQuery(IHighlightQueryShowMoreAuditEvent auditEvent)
      Logs information about a "highlight query show more" operation. i2 Analyze calls this method only if isQueryAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IHighlightQueryShowMoreAuditEvent that contains information about a "highlight query show more" operation against the Information Store.
      Since:
      11.1

    • logGeospatialSearch

      default void logGeospatialSearch(IGeospatialSearchAuditEvent auditEvent)
      Logs information about a "geospatial search" operation. i2 Analyze calls this method only if isQueryAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IGeospatialSearchAuditEvent that contains information about a "geospatial search" operation against the Information Store.
      Since:
      11.0

    • logExpand

      default void logExpand(IExpandAuditEvent auditEvent)
      Logs information about an "expand" operation. i2 Analyze calls this method only if isQueryAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IExpandAuditEvent that contains information about an "expand" operation against the Information Store.

    • logRecordRetrieval

      default void logRecordRetrieval(IRecordRetrievalAuditEvent auditEvent)
      Logs information about a "record retrieval" operation. i2 Analyze calls this method if isRecordRetrievalAuditEnabled() or isQueryResultRecordRetrievalAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IRecordRetrievalAuditEvent that contains information about a "record retrieval" operation against the Information Store.
      Since:
      9.0

    • logRecordDelete

      default void logRecordDelete(IRecordDeleteAuditEvent auditEvent)
      Logs information about a "record delete" operation. i2 Analyze calls this method only if isRecordCUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IRecordDeleteAuditEvent that contains information about a "record delete" operation against the Information Store.
      Since:
      10.1

    • logRecordUpload

      default void logRecordUpload(IRecordUploadAuditEvent auditEvent)
      Logs information about a "record create" or "record update" operation. i2 Analyze calls this method only if isRecordCUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IRecordUploadAuditEvent that contains information about a "record create" or "record update" operation against the Information Store.
      Since:
      10.0

    • logChartCreate

      default void logChartCreate(IChartCreateAuditEvent auditEvent)
      Logs information about a "chart create" operation. i2 Analyze calls this method only if isChartCRUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IChartCreateAuditEvent that contains information about a "chart create" operation against the Information Store.
      Since:
      11.2

    • logChartRead

      @Deprecated default void logChartRead(IChartReadAuditEvent auditEvent)
      Deprecated.
      Use logChartBinaryRead(IChartReadAuditEvent) to log information about "chart binary read" operations and logChartImageRead(IChartReadAuditEvent) to log information about "chart image read" operations.
      Logs information about a "chart read" operation. i2 Analyze calls this method only if isChartCRUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IChartReadAuditEvent that contains information about a "chart read" operation against the Information Store.
      Since:
      11.2

    • logChartBinaryRead

      default void logChartBinaryRead(IChartReadAuditEvent auditEvent)
      Logs information about a "chart binary read" operation. i2 Analyze calls this method only if isChartCRUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IChartReadAuditEvent that contains information about a "chart read" operation against the Information Store.
      Since:
      13.5

    • logChartImageRead

      default void logChartImageRead(IChartReadAuditEvent auditEvent)
      Logs information about a "chart image read" operation. i2 Analyze calls this method only if isChartCRUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IChartReadAuditEvent that contains information about a "chart read" operation against the Information Store.
      Since:
      13.5

    • logChartUpdate

      default void logChartUpdate(IChartUpdateAuditEvent auditEvent)
      Logs information about a "chart update" operation. i2 Analyze calls this method only if isChartCRUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IChartUpdateAuditEvent that contains information about a "chart update" operation against the Information Store.
      Since:
      11.2

    • logChartDelete

      default void logChartDelete(IChartDeleteAuditEvent auditEvent)
      Logs information about a "chart delete" operation. i2 Analyze calls this method only if isChartCRUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IChartDeleteAuditEvent that contains information about a "chart delete" operation against the Information Store.
      Since:
      11.2

    • logChartUndoDelete

      default void logChartUndoDelete(IChartUndoDeleteAuditEvent auditEvent)
      Logs information about a "chart undo delete" operation. i2 Analyze calls this method only if isChartCRUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IChartUndoDeleteAuditEvent that contains information about a "chart undo delete" operation against the Information Store.
      Since:
      12.1

    • logChartVersionRead

      default void logChartVersionRead(IChartVersionReadAuditEvent auditEvent)
      Logs information about a "chart version read" operation. i2 Analyze calls this method only if isChartCRUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IChartVersionReadAuditEvent that contains information about a "chart version read" operation against the Information Store.
      Since:
      11.2

    • logChartVersionDelete

      default void logChartVersionDelete(IChartVersionDeleteAuditEvent auditEvent)
      Logs information about a "chart version delete" operation. i2 Analyze calls this method only if isChartCRUDAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IChartVersionDeleteAuditEvent that contains information about a "chart version delete" operation against the Information Store.
      Since:
      11.2

    • logDAODEvent

      default void logDAODEvent(IDAODAuditEvent auditEvent)
      Logs information about a "data acquisition" operation, which includes a visual query operation against an external source. i2 Analyze calls this method only if isDAODAuditEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IDAODAuditEvent that contains information about a "data acquisition" operation.
      Since:
      10.2

    • logLoginEvent

      default void logLoginEvent(ILoginAuditEvent auditEvent)
      Logs information about a "login" operation. i2 Analyze calls this method only if isAuthenticationAuditEnabled() returns true.
      Parameters:
      auditEvent - An ILoginAuditEvent that contains information about a "login" operation.
      Since:
      13.0

    • logLogoutEvent

      default void logLogoutEvent(ILogoutAuditEvent auditEvent)
      Logs information about a "logout" operation. i2 Analyze calls this method only if isAuthenticationAuditEnabled() returns true.
      Parameters:
      auditEvent - An ILogoutAuditEvent that contains information about a "logout" operation.
      Since:
      13.0

    • logPrivacyAgreementEvent

      default void logPrivacyAgreementEvent(IPrivacyAgreementAuditEvent auditEvent)
      Logs information about user acceptance of a privacy agreement. i2 Analyze calls this method only if isAuthenticationAuditEnabled() returns true.
      Parameters:
      auditEvent - An IPrivacyAgreementAuditEvent that contains information about user acceptance of a privacy agreement.
      Since:
      13.0

    • logDAODResultSetsDeleteEvent

      default void logDAODResultSetsDeleteEvent(IDAODResultSetsDeleteAuditEvent auditEvent)
      Logs information about the deletion of result sets from "data acquisition" operations. i2 Analyze calls this method only if isDAODAuditEnabled() returns true.
      Parameters:
      auditEvent - An IDAODResultSetsDeleteAuditEvent that contains information about the deletion of the result sets.
      Since:
      13.1

    • logChartletCreate

      default void logChartletCreate(IChartletAuditEvent auditEvent)
      Logs information about a "chartlet create" operation. i2 Analyze calls this method only if isChartletAuditEnabled() returns true.

      A chartlet is created when a user of an i2 Analyze client application shares records with other users.

      Parameters:
      auditEvent - An IChartletAuditEvent that contains information about a "chartlet create" operation.
      Since:
      13.2

    • logChartletRead

      default void logChartletRead(IChartletAuditEvent auditEvent)
      Logs information about a "chartlet read" operation. i2 Analyze calls this method only if isChartletAuditEnabled() returns true.

      A chartlet is read when a user of an i2 Analyze client application navigates to the records that another user has shared.

      Parameters:
      auditEvent - An IChartletAuditEvent that contains information about a "chartlet read" operation.
      Since:
      13.2

    • logSavedArtifactCreate

      default void logSavedArtifactCreate(ISavedArtifactCreateAuditEvent auditEvent)
      Logs information about a "saved artifact create" operation. i2 Analyze calls this method only if isSavedArtifactCRUDEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An ISavedArtifactCreateAuditEvent that contains information about a "saved artifact create" operation.
      Since:
      13.3

    • logSavedArtifactRead

      default void logSavedArtifactRead(ISavedArtifactReadAuditEvent auditEvent)
      Logs information about a "saved artifact read" operation. i2 Analyze calls this method only if isSavedArtifactCRUDEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An ISavedArtifactReadAuditEvent that contains information about a "saved artifact read" operation.
      Since:
      13.3

    • logSavedArtifactUpdate

      default void logSavedArtifactUpdate(ISavedArtifactUpdateAuditEvent auditEvent)
      Logs information about a "saved artifact update" operation. i2 Analyze calls this method only if isSavedArtifactCRUDEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An ISavedArtifactUpdateAuditEvent that contains information about a "saved artifact update" operation.
      Since:
      13.3

    • logSavedArtifactDelete

      default void logSavedArtifactDelete(ISavedArtifactDeleteAuditEvent auditEvent)
      Logs information about a "saved artifact delete" operation. i2 Analyze calls this method only if isSavedArtifactCRUDEnabled() returns true.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An ISavedArtifactDeleteAuditEvent that contains information about a "saved artifact delete" operation.
      Since:
      13.3

    • logProvisioningUserAdd

      default void logProvisioningUserAdd(IUserAddAuditEvent auditEvent)
      Logs information about an "add user" provisioning operation. i2 Analyze calls this method only if isProvisioningAuditEnabled() returns true.
      Parameters:
      auditEvent - An IUserAddAuditEvent that contains information about an "add user" provisioning operation.
      Since:
      13.3

    • logProvisioningUserRemove

      default void logProvisioningUserRemove(IUserRemoveAuditEvent auditEvent)
      Logs information about a "remove user" provisioning operation. i2 Analyze calls this method only if isProvisioningAuditEnabled() returns true.
      Parameters:
      auditEvent - An IUserRemoveAuditEvent that contains information about a "remove user" provisioning operation.
      Since:
      13.3

    • logProvisioningUserRestore

      default void logProvisioningUserRestore(IUserRestoreAuditEvent auditEvent)
      Logs information about a "restore user" provisioning operation. i2 Analyze calls this method only if isProvisioningAuditEnabled() returns true.
      Parameters:
      auditEvent - An IUserRestoreAuditEvent that contains information about a "restore user" provisioning operation.
      Since:
      13.3

    • logProvisioningUserUpdate

      default void logProvisioningUserUpdate(IUserUpdateAuditEvent auditEvent)
      Logs information about an "update user" provisioning operation. i2 Analyze calls this method only if isProvisioningAuditEnabled() returns true.
      Parameters:
      auditEvent - An IUserUpdateAuditEvent that contains information about an "update user" provisioning operation.
      Since:
      13.3

    • logProvisioningGroupAdd

      default void logProvisioningGroupAdd(IGroupAddAuditEvent auditEvent)
      Logs information about an "add group" provisioning operation. i2 Analyze calls this method only if isProvisioningAuditEnabled() returns true.
      Parameters:
      auditEvent - An IGroupAddAuditEvent that contains information about an "add group" provisioning operation.
      Since:
      13.3

    • logProvisioningGroupRemove

      default void logProvisioningGroupRemove(IGroupRemoveAuditEvent auditEvent)
      Logs information about a "remove group" provisioning operation. i2 Analyze calls this method only if isProvisioningAuditEnabled() returns true.
      Parameters:
      auditEvent - An IGroupRemoveAuditEvent that contains information about a "remove group" provisioning operation.
      Since:
      13.3

    • logProvisioningGroupRestore

      default void logProvisioningGroupRestore(IGroupRestoreAuditEvent auditEvent)
      Logs information about a "restore group" provisioning operation. i2 Analyze calls this method only if isProvisioningAuditEnabled() returns true.
      Parameters:
      auditEvent - An IGroupRestoreAuditEvent that contains information about a "restore group" provisioning operation.
      Since:
      13.3

    • logProvisioningGroupUpdate

      default void logProvisioningGroupUpdate(IGroupUpdateAuditEvent auditEvent)
      Logs information about an "update group" provisioning operation. i2 Analyze calls this method only if isProvisioningAuditEnabled() returns true.
      Parameters:
      auditEvent - An IGroupUpdateAuditEvent that contains information about an "update group" provisioning operation.
      Since:
      13.3

    • logChartBinaryTransfer

      default void logChartBinaryTransfer(IChartBinaryTransferAuditEvent auditEvent)
      Logs information about a "chart binary transfer" operation. i2 Analyze calls this method only if isChartBinaryTransferAuditEnabled() returns true.
      Parameters:
      auditEvent - An IChartBinaryTransferAuditEvent that contains information about a "chart binary transfer" operation.
      Since:
      13.5

    • logDefault

      default void logDefault(IAuditEvent auditEvent)
      Logs information about an operation when auditing is enabled and a more specific method has not been overridden. i2 Analyze calls this method if an is...AuditEnabled() method returns true but its companion log...() method is not implemented. The exception is for missing implementations of logLogoutEvent(ILogoutAuditEvent), which do not result in a call to this method.

      Note: All implementations of this method must be thread safe.

      Parameters:
      auditEvent - An IAuditEvent that contains information about an operation against i2 Analyze or the Information Store.