Class AbstractAuditProfile

java.lang.Object
com.inductiveautomation.ignition.gateway.audit.AbstractAuditProfile
All Implemented Interfaces:
AuditProfile

public abstract class AbstractAuditProfile extends Object implements 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
  • Constructor Details

    • AbstractAuditProfile

      public AbstractAuditProfile()
  • Method Details

    • getStatus

      public ProfileStatus getStatus()
      Description copied from interface: AuditProfile
      Returns this profile's current runtime health, as surfaced on the Security → Audit Profiles config page. The same ProfileStatus contract that tag providers, tag history, and alarm-notification profiles report.

      The default reports ProfileStatus.RUNNING. Implementations that track their own health should extend AbstractAuditProfile (which makes the status settable via setStatus) or override this method to compute it on demand.

      Specified by:
      getStatus in interface AuditProfile
      Returns:
      the profile's current status; never null.
    • setStatus

      protected void setStatus(ProfileStatus status)
      Sets the status returned by getStatus(). Intended for profiles that learn their health during AuditProfile.startup() or from a worker thread; profiles that can derive health on demand may override getStatus() instead.
      Parameters:
      status - the new status; must not be null.