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

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 and 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, ROOT_LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSink(java.lang.String pipelineName)

Method Summary

Modifier and Type	Method and Description
protected org.apache.log4j.Logger	createLogger()
protected org.apache.log4j.Logger	getLogger()
protected 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.
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

Methods inherited from interface com.inductiveautomation.ignition.gateway.history.HistoryStorer

acceptsData, isLicensedFor, storeData

Field Detail

faulted

protected boolean faulted

faultError

protected java.lang.Exception faultError

faultTime

protected long faultTime

Constructor Detail

AbstractSink

protected AbstractSink(java.lang.String pipelineName)

Method Detail

startup

public void startup()

Specified by:

startup in interface DataSink

shutdown

public void shutdown()

Specified by:

shutdown in interface DataSink

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 interface DataSink

Returns:

getLogger

protected org.apache.log4j.Logger getLogger()

createLogger

protected final org.apache.log4j.Logger createLogger()

getLogName

protected final java.lang.String getLogName()

How this element will be represented in the log system. The full name of the logger will be "StoreAndForward.{PipelineName}.{ThisValue}"

Returns:

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

Returns:

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 interface DataSink

Returns:

isFaulted

public boolean isFaulted()

setFaulted

public void setFaulted(java.lang.String message,
                       java.lang.Exception e)