Package com.i2group.disco.audit

Interface IAuditEvent

All Known Subinterfaces:

IChartCreateAuditEvent, IChartDeleteAuditEvent, IChartletAuditEvent, IChartReadAuditEvent, IChartUndoDeleteAuditEvent, IChartUpdateAuditEvent, IChartVersionDeleteAuditEvent, IChartVersionReadAuditEvent, IDAODAuditEvent, IDAODResultSetsDeleteAuditEvent, IExpandAuditEvent, IFindPathAuditEvent, IGeospatialSearchAuditEvent, IHighlightQueryShowMoreAuditEvent, ILoginAuditEvent, IPrivacyAgreementAuditEvent, IQuickSearchAuditEvent, IRecordDeleteAuditEvent, IRecordRetrievalAuditEvent, IRecordUploadAuditEvent, IVisualQueryAuditEvent

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 Summary

Modifier and Type	Method	Description
String	getClientIPAddress()	Gets a String that contains the IP address of the client on which the operation that generated this IAuditEvent was performed.
String	getClientUserAgent()	Gets a String that contains information about the user agent through which the operation that generated this IAuditEvent was performed.
Instant	getTimestamp()	Gets the UTC Instant when this IAuditEvent was generated.
String	getUser()	Gets a String that contains the name of the user who performed the operation that generated this IAuditEvent.
Set<String>	getUserSecurityGroups()	Gets Strings that contain the names of the security groups to which the user returned by getUser() belongs.
Collection<Permissions>	getUserSecurityPermissions()	Gets the Permissions in each security dimension of the user returned by getUser().
String	toString()	Returns a String representation of this IAuditEvent.

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.

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.