Class AbstractAuditProfile
java.lang.Object
com.inductiveautomation.ignition.gateway.audit.AbstractAuditProfile
- All Implemented Interfaces:
AuditProfile
Base class for
AuditProfile implementations that supplies the getStatus()
contract so implementors get health reporting without boilerplate. A newly created profile
reports ProfileStatus.RUNNING; a profile that tracks its own health either pushes updates
with setStatus(ProfileStatus) or overrides getStatus() to compute health on
demand.
There are two distinct ways a profile signals that it cannot run, with different consequences.
If AuditProfile.startup() throws, the audit manager substitutes a faulted placeholder and the
configured profile is not registered. If instead the profile starts successfully but is degraded
— for example the database or remote gateway it forwards to is down — it should stay registered
and report that through its status, so its health stays live and recovers on its own once the
dependency returns.
- Since:
- 2027.2
-
Nested Class Summary
Nested classes/interfaces inherited from interface AuditProfile
AuditProfile.QueryRequest, AuditProfile.QueryStreamHandler -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns this profile's current runtime health, as surfaced on the Security → Audit Profiles config page.protected voidsetStatus(ProfileStatus status) Sets the status returned bygetStatus().Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface AuditProfile
audit, handleNameChange, handleResourceDeleted, query, query, shutdown, startup
-
Constructor Details
-
AbstractAuditProfile
public AbstractAuditProfile()
-
-
Method Details
-
getStatus
Description copied from interface:AuditProfileReturns this profile's current runtime health, as surfaced on the Security → Audit Profiles config page. The sameProfileStatuscontract that tag providers, tag history, and alarm-notification profiles report.The default reports
ProfileStatus.RUNNING. Implementations that track their own health should extendAbstractAuditProfile(which makes the status settable viasetStatus) or override this method to compute it on demand.- Specified by:
getStatusin interfaceAuditProfile- Returns:
- the profile's current status; never
null.
-
setStatus
Sets the status returned bygetStatus(). Intended for profiles that learn their health duringAuditProfile.startup()or from a worker thread; profiles that can derive health on demand may overridegetStatus()instead.- Parameters:
status- the new status; must not benull.
-