com.inductiveautomation.ignition.gateway.sqltags

Interface SQLTagsManager

All Superinterfaces:

TagCollection, TagHistoryManager, TagManager, TagManagerBase, TagSubscriptionManager

public interface SQLTagsManager
extends TagManager, TagHistoryManager

The SQLTagsManager manages everything about the Ignition tag system. The manager acts as an extension point manager for realtime and historical tags providers, and all tag operations go through this interface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.common.sqltags.model.TagManagerBase

TagManagerBase.CollisionPolicy

Method Summary

Modifier and Type	Method and Description
void	addSQLTagHistoryProviderType(SQLTagHistoryProviderType type) Adds a new kind of SQLTag history provider to the system.
void	addSQLTagProviderType(SQLTagProviderType type) Adds a new kind of SQLTag provider to the system.
BrowseResults<TagInfoResult>	browseTagInfo(QualifiedPath root, boolean recursive, BrowseFilter filter)
CustomTagStore	createTagStore(long id) Creates or returns a tag store that can be used by a module.
void	executeScanClass(java.lang.String provider, java.lang.String scname) Allows scripts to force the immediate execution of a scan class
GatewaySystemTags	getSystemTags() Returns the tag provider for gateway status tags.
TagEditResources	getTagEditResources(java.lang.String provider, java.lang.String driver) Retrieves all of the resources for the specified tag provider.
TagProvider	getTagProvider(java.lang.String name) Returns the tag provider specified, or null if the provider doesn't exist.
java.util.List<TagProvider>	getTagProviders() Returns all of the registered tag providers.
java.util.List<QualifiedValue>	read(java.util.List<TagPath> paths, AuthenticatedUser user, boolean isSystem) Deprecated. Since 7.6.0, the security is handled by the client session code, so all callers should simply use read(<TagPath>) instead.
void	registerTagProvider(TagProvider manager) This can be used by modules to register new real-time tag providers.
void	removeSQLTagHistoryProviderType(SQLTagHistoryProviderType type) Removes a type of SQLTag history provider from the system
void	removeSQLTagProviderType(SQLTagProviderType type) Removes a type of SQLTag provider from the system
void	shutdown()
void	unregisterTagProvider(java.lang.String name) Stops and unregisters the specified tag provider.
java.util.List<Quality>	write(java.util.List<WriteRequest<TagPath>> writes, AuthenticatedUser user, boolean isSystem) Writes to the tags/properties defined by the tag paths.

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.TagManager

addScanClasses, browseOPC, getDrivers, getProviderInformation, getScanClasses, modifyScanClass, removeScanClasses

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.TagManagerBase

addTags, editTags, getTagDiagnostics, removeTags

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.TagSubscriptionManager

read, subscribe, subscribe, unsubscribe, unsubscribe

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.TagCollection

browse, getTag

Methods inherited from interface com.inductiveautomation.ignition.gateway.sqltags.history.TagHistoryManager

browseHistoricalTags, getTagHistoryProvider, getTagHistoryProviders, queryDensity, queryHistory, queryHistoryDensity, registerTagHistoryProvider, unregisterTagHistoryProvider

Method Detail

registerTagProvider

void registerTagProvider(TagProvider manager)

This can be used by modules to register new real-time tag providers. Generally tag providers should be managed through the Extension Point system, but occasionally a module may want to manage how tag providers are instantiated.

unregisterTagProvider

void unregisterTagProvider(java.lang.String name)

Stops and unregisters the specified tag provider. Should only be used by modules who are manually controller provider registration using the corresponding registerTagProvider function. In other words, do not use if using the Extension Point system.

getTagProvider

TagProvider getTagProvider(java.lang.String name)

Returns the tag provider specified, or null if the provider doesn't exist.

getTagProviders

java.util.List<TagProvider> getTagProviders()

Returns all of the registered tag providers. The returned list is immutable.

createTagStore

CustomTagStore createTagStore(long id)
                       throws java.lang.Exception

Creates or returns a tag store that can be used by a module. If id is 0, a new store will be made, otherwise the provided id will be used. The tag store will be an internal store.

Throws:

java.lang.Exception

addSQLTagProviderType

void addSQLTagProviderType(SQLTagProviderType type)
                    throws java.lang.Exception

Adds a new kind of SQLTag provider to the system.

Throws:

java.lang.Exception

removeSQLTagProviderType

void removeSQLTagProviderType(SQLTagProviderType type)
                       throws java.lang.Exception

Removes a type of SQLTag provider from the system

Throws:

java.lang.Exception

addSQLTagHistoryProviderType

void addSQLTagHistoryProviderType(SQLTagHistoryProviderType type)
                           throws java.lang.Exception

Adds a new kind of SQLTag history provider to the system.

Throws:

java.lang.Exception

removeSQLTagHistoryProviderType

void removeSQLTagHistoryProviderType(SQLTagHistoryProviderType type)
                              throws java.lang.Exception

Removes a type of SQLTag history provider from the system

Throws:

java.lang.Exception

read

@Deprecated
java.util.List<QualifiedValue> read(java.util.List<TagPath> paths,
                                                AuthenticatedUser user,
                                                boolean isSystem)

Deprecated. Since 7.6.0, the security is handled by the client session code, so all callers should simply use read(<TagPath>) instead.

Reads the values of the given paths. If the operation is coming from a client session, the AuthenticatedUser should be included so that tags with custom permissions can be verified. The isSystem flag indicates that the operation is being initiated from a gateway module, and authentication should not be performed.

write

java.util.List<Quality> write(java.util.List<WriteRequest<TagPath>> writes,
                              AuthenticatedUser user,
                              boolean isSystem)

Writes to the tags/properties defined by the tag paths. If the operation is coming from a client session, the AuthenticatedUser should be included so that tags with custom permissions can be verified. The isSystem flag indicates that the operation is being initiated from a gateway module, and authentication should not be performed.

shutdown

void shutdown()

getSystemTags

GatewaySystemTags getSystemTags()

Returns the tag provider for gateway status tags.

getTagEditResources

TagEditResources getTagEditResources(java.lang.String provider,
                                     java.lang.String driver)

Retrieves all of the resources for the specified tag provider. Some resource may depend on the driver.

executeScanClass

void executeScanClass(java.lang.String provider,
                      java.lang.String scname)

Allows scripts to force the immediate execution of a scan class

browseTagInfo

BrowseResults<TagInfoResult> browseTagInfo(QualifiedPath root,
                                           boolean recursive,
                                           BrowseFilter filter)