Package com.inductiveautomation.historian.gateway.distributed.sync

Class LegacyHistorianSyncable

java.lang.Object
com.inductiveautomation.historian.gateway.distributed.sync.LegacyHistorianSyncable
All Implemented Interfaces:
Syncable, SyncSettings
public class LegacyHistorianSyncable extends Object implements Syncable, SyncSettings

  • Method Details

    • getKey

      public String getKey()
      Description copied from interface: Syncable
      A key to uniquely identify this Syncable to the SyncManager
      Specified by:
      getKey in interface Syncable

    • getSyncableCount

      public int getSyncableCount(long syncId)
      Description copied from interface: Syncable
      Returns the number of data points that could be synchronized from the given point.
      Specified by:
      getSyncableCount in interface Syncable

    • sync

      public SyncResult sync(long syncId) throws Exception
      Description copied from interface: Syncable
      Return true if and only if data was successfully sent to the target
      Specified by:
      sync in interface Syncable
      Parameters:
      syncId - if 0, returns next set of available data based on last query. Otherwise, starts at the given time period.
      Throws:
      Exception

    • getSyncSettings

      public SyncSettings getSyncSettings()
      Description copied from interface: Syncable
      Returns the sync settings used for sending data to remote systems.
      Specified by:
      getSyncSettings in interface Syncable

    • getSyncType

      public String getSyncType()
      Description copied from interface: Syncable
      Returns the type of data this Syncable will store (e.g. historical, auditing, alarming).
      Specified by:
      getSyncType in interface Syncable

    • getLastSyncId

      public long getLastSyncId()
      Description copied from interface: Syncable
      Returns the syncid for the last data synced.
      Specified by:
      getLastSyncId in interface Syncable

    • setLastSyncId

      public void setLastSyncId(long value)
      Description copied from interface: Syncable
      Use to update the most recently synced id.
      Specified by:
      setLastSyncId in interface Syncable

    • isEnabled

      public boolean isEnabled()
      Specified by:
      isEnabled in interface SyncSettings

    • getExecutionDelayMS

      public long getExecutionDelayMS()
      Specified by:
      getExecutionDelayMS in interface SyncSettings

    • getSchedule

      @Nullable public @Nullable Timeline getSchedule()
      Specified by:
      getSchedule in interface SyncSettings

    • isScheduleEnabled

      public boolean isScheduleEnabled()
      Specified by:
      isScheduleEnabled in interface SyncSettings

    • startup

      public void startup()

    • shutdown

      public void shutdown()

    • builder

      public static LegacyHistorianSyncable.Builder builder()