Class AggregateSink
- java.lang.Object
-
- com.inductiveautomation.ignition.gateway.history.sf.sinks.AggregateSink
-
- All Implemented Interfaces:
DataSink
,HistoryStorer
public class AggregateSink extends java.lang.Object implements DataSink
The aggregate sink pulls together sinks that support different types of data. For example, the TagHistory sink and the RecordHistory sink.
-
-
Field Summary
-
Fields inherited from interface com.inductiveautomation.ignition.gateway.history.DataSink
LOG_NAME_TEMPLATE
-
-
Constructor Summary
Constructors Constructor Description AggregateSink(java.lang.String pipelineName, DataSink... dataSinks)
-
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.void
addSink(DataSink sink)
Adds a sink to the list.java.util.List<DataSinkInformation>
getInfo()
Gets the information for this sink, as well as any below it.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.protected java.util.List<DataSink>
getSinks()
boolean
isAccepting()
Only true if ALL data sinks are accepting.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
removeSink(DataSink sink)
void
shutdown()
void
startup()
void
storeData(HistoricalData data)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inductiveautomation.ignition.gateway.history.DataSink
getLogName
-
-
-
-
Constructor Detail
-
AggregateSink
public AggregateSink(java.lang.String pipelineName, DataSink... dataSinks)
-
-
Method Detail
-
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
-
getSinks
protected java.util.List<DataSink> getSinks()
-
addSink
public void addSink(DataSink sink)
Adds a sink to the list. Will start the sink if this aggregate sink is started.
-
removeSink
public void removeSink(DataSink sink)
-
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
-
isAccepting
public boolean isAccepting()
Only true if ALL data sinks are accepting.- Specified by:
isAccepting
in interfaceDataSink
-
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
-
storeData
public void storeData(HistoricalData data) throws java.lang.Exception
- Specified by:
storeData
in interfaceHistoryStorer
- Throws:
java.lang.Exception
-
-