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 Summary

Fields
Modifier and Type Field Description

static java.lang.String LOG_NAME_TEMPLATE
The template for loggers under the store and forward system.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`java.util.List<DataSinkInformation>`	`getInfo()`	Gets the information for this sink, as well as any below it.
`default 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.
`void`	`shutdown()`
`void`	`startup()`

Methods inherited from interface com.inductiveautomation.ignition.gateway.history.HistoryStorer
acceptsData, isLicensedFor, storeData

- Field Detail
  - LOG_NAME_TEMPLATE
```
static final java.lang.String LOG_NAME_TEMPLATE
```
    The template for loggers under the store and forward system. Includes a string format parameter- should be ObjectName
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getPipelineName
```
java.lang.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
```
java.util.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 java.lang.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