Package com.inductiveautomation.ignition.gateway.secrets

Interface SecretProviderContext

public interface SecretProviderContext
Encapsulates contextual information for a running SecretProvider

  • Method Details

    • getName

      default String getName()
      Returns:
      the name of the secret provider in this context. never null.

    • getResource

      DecodedResource<ExtensionPointConfig<SecretProviderConfig,?>> getResource()
      Returns:
      the config resource associated with the secret provider in this context. never null.

    • getGatewayContext

      GatewayContext getGatewayContext()
      Returns:
      the current GatewayContext

    • getLog

      LoggerEx getLog()
      Returns:
      the log for the secret provider in this context. typically, the log name will be gateway.SecretProvider with MDC keys setup to help filter log messages by the name of the secret provider, for example. never null.

    • getClock

      Clock getClock()
      Returns:
      a Clock which should be used to measure wall clock time in this context. similar to System.currentTimeMillis(). never null.

    • getTicker

      LongSupplier getTicker()
      Returns:
      a ticker which should be used to measure CPU time in this context. similar to System.nanoTime(). never null.