Class DelegatingAuditManager
java.lang.Object
com.inductiveautomation.ignition.gateway.audit.DelegatingAuditManager
- All Implemented Interfaces:
AuditManager, ExtensionPointManager<AuditProfileType<?>>
-
Nested Class Summary
Nested classes/interfaces inherited from interface AuditManager
AuditManager.CloseableAuditContext -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidRemoves the threadlocalAuditContext.Returns a populatedAuditContextif the current thread is attached to a valid http session, ie aClientReqSession(Designer, Vision) orWebUiSession(web ui since 8.3.0).Return the list of audit profiles known to this manager.@Nullable AuditProfileReturns the audit profile specified byGatewaySystemProperties.GatewayAuditProfile, ornull.@Nullable AuditProfilegetProfile(String name) Returns the named audit profile, or null if none exists with that name@Nullable AuditProfilegetProfileForProject(String projectName) Returns the audit profile for a given project.voidsetAuditContext(AuditContext auditContext) Sets an threadlocal for AuditContext that will be returned byAuditManager.getAuditContext()on the calling thread untilAuditManager.clearAuditContext()is invoked.Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface AuditManager
pushAuditContext
-
Constructor Details
-
DelegatingAuditManager
-
-
Method Details
-
getProfile
Description copied from interface:AuditManagerReturns the named audit profile, or null if none exists with that name- Specified by:
getProfilein interfaceAuditManager- Throws:
Exception
-
getProfileForProject
Description copied from interface:AuditManagerReturns the audit profile for a given project. May be null- Specified by:
getProfileForProjectin interfaceAuditManager
-
getGatewayAuditProfile
Description copied from interface:AuditManagerReturns the audit profile specified byGatewaySystemProperties.GatewayAuditProfile, ornull.- Specified by:
getGatewayAuditProfilein interfaceAuditManager
-
getAuditContext
Description copied from interface:AuditManagerReturns a populatedAuditContextif the current thread is attached to a valid http session, ie aClientReqSession(Designer, Vision) orWebUiSession(web ui since 8.3.0). Returns an empty optional if no contextual information could be found.- Specified by:
getAuditContextin interfaceAuditManager
-
setAuditContext
Description copied from interface:AuditManagerSets an threadlocal for AuditContext that will be returned byAuditManager.getAuditContext()on the calling thread untilAuditManager.clearAuditContext()is invoked.- Specified by:
setAuditContextin interfaceAuditManager
-
clearAuditContext
public void clearAuditContext()Description copied from interface:AuditManagerRemoves the threadlocalAuditContext. Unless you are controlling the lifecycle of the thread, you should consider usingAuditManager.pushAuditContext(AuditContext)instead so that the previousAuditContextis restored after your code is done executing.- Specified by:
clearAuditContextin interfaceAuditManager- See Also:
-
getAvailableAuditProfiles
Description copied from interface:AuditManagerReturn the list of audit profiles known to this manager.- Specified by:
getAvailableAuditProfilesin interfaceAuditManager
-
getExtensionPointResourceType
- Specified by:
getExtensionPointResourceTypein interfaceExtensionPointManager<AuditProfileType<?>>
-
getExtensionPointCollection
- Specified by:
getExtensionPointCollectionin interfaceExtensionPointManager<AuditProfileType<?>>
-