Package com.inductiveautomation.ignition.gateway.history

Interface DataSink

All Superinterfaces:
HistoryStorer
All Known Subinterfaces:
DataStore, StoreAndForwardEngine
All Known Implementing Classes:
AbstractDatasourceSink, AbstractSink, AggregateSink
public interface DataSink extends HistoryStorer
A data sink accepts history. It's just a bit heavier weight than a plain old HistoryStorer, from which it extends. It supports startup and shutdown, along with the idea that it may not always be able to or want to accept data, which is indicated by the "isAccepting" property.

  • Field Details

    • LOG_NAME_TEMPLATE

      static final String LOG_NAME_TEMPLATE
      The template for loggers under the store and forward system. Includes a string format parameter- should be ObjectName
      See Also:

  • Method Details

    • getPipelineName

      String getPipelineName()
      Returns the name of the store and forward pipeline that this sink belongs to.

    • startup

      void startup()

    • shutdown

      void shutdown()

    • isAccepting

      boolean isAccepting()
      Returns whether the data store is accepting data.

    • getInfo

      List<DataSinkInformation> getInfo()
      Gets the information for this sink, as well as any below it.

    • getQuarantineManager

      @Nullable QuarantineManager getQuarantineManager()
      Returns the quarantine interface for the sink. If the sink doesn't support quarantined data, can return null.

    • getLogName

      default String getLogName()
      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