Package com.inductiveautomation.ignition.gateway.audit

Class DelegatingAuditManager

java.lang.Object

com.inductiveautomation.ignition.gateway.audit.DelegatingAuditManager

All Implemented Interfaces:

AuditManager, ExtensionPointManager<AuditProfileType<?>>

public class DelegatingAuditManager
extends Object
implements AuditManager

Constructor Summary

Constructors

Constructor	Description
DelegatingAuditManager(AuditManager delegate)

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.
ExtensionPointCollection<AuditProfileType<?>>	getExtensionPointCollection()
ResourceType	getExtensionPointResourceType()
@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 AuditManager.getAuditContext() on the calling thread until AuditManager.clearAuditContext() is invoked.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DelegatingAuditManager

public DelegatingAuditManager(AuditManager delegate)

Method Details

getProfile

public @Nullable AuditProfile getProfile(String name)
                                  throws Exception

Description copied from interface: AuditManager

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

Specified by:

getProfile in interface AuditManager

Throws:

Exception

getProfileForProject

public @Nullable AuditProfile getProfileForProject(String projectName)

Description copied from interface: AuditManager

Returns the audit profile for a given project. May be null

Specified by:

getProfileForProject in interface AuditManager

getGatewayAuditProfile

public @Nullable AuditProfile getGatewayAuditProfile()

Description copied from interface: AuditManager

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

Specified by:

getGatewayAuditProfile in interface AuditManager

getAuditContext

public Optional<AuditContext> getAuditContext()

Description copied from interface: AuditManager

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.

Specified by:

getAuditContext in interface AuditManager

setAuditContext

public void setAuditContext(AuditContext auditContext)

Description copied from interface: AuditManager

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

Specified by:

setAuditContext in interface AuditManager

clearAuditContext

public void clearAuditContext()

Description copied from interface: AuditManager

Removes the threadlocal AuditContext

Specified by:

clearAuditContext in interface AuditManager

getAvailableAuditProfiles

public List<String> getAvailableAuditProfiles()

Description copied from interface: AuditManager

Return the list of audit profiles known to this manager.

Specified by:

getAvailableAuditProfiles in interface AuditManager

getExtensionPointResourceType

public ResourceType getExtensionPointResourceType()

Specified by:

getExtensionPointResourceType in interface ExtensionPointManager<AuditProfileType<?>>

getExtensionPointCollection

public ExtensionPointCollection<AuditProfileType<?>> getExtensionPointCollection()

Specified by:

getExtensionPointCollection in interface ExtensionPointManager<AuditProfileType<?>>