Package com.i2group.disco.audit

Interface IWebChartSharingChangeAuditEvent

All Superinterfaces:

IAuditEvent

public interface IWebChartSharingChangeAuditEvent
extends IAuditEvent

An event that was generated when a web chart's sharing permissions or identifying metadata (name, description, owner) changed. IWebChartSharingChangeAuditEvent makes information about the operation available to the audit logging mechanism.

One event type covers all three WebChartChangeTypes, and which accessors return a present value depends on the type:

• WebChartChangeType.SHARING populates exactly the old/new pair(s) for the fields the PATCH actually changed (comparing sharing permissions by subject-to-access-level assignment, not list order), and leaves every other pair empty. The one exception is getDescription() / getOldDescription(): because a chart's description is itself optional, a description that changed to absent reports an empty getDescription() with a populated getOldDescription() — the same shape as a field that did not change at all. Callers that need to distinguish the two must compare getOldDescription() against getDescription() rather than testing getDescription() alone.
• WebChartChangeType.NAME populates only getName() and getOldName().
• WebChartChangeType.METADATA leaves every accessor below empty, regardless of which underlying fields an editChartMetadata action actually changed: per define-chart-audit-granularity, a metadata change is audited as a single category, not per-field, so getChangeType() returning METADATA is itself the only signal this event type carries.

Since:

13.8

Method Summary

Modifier and Type	Method	Description
Optional<List<IAccessControl>>	getAccessControl()	Gets the web chart's access control list after the change, if this change modified it.
WebChartChangeType	getChangeType()	Gets the WebChartChangeType that generated this event.
String	getChartId()	Gets the identifier of the web chart session that changed.
Optional<String>	getDescription()	Gets the web chart's description after the change, if this change modified it and the description is present.
Optional<String>	getLocation()	Gets the web chart's sharing location ("path") after the change, if this change modified it.
Optional<String>	getName()	Gets the web chart's name after the change, if this change modified it.
Optional<List<IAccessControl>>	getOldAccessControl()	Gets the web chart's access control list before the change, if this change modified it.
Optional<String>	getOldDescription()	Gets the web chart's description before the change, if this change modified it.
Optional<String>	getOldLocation()	Gets the web chart's sharing location ("path") before the change, if this change modified it.
Optional<String>	getOldName()	Gets the web chart's name before the change, if this change modified it.

Methods inherited from interface com.i2group.disco.audit.IAuditEvent

getClientIPAddress, getClientUserAgent, getTimestamp, getUser, getUserId, getUserSecurityGroups, getUserSecurityPermissions, toString

Method Details

getChartId

String getChartId()

Gets the identifier of the web chart session that changed.

Returns:

See above.

getChangeType

WebChartChangeType getChangeType()

Gets the WebChartChangeType that generated this event.

Returns:

See above.

getName

Optional<String> getName()

Gets the web chart's name after the change, if this change modified it.

Returns:

See above.

getOldName

Optional<String> getOldName()

Gets the web chart's name before the change, if this change modified it.

Returns:

See above.

getDescription

Optional<String> getDescription()

Gets the web chart's description after the change, if this change modified it and the description is present.

An empty Optional is ambiguous by itself: it is returned both when this change did not touch the description, and when it changed the description to absent. Compare against getOldDescription() to tell the two apart — see the class-level note.

Returns:

See above.

getOldDescription

Optional<String> getOldDescription()

Gets the web chart's description before the change, if this change modified it.

Returns:

See above.

getLocation

Optional<String> getLocation()

Gets the web chart's sharing location ("path") after the change, if this change modified it.

Returns:

See above.

getOldLocation

Optional<String> getOldLocation()

Gets the web chart's sharing location ("path") before the change, if this change modified it.

Returns:

See above.

getAccessControl

Optional<List<IAccessControl>> getAccessControl()

Gets the web chart's access control list after the change, if this change modified it.

Returns:

See above.

getOldAccessControl

Optional<List<IAccessControl>> getOldAccessControl()

Gets the web chart's access control list before the change, if this change modified it.

Returns:

See above.