Interface IAuditEvent

All Known Subinterfaces:
IChartCreateAuditEvent, IChartDeleteAuditEvent, IChartletAuditEvent, IChartReadAuditEvent, IChartUndoDeleteAuditEvent, IChartUpdateAuditEvent, IChartVersionDeleteAuditEvent, IChartVersionReadAuditEvent, IDAODAuditEvent, IDAODResultSetsDeleteAuditEvent, IExpandAuditEvent, IFindPathAuditEvent, IGeospatialSearchAuditEvent, IGroupAddAuditEvent, IGroupRemoveAuditEvent, IGroupRestoreAuditEvent, IGroupUpdateAuditEvent, IHighlightQueryShowMoreAuditEvent, ILoginAuditEvent, IPrivacyAgreementAuditEvent, IQuickSearchAuditEvent, IRecordDeleteAuditEvent, IRecordRetrievalAuditEvent, IRecordUploadAuditEvent, ISavedArtifactCreateAuditEvent, ISavedArtifactDeleteAuditEvent, ISavedArtifactReadAuditEvent, ISavedArtifactUpdateAuditEvent, IUserAddAuditEvent, IUserRemoveAuditEvent, IUserRestoreAuditEvent, IUserUpdateAuditEvent, IVisualQueryAuditEvent, IVisualQueryCompletedAuditEvent

public interface IAuditEvent
An event that was generated during the processing of an operation against the Information Store. IAuditEvent makes information about the operation available to the audit logging mechanism.
Since:
8.0
  • Method Details

    • getTimestamp

      Instant getTimestamp()
      Gets the UTC Instant when this IAuditEvent was generated.
      Returns:
      See above.
    • toString

      String toString()
      Returns a String representation of this IAuditEvent.
      Overrides:
      toString in class Object
      Returns:
      See above.
    • getUserId

      String getUserId()
      Gets a String that contains the unique identifier of the user who performed the operation that generated this IAuditEvent.
      Returns:
      See above.
      Since:
      13.3
    • getUser

      String getUser()
      Gets a String that contains the name of the user who performed the operation that generated this IAuditEvent.
      Returns:
      See above.
    • getUserSecurityGroups

      Set<String> getUserSecurityGroups()
      Gets Strings that contain the names of the security groups to which the user returned by getUser() belongs.
      Returns:
      See above.
    • getUserSecurityPermissions

      Collection<Permissions> getUserSecurityPermissions()
      Gets the Permissions in each security dimension of the user returned by getUser().
      Returns:
      See above.
    • getClientUserAgent

      String getClientUserAgent()
      Gets a String that contains information about the user agent through which the operation that generated this IAuditEvent was performed.
      Returns:
      See above. If no user agent was provided, the string is empty.
    • getClientIPAddress

      String getClientIPAddress()
      Gets a String that contains the IP address of the client on which the operation that generated this IAuditEvent was performed.
      Returns:
      See above.