com.inductiveautomation.ignition.gateway.sqltags.providers.datasource

Class DatasourceTagProvider

java.lang.Object

com.inductiveautomation.ignition.gateway.sqltags.providers.AbstractStoreBasedTagProvider

com.inductiveautomation.ignition.gateway.sqltags.providers.datasource.DatasourceTagProvider

All Implemented Interfaces:

TagCollection, RedundancyStateListener, ScanclassListener, TagStoreListener, TagSubscriptionChangeListener, TagValueListener, DBValueUpdateListener, ExternalScanclassUpdateListener, ExecutableTagCollection, TypeManagerProvider, TagProvider, java.util.EventListener

public class DatasourceTagProvider
extends AbstractStoreBasedTagProvider
implements DBValueUpdateListener, ExternalScanclassUpdateListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DatasourceTagProvider.ExternalFactory Our own special executable factory that creates external tags for everything.

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.gateway.sqltags.providers.AbstractStoreBasedTagProvider

AbstractStoreBasedTagProvider.AddTagsTask, AbstractStoreBasedTagProvider.LeasedTagMaintenanceManager, AbstractStoreBasedTagProvider.SmartTagLicenseTracker, AbstractStoreBasedTagProvider.TagAddNameResolver, AbstractStoreBasedTagProvider.TemporaryConfigProvider

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.sqltags.providers.datasource.tagstore.ExternalScanclassUpdateListener

ExternalScanclassUpdateListener.ScanClassInformation

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.sqltags.providers.AbstractStoreBasedTagProvider

notLicensedTags, orphanedHistoricalTags, orphanedTagExecutor, orphanedTags, scIdMap, scNameMap, tagIdMap, tagTree, typeManager, udtMemberMap

Fields inherited from interface com.inductiveautomation.ignition.gateway.sqltags.TagProvider

LOG_NAME_TEMPLATE, NO_IMP_SENTINAL_LISTSTR, NO_IMP_SENTINAL_PROPSET

Constructor Summary

Constructors

Constructor and Description
DatasourceTagProvider(GatewayContext context, java.lang.String name, java.lang.String dataSource, int pollRate, int pollOverlap)

Method Summary

Modifier and Type	Method and Description
java.util.List<BrowseElement>	browseOPC(java.lang.String driver, BrowseElement root) In this class, we need to browse against a remote FactorySQL.
protected TagStore	createAndConfigureTagStore() Abstract functions
protected ExecutableFactory	createExecutableFactory()
protected void	evaluateScanClassLeases(java.util.Set<java.lang.String> subscribedScanClasses) Called when it's necessary to look at what scan classes are leased, and take the appropriate action, such as setting the scan classes expiration, or writing to the database.
java.util.List<java.lang.String>	getDrivers() Gets a list of the names of any sub-drivers.
protected SQLTagsExecutor	getExecutor() Gets the 'scanclassexecutor', which is the owner of the scanclass.
protected int	getPollOverlap()
protected int	getPollRate()
protected java.util.List<Quality>	internalWriteValue(java.util.List<WriteRequest<TagPath>> requests) The legacy tag provider performs all writes through the database.
void	notifyValueUpdates(java.util.List<DBTagValue> values)
void	scanclassInformationUpdated(java.util.List<ExternalScanclassUpdateListener.ScanClassInformation> scanClasses)
void	scanclassRateChanged(ScanclassEvent e)
void	scanclassStatisticsChanged(ScanclassEvent e)

Methods inherited from class com.inductiveautomation.ignition.gateway.sqltags.providers.AbstractStoreBasedTagProvider

addScanClasses, addTags, breakupTagsBySC, browse, checkNameChange, deregisterOrphanedTags, editTags, findClosestExistingFolder, getContext, getDatasourceName, getExecutableFactory, getExecutionManager, getFolderTag, getIds, getInformation, getLastError, getLicenseTracker, getLogger, getName, getObjectPath, getRunningTag, getScanClass, getScanClasses, getScanClassesForNames, getScanClassForName, getSQLTErrorLogger, getStatusInformation, getTag, getTag, getTagDiagnostics, getTagReferenceManager, getTagsForPaths, getTagsForPaths, getTagStore, getTypeManager, handleDeletedScanclasses, handleDeletedTags, handleModifiedScanClasses, handleModifiedTags, internalStartup, internalWriteToFolders, isErrored, isFolderTag, isPublic, isRunning, isTagLicensable, manageSubscriptions, modifyScanClass, notifyTagsChanged, processOPCWrites, read, redundancyConnStatusChanged, redundancyStateChanged, registerOrphanedTags, registerTags, reloadTags, removeImplicitFolders, removeScanClasses, removeTags, renameFolder, reregisterOrphanedTags, reregisterUnlicensedTags, retireHistoricalTags, runInConfigLock, setDatasourceName, setLastError, setRunning, shutdown, startScanclasses, startup, stopScanclasses, subscriptionChanged, tagLimitChanged, tagstoreItemsAdded, tagstoreItemsRemoved, tagstorePropertiesChanged, tagValuesChanged, updateStatMetrics, updateStatusProperties, verifyOrCreateScanClasses, wrapTagsToDef, write, writeToLocalTags

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.sqltags.TagProvider

getExtendedTagResources, getHistoricalProviders

Constructor Detail

DatasourceTagProvider

public DatasourceTagProvider(GatewayContext context,
                             java.lang.String name,
                             java.lang.String dataSource,
                             int pollRate,
                             int pollOverlap)

Method Detail

getPollRate

protected int getPollRate()

getPollOverlap

protected int getPollOverlap()

getExecutor

protected SQLTagsExecutor getExecutor()

Description copied from class: AbstractStoreBasedTagProvider

Gets the 'scanclassexecutor', which is the owner of the scanclass. This executor provides access to basic tools, such as the error logger, and subscription system. It is retrieved through this function because subclasses may wish to implement it differently- such as passing a wrapper that changes the way tag references/subscriptions work.

Specified by:

getExecutor in class AbstractStoreBasedTagProvider

createAndConfigureTagStore

protected TagStore createAndConfigureTagStore()

Description copied from class: AbstractStoreBasedTagProvider

Abstract functions

Specified by:

createAndConfigureTagStore in class AbstractStoreBasedTagProvider

createExecutableFactory

protected ExecutableFactory createExecutableFactory()

Specified by:

createExecutableFactory in class AbstractStoreBasedTagProvider

scanclassRateChanged

public void scanclassRateChanged(ScanclassEvent e)

Specified by:

scanclassRateChanged in interface ScanclassListener

Overrides:

scanclassRateChanged in class AbstractStoreBasedTagProvider

scanclassStatisticsChanged

public void scanclassStatisticsChanged(ScanclassEvent e)

Specified by:

scanclassStatisticsChanged in interface ScanclassListener

Overrides:

scanclassStatisticsChanged in class AbstractStoreBasedTagProvider

evaluateScanClassLeases

protected void evaluateScanClassLeases(java.util.Set<java.lang.String> subscribedScanClasses)

Description copied from class: AbstractStoreBasedTagProvider

Called when it's necessary to look at what scan classes are leased, and take the appropriate action, such as setting the scan classes expiration, or writing to the database.

Specified by:

evaluateScanClassLeases in class AbstractStoreBasedTagProvider

scanclassInformationUpdated

public void scanclassInformationUpdated(java.util.List<ExternalScanclassUpdateListener.ScanClassInformation> scanClasses)

Specified by:

scanclassInformationUpdated in interface ExternalScanclassUpdateListener

internalWriteValue

protected java.util.List<Quality> internalWriteValue(java.util.List<WriteRequest<TagPath>> requests)

The legacy tag provider performs all writes through the database.

Overrides:

internalWriteValue in class AbstractStoreBasedTagProvider

Returns:

browseOPC

public java.util.List<BrowseElement> browseOPC(java.lang.String driver,
                                               BrowseElement root)
                                        throws java.lang.Exception

In this class, we need to browse against a remote FactorySQL.

Specified by:

browseOPC in interface TagProvider

Specified by:

browseOPC in class AbstractStoreBasedTagProvider

Returns:

Throws:

java.lang.Exception

getDrivers

public java.util.List<java.lang.String> getDrivers()

Description copied from interface: TagProvider

Gets a list of the names of any sub-drivers. Only applicable to providers who support them, such as the legacy provider.

Specified by:

getDrivers in interface TagProvider

Returns:

notifyValueUpdates

public void notifyValueUpdates(java.util.List<DBTagValue> values)

Specified by:

notifyValueUpdates in interface DBValueUpdateListener