Class LocalHistorianProvider.SyncManager

    • Method Detail

      • getSyncId

        protected long getSyncId()
      • markSyncIdFinished

        protected long markSyncIdFinished​(long id)
      • getPipelineName

        public java.lang.String getPipelineName()
        Description copied from interface: DataSink
        Returns the name of the store and forward pipeline that this sink belongs to.
        Specified by:
        getPipelineName in interface DataSink
      • startup

        public void startup()
        Specified by:
        startup in interface DataSink
      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface DataSink
      • isAccepting

        public boolean isAccepting()
        Description copied from interface: DataSink
        Returns whether the data store is accepting data.
        Specified by:
        isAccepting in interface DataSink
      • getInfo

        public java.util.List<DataSinkInformation> getInfo()
        Description copied from interface: DataSink
        Gets the information for this sink, as well as any below it.
        Specified by:
        getInfo in interface DataSink
      • getQuarantineManager

        public QuarantineManager getQuarantineManager()
        Description copied from interface: DataSink
        Returns the quarantine interface for the sink. If the sink doesn't support quarantined data, can return null.
        Specified by:
        getQuarantineManager in interface DataSink
      • isLicensedFor

        public boolean isLicensedFor​(HistoryFlavor dataType)
        Description copied from interface: HistoryStorer
        Assuming the storer accepts the flavor, is it currently licensed for it? If not, the data will not be stored.
        Specified by:
        isLicensedFor in interface HistoryStorer
      • addDataCountChangeListener

        public void addDataCountChangeListener​(java.beans.PropertyChangeListener listener)
        Description copied from interface: DataStore
        Listener will be notified when new data is available for storage.
        Specified by:
        addDataCountChangeListener in interface DataStore
      • removeDataCountChangeListener

        public void removeDataCountChangeListener​(java.beans.PropertyChangeListener listener)
        Specified by:
        removeDataCountChangeListener in interface DataStore
      • fireDatacountChanged

        protected void fireDatacountChanged()
      • getDataCount

        public int getDataCount()
        Description copied from interface: DataStore
        Amount of data in the cache available to be forwarded. This value cannot be trusted to be 100% accurate, it could be an estimation, and could return negative values if the cache thinks nothing is available or does not yet know how many points are available.
        Specified by:
        getDataCount in interface DataStore
      • getOldestTimestamp

        public long getOldestTimestamp()
        Description copied from interface: DataStore
        Gets the timestamp of the oldest data, in order to calculate how long data has been present. Does not look at quarantined data. Returns Long.MaxValue if there is no value available (because that will be in the future, and thus not old).
        Specified by:
        getOldestTimestamp in interface DataStore
      • takeNext

        public TransactionSet takeNext​(boolean wait,
                                       int desiredTransactionSize,
                                       java.util.Date olderThan)
                                throws java.lang.InterruptedException
        Description copied from interface: DataStore
        Gets the next set of transactions to run.
        Specified by:
        takeNext in interface DataStore
        Parameters:
        wait - whether to block until data is available. If false, or if an olderThan parameter is provided, will return null if no data is present.
        desiredTransactionSize - the desired size of data in the transactions. ONLY A HINT! Stores are free to return whatever they think is best. If -1, it's left to the store's discretion (usually will return 1 at a time)
        olderThan - If null, not used. Otherwise only returns data older than the given value. Returns null if there is no old data available.
        Throws:
        java.lang.InterruptedException