Class PerspectiveAuthTokenManager

java.lang.Object
com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle
com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord, com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord.Builder, com.inductiveautomation.ignition.gateway.auth.token.AuthTokenRecord.ChangeEvent.Context.Redundant<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord>>
com.inductiveautomation.ignition.gateway.auth.token.RedundantAuthTokenManager<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord, com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord.Builder>
com.inductiveautomation.perspective.gateway.auth.token.PerspectiveAuthTokenManager
All Implemented Interfaces:
Lifecycle

public class PerspectiveAuthTokenManager extends com.inductiveautomation.ignition.gateway.auth.token.RedundantAuthTokenManager<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord, com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord.Builder>
A RedundantAuthTokenManager which manages ProjectAuthTokenRecords bound to Perspective offline mode sessions
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    A RedundantAuthTokenManager.Builder which provides a fluent-style API for incrementally building the required pieces to create new PerspectiveAuthTokenManager instances.

    Nested classes/interfaces inherited from class com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager

    com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager.Config, com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager.Context, com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager.TimeoutSettings
  • Constructor Summary

    Constructors
    Constructor
    Description
    PerspectiveAuthTokenManager(com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager.Context context, com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager.Config config, com.inductiveautomation.ignition.gateway.auth.token.AuthTokenRecordStore<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord> authTokenRecordStore, boolean restore)
    Create a new instance of PerspectiveAuthTokenManager
  • Method Summary

    Modifier and Type
    Method
    Description
     
    protected com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord.Builder
    builder(com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord authTokenRecord)
     
    protected void
    customizeDigest(DigestBuilder digestBuilder, com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord authTokenRecord)
     
    protected com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager.TimeoutSettings
    getTimeoutSettings(com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord authTokenRecord)
     
    protected String
     

    Methods inherited from class com.inductiveautomation.ignition.gateway.auth.token.RedundantAuthTokenManager

    onShutdown, onStartup

    Methods inherited from class com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager

    add, addChangeEventListener, get, get, getAndTouch, getContext, getRecordIds, remove, removeChangeEventListener, setup, touch

    Methods inherited from class AbstractLifecycle

    isRunning, shutdown, startup

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • PerspectiveAuthTokenManager

      public PerspectiveAuthTokenManager(com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager.Context context, com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager.Config config, com.inductiveautomation.ignition.gateway.auth.token.AuthTokenRecordStore<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord> authTokenRecordStore, boolean restore)
      Create a new instance of PerspectiveAuthTokenManager
      Parameters:
      context - the AuthTokenManager.Context. must not be null.
      config - the AuthTokenManager.Config. must not be null.
      authTokenRecordStore - the AuthTokenRecordStore. must not be null.
      restore - true if the Gateway is starting up from a restore of a GWBK
      Throws:
      NullPointerException - if any of the provided arguments are null
  • Method Details

    • getTypeMetricName

      protected String getTypeMetricName()
      Specified by:
      getTypeMetricName in class com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord, com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord.Builder, com.inductiveautomation.ignition.gateway.auth.token.AuthTokenRecord.ChangeEvent.Context.Redundant<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord>>
    • builder

      protected com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord.Builder builder(com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord authTokenRecord)
      Specified by:
      builder in class com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord, com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord.Builder, com.inductiveautomation.ignition.gateway.auth.token.AuthTokenRecord.ChangeEvent.Context.Redundant<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord>>
    • getTimeoutSettings

      protected com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager.TimeoutSettings getTimeoutSettings(com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord authTokenRecord)
      Specified by:
      getTimeoutSettings in class com.inductiveautomation.ignition.gateway.auth.token.AuthTokenManager<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord, com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord.Builder, com.inductiveautomation.ignition.gateway.auth.token.AuthTokenRecord.ChangeEvent.Context.Redundant<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord>>
    • customizeDigest

      protected void customizeDigest(DigestBuilder digestBuilder, com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord authTokenRecord)
      Overrides:
      customizeDigest in class com.inductiveautomation.ignition.gateway.auth.token.RedundantAuthTokenManager<com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord, com.inductiveautomation.ignition.gateway.auth.token.ProjectAuthTokenRecord.Builder>
    • builder

      public static PerspectiveAuthTokenManager.Builder builder()
      Returns:
      a new instance of PerspectiveAuthTokenManager.Builder. never null.