Package com.inductiveautomation.ignition.gateway.history.sf.sinks

Class AggregateSink

java.lang.Object
com.inductiveautomation.ignition.gateway.history.sf.sinks.AggregateSink
All Implemented Interfaces:
DataSink, HistoryStorer
public class AggregateSink extends Object implements DataSink
The aggregate sink pulls together sinks that support different types of data. For example, the TagHistory sink and the RecordHistory sink.

  • Constructor Details

    • AggregateSink

      public AggregateSink(String pipelineName, DataSink... dataSinks)

  • Method Details

    • getPipelineName

      public 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

    • getSinks

      protected 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 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

    • isAccepting

      public boolean isAccepting()
      Only true if ALL data sinks are accepting.
      Specified by:
      isAccepting in interface DataSink

    • shutdown

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

    • startup

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

    • 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 interface HistoryStorer

    • 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

    • storeData

      public void storeData(HistoricalData data) throws Exception
      Specified by:
      storeData in interface HistoryStorer
      Throws:
      Exception