Class AbstractSink
- java.lang.Object
-
- com.inductiveautomation.ignition.gateway.history.sf.sinks.AbstractSink
-
- All Implemented Interfaces:
DataSink
,HistoryStorer
- Direct Known Subclasses:
AbstractDatasourceSink
,HistorianSink
,RemoteHistorianSink
public abstract class AbstractSink extends java.lang.Object implements DataSink
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
faulted
protected java.lang.Exception
faultError
protected long
faultTime
-
Fields inherited from interface com.inductiveautomation.ignition.gateway.history.DataSink
LOG_NAME_TEMPLATE
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractSink(java.lang.String pipelineName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected LoggerEx
createLogger()
java.lang.Exception
getFaultReason()
protected LoggerEx
getLogger()
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 void
initialize()
boolean
isAccepting()
Returns whether the data store is accepting data.boolean
isFaulted()
protected boolean
isInitialized()
protected boolean
isStarted()
void
setFaulted(java.lang.String message, java.lang.Exception e)
protected void
setInitialized(boolean value)
void
shutdown()
void
startup()
protected boolean
tryToInit()
protected void
uninitialize()
-
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
getInfo, getLogName
-
Methods inherited from interface com.inductiveautomation.ignition.gateway.history.HistoryStorer
acceptsData, isLicensedFor, storeData
-
-
-
-
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
-
getLogger
protected LoggerEx getLogger()
-
createLogger
protected final LoggerEx createLogger()
-
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
-
initialize
protected void initialize() throws java.lang.Exception
- Throws:
java.lang.Exception
-
uninitialize
protected void uninitialize()
-
isStarted
protected boolean isStarted()
-
isInitialized
protected boolean isInitialized()
-
tryToInit
protected boolean tryToInit()
-
setInitialized
protected void setInitialized(boolean value)
-
isAccepting
public boolean isAccepting()
Description copied from interface:DataSink
Returns whether the data store is accepting data.- Specified by:
isAccepting
in interfaceDataSink
-
isFaulted
public boolean isFaulted()
-
getFaultReason
public java.lang.Exception getFaultReason()
-
setFaulted
public void setFaulted(java.lang.String message, java.lang.Exception e)
-
-