Package com.inductiveautomation.ignition.gateway.audit

Class DelegatingAuditManager

java.lang.Object

com.inductiveautomation.ignition.gateway.audit.DelegatingAuditManager

All Implemented Interfaces:

AuditManager, ExtensionPointManager

public class DelegatingAuditManager
extends java.lang.Object
implements AuditManager

Constructor Summary

Constructors

Constructor	Description
DelegatingAuditManager(AuditManager delegate)

Method Summary

Modifier and Type	Method	Description
void	addAuditProfileType(AuditProfileType type)	Adds a new type of audit profile to the system.
void	clearAuditContext()	Removes the threadlocal AuditContext
java.util.Optional<AuditContext>	getAuditContext()	Returns a populated AuditContext if the current thread is attached to a valid http session, ie a ClientReqSession or IgnitionSession.
java.util.List<java.lang.String>	getAvailableAuditProfiles()	Return the list of audit profiles known to this manager.
ExtensionPointType	getExtensionPoint(java.lang.String typeId)
java.util.List<? extends ExtensionPointType>	getExtensionPoints()
AuditProfile	getGatewayAuditProfile()	Returns the audit profile specified by SystemPropertiesRecord.GatewayAuditProfile, or null.
AuditProfile	getProfile(java.lang.String name)	Returns the named audit profile, or null if none exists with that name
AuditProfile	getProfileForProject(java.lang.String projectName)	Returns the audit profile for a given project.
void	removeAuditProfileType(java.lang.String typeId)	Remove an audit profile type with the given type ID.
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 Detail

DelegatingAuditManager

public DelegatingAuditManager(AuditManager delegate)

Method Detail

getProfile

@Nullable
public AuditProfile getProfile(java.lang.String name)
                        throws java.lang.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:

java.lang.Exception

getProfileForProject

@Nullable
public AuditProfile getProfileForProject(java.lang.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

@Nullable
public AuditProfile getGatewayAuditProfile()

Description copied from interface: AuditManager

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

Specified by:

getGatewayAuditProfile in interface AuditManager

getAuditContext

public java.util.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 or IgnitionSession. 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

addAuditProfileType

public void addAuditProfileType(AuditProfileType type)
                         throws java.lang.Exception

Description copied from interface: AuditManager

Adds a new type of audit profile to the system. Also makes sure that the persistent settings record indicated in the type is known by the internal schema manager

Specified by:

addAuditProfileType in interface AuditManager

Parameters:

type - The new type of audit profile to add.

Throws:

java.lang.Exception - If automatic schema updating fails.

removeAuditProfileType

public void removeAuditProfileType(java.lang.String typeId)

Description copied from interface: AuditManager

Remove an audit profile type with the given type ID.

Specified by:

removeAuditProfileType in interface AuditManager

Parameters:

typeId - The typeId associated with the audit profile to remove.

getAvailableAuditProfiles

public java.util.List<java.lang.String> getAvailableAuditProfiles()

Description copied from interface: AuditManager

Return the list of audit profiles known to this manager.

Specified by:

getAvailableAuditProfiles in interface AuditManager

getExtensionPoint

@Nullable
public ExtensionPointType getExtensionPoint(java.lang.String typeId)

Specified by:

getExtensionPoint in interface ExtensionPointManager

Returns:

the ExtensionPointType identified by typeId, or null if none exists for that name.

See Also:

ExtensionPointType.getTypeId()

getExtensionPoints

public java.util.List<? extends ExtensionPointType> getExtensionPoints()

Specified by:

getExtensionPoints in interface ExtensionPointManager

Returns:

all ExtensionPointTypes managed by this ExtensionPointManager.