Class LocalHistorianSFEngine
- java.lang.Object
-
- com.inductiveautomation.gateway.tags.history.tsdb.localhistorian.LocalHistorianSFEngine
-
- All Implemented Interfaces:
DataSink
,HistoryStorer
,StoreAndForwardEngine
public class LocalHistorianSFEngine extends java.lang.Object implements StoreAndForwardEngine
The store and forward engine for the local historian. Right now does nothing, but soon will sync remotely.
-
-
Field Summary
-
Fields inherited from interface com.inductiveautomation.ignition.gateway.history.DataSink
LOG_NAME_TEMPLATE
-
-
Constructor Summary
Constructors Constructor Description LocalHistorianSFEngine(DataSink sink)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
acceptsData(HistoryFlavor dataType)
Returns whether or not the storer can accept the specified type of data.java.util.List<DataSinkInformation>
getInfo()
Gets the information for this sink, as well as any below it.java.lang.String
getLogName()
How this element will be represented in the log system.java.lang.String
getPipelineName()
Returns the name of the store and forward pipeline that this sink belongs to.QuarantineManager
getQuarantineManager()
Returns the quarantine interface for the sink.boolean
isAccepting()
Returns whether the data store is accepting data.boolean
isLicensedFor(HistoryFlavor dataType)
Assuming the storer accepts the flavor, is it currently licensed for it? If not, the data will not be stored.void
shutdown()
void
startup()
void
storeData(HistoricalData data)
-
-
-
Constructor Detail
-
LocalHistorianSFEngine
public LocalHistorianSFEngine(DataSink sink)
-
-
Method Detail
-
storeData
public void storeData(HistoricalData data) throws java.lang.Exception
- Specified by:
storeData
in interfaceHistoryStorer
- Throws:
java.lang.Exception
-
acceptsData
public boolean acceptsData(HistoryFlavor dataType)
Description copied from interface:HistoryStorer
Returns whether or not the storer can accept the specified type of data.- Specified by:
acceptsData
in interfaceHistoryStorer
-
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 interfaceHistoryStorer
-
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 interfaceDataSink
-
isAccepting
public boolean isAccepting()
Description copied from interface:DataSink
Returns whether the data store is accepting data.- Specified by:
isAccepting
in interfaceDataSink
-
getInfo
public java.util.List<DataSinkInformation> getInfo()
Description copied from interface:DataSink
Gets the information for this sink, as well as any below it.
-
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 interfaceDataSink
-
getLogName
public java.lang.String getLogName()
Description copied from interface:DataSink
How this element will be represented in the log system. The full name of the logger will be "StoreAndForward.{ThisValue}" It should be surrounded with a MDC key of the pipeline name- Specified by:
getLogName
in interfaceDataSink
-
-