AuditManager

All Superinterfaces:: ExtensionPointManager<AuditProfileType<?>>

All Known Implementing Classes:: DelegatingAuditManager

public interface AuditManager extends ExtensionPointManager<AuditProfileType<?>>

Method Summary

Modifier and Type

Method

Description

void

clearAuditContext()

Removes the threadlocal AuditContext

Optional<AuditContext>

getAuditContext()

Returns a populated AuditContext if the current thread is attached to a valid http session, ie a ClientReqSession (Designer, Vision) or WebUiSession (web ui since 8.3.0).

List<String>

getAvailableAuditProfiles()

Return the list of audit profiles known to this manager.

@Nullable AuditProfile

getGatewayAuditProfile()

Returns the audit profile specified by GatewaySystemProperties.GatewayAuditProfile, or null.

@Nullable AuditProfile

getProfile(String name)

Returns the named audit profile, or null if none exists with that name

@Nullable AuditProfile

getProfileForProject(String projectName)

Returns the audit profile for a given project.

void

setAuditContext(AuditContext auditContext)

Sets an threadlocal for AuditContext that will be returned by getAuditContext() on the calling thread until clearAuditContext() is invoked.

Methods inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPointManager
getExtensionPointCollection, getExtensionPointResourceType

Method Details
- getProfile
  
  @Nullable AuditProfile getProfile(String name) throws Exception
  
  Returns the named audit profile, or null if none exists with that name
  
  Throws:
  
  Exception
- getProfileForProject
  
  @Nullable AuditProfile getProfileForProject(String projectName)
  
  Returns the audit profile for a given project. May be null
- getGatewayAuditProfile
  
  @Nullable AuditProfile getGatewayAuditProfile()
  
  Returns the audit profile specified by GatewaySystemProperties.GatewayAuditProfile, or null.
- getAuditContext
  
  Optional<AuditContext> getAuditContext()
  
  Returns a populated AuditContext if the current thread is attached to a valid http session, ie a ClientReqSession (Designer, Vision) or WebUiSession (web ui since 8.3.0). Returns an empty optional if no contextual information could be found.
- setAuditContext
  
  void setAuditContext(AuditContext auditContext)
  
  Sets an threadlocal for AuditContext that will be returned by getAuditContext() on the calling thread until clearAuditContext() is invoked.
- clearAuditContext
  
  void clearAuditContext()
  
  Removes the threadlocal AuditContext
- getAvailableAuditProfiles
  
  List<String> getAvailableAuditProfiles()
  
  Return the list of audit profiles known to this manager.
  
  Since:
  
  8.0.5