AuditingContext

All Known Subinterfaces:

BindingContext, Component, InternalSession, Page, PerspectiveElement, Session, View

All Known Implementing Classes:

AbstractBindingHarness, AbstractSession, ComponentModel, DesignerComponentModel, DesignerPageModel, DesignerViewModel, ElementBindingHarness, PageModel, PerspectiveDesignSession, PerspectiveProjectSession, SecuredPerspectiveProjectSession, SessionKernelWrapper, ViewModel
```
public interface AuditingContext
```
Context in which an audit log record may be written

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`audit(java.lang.String actionName, java.lang.String actionTarget, java.lang.String actionValue)`	Create a new audit log record if an audit profile is set in this context
`java.util.Optional<AuditProfile>`	`getAuditProfile()`
`AuditContext.Builder`	`getAuditSnapshot()`

- Method Detail
  - getAuditSnapshot
```
@Nonnull
AuditContext.Builder getAuditSnapshot()
```
    Returns:
    
    A new, or extended, AuditContext.Builder, with qualified information about the current scope.
  - getAuditProfile
```
@Nonnull
java.util.Optional<AuditProfile> getAuditProfile()
```
    Returns:
    
    an Optional containing the AuditProfile for this context or an empty Optional if no audit profile is set
  - audit
```
default void audit(java.lang.String actionName,
                   java.lang.String actionTarget,
                   java.lang.String actionValue)
```
    Create a new audit log record if an audit profile is set in this context
    
    Parameters:
    
    actionName - the audited action's name
    
    actionTarget - the audited action's target
    
    actionValue - the audited action's value