com.inductiveautomation.ignition.gateway.sqltags

Interface TagProvider

All Superinterfaces:

TagCollection

All Known Implementing Classes:

AbstractStoreBasedTagProvider, DatasourceTagProvider, RedundantProviderWrapper

public interface TagProvider
extends TagCollection

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOG_NAME_TEMPLATE A template logger name that can be used by tag providers to provide consistent names.
static java.util.List<java.lang.String>	NO_IMP_SENTINAL_LISTSTR
static PropertySet	NO_IMP_SENTINAL_PROPSET

Method Summary

Modifier and Type	Method and Description
void	addScanClasses(java.util.List<ScanClass> scanClasses) Adds the given scan classes to the system, replacing any existing ones with the same names.
void	addTags(TagPath parentFolder, java.util.List<TagNode> tag, TagManagerBase.CollisionPolicy policy) Adds the given tags into the parent folder.
java.util.List<BrowseElement>	browseOPC(java.lang.String driver, BrowseElement root) Browses the OPC servers applicable for this driver.
void	editTags(java.util.List<TagPath> paths, TagDiff edit) Applies the given TagDiff edit to the paths indicated
java.util.List<java.lang.String>	getDrivers() Gets a list of the names of any sub-drivers.
default PropertySet	getExtendedTagResources(java.lang.String driver) Returns any additional extended "tag resources".
default java.util.List<java.lang.String>	getHistoricalProviders(java.lang.String driver) Returns the historical providers that tags from this tag provider can target for history.
TagProviderMeta	getInformation() Provides meta information that describes the tag provider.
java.util.List<ScanClass>	getScanClasses() Returns the scan classes defined for the provider, if the provider supports them.
TagProviderInformation	getStatusInformation() Returns execution information that describes the current state of the provider.
TagDiagnostics	getTagDiagnostics(TagPath path) Gets information about the state of an executing tag.
boolean	isPublic() If the driver is public, it will be browsable from the designer.
void	modifyScanClass(java.lang.String scName, ScanClass newDefinition)
java.util.List<QualifiedValue>	read(java.util.List<TagPath> paths, AuthenticatedUser user, boolean isSystem) Reads the values of the given tag paths.
void	removeScanClasses(java.util.List<java.lang.String> scanclassNames) Removes scan classes with the given names.
void	removeTags(java.util.List<TagPath> tagPath) Removes the tags at the given tag paths.
void	shutdown()
void	startup(TagSubscriptionModel model)
java.util.List<Quality>	write(java.util.List<WriteRequest<TagPath>> requests, AuthenticatedUser user, boolean isSystem) Performs the given write requests against the tags, checking the authenticated user/isSystem permissions.

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

browse, getTag

Field Detail

NO_IMP_SENTINAL_LISTSTR

static final java.util.List<java.lang.String> NO_IMP_SENTINAL_LISTSTR

NO_IMP_SENTINAL_PROPSET

static final PropertySet NO_IMP_SENTINAL_PROPSET

LOG_NAME_TEMPLATE

static final java.lang.String LOG_NAME_TEMPLATE

A template logger name that can be used by tag providers to provide consistent names. It is a format string that tags a parameter for the provider name.

See Also:

Constant Field Values

Method Detail

startup

void startup(TagSubscriptionModel model)

shutdown

void shutdown()

isPublic

boolean isPublic()

If the driver is public, it will be browsable from the designer. Otherwise, it will only be used internally on the gateway.

Returns:

getInformation

TagProviderMeta getInformation()

Provides meta information that describes the tag provider.

Returns:

getStatusInformation

TagProviderInformation getStatusInformation()

Returns execution information that describes the current state of the provider.

Returns:

getTagDiagnostics

TagDiagnostics getTagDiagnostics(TagPath path)

Gets information about the state of an executing tag.

Parameters:

path -

Returns:

read

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

Reads the values of the given tag paths.

Parameters:

paths - of tags to read.

user - against which to check security permissions.

isSystem - if true, will bypass most security checks.

Returns:

write

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

Performs the given write requests against the tags, checking the authenticated user/isSystem permissions.

Parameters:

requests - provide the target path and value to write.

user - against which to check security permissions.

isSystem - if true, will bypass most security checks.

Returns:

getScanClasses

java.util.List<ScanClass> getScanClasses()

Returns the scan classes defined for the provider, if the provider supports them.

Returns:

addScanClasses

void addScanClasses(java.util.List<ScanClass> scanClasses)
             throws java.lang.Exception

Adds the given scan classes to the system, replacing any existing ones with the same names.

Parameters:

scanClasses -

Throws:

java.lang.Exception

modifyScanClass

void modifyScanClass(java.lang.String scName,
                     ScanClass newDefinition)
              throws java.lang.Exception

Throws:

java.lang.Exception

removeScanClasses

void removeScanClasses(java.util.List<java.lang.String> scanclassNames)

Removes scan classes with the given names.

Parameters:

scanclassNames -

addTags

void addTags(TagPath parentFolder,
             java.util.List<TagNode> tag,
             TagManagerBase.CollisionPolicy policy)
      throws java.lang.Exception

Adds the given tags into the parent folder. Returns a list of TagPaths corresponding to the new path of each tag, in the order they were given.

Parameters:

tag -

Throws:

java.lang.Exception

editTags

void editTags(java.util.List<TagPath> paths,
              TagDiff edit)
       throws java.lang.Exception

Applies the given TagDiff edit to the paths indicated

Throws:

java.lang.Exception

removeTags

void removeTags(java.util.List<TagPath> tagPath)
         throws java.lang.Exception

Removes the tags at the given tag paths. Returns the list of tags that were removed, if any.

Parameters:

tagPath -

Throws:

java.lang.Exception

browseOPC

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

Browses the OPC servers applicable for this driver. The "driver" parameter is for providers who support multiple sub-drivers, like the legacy provider. Can be NULL if not applicable.

Parameters:

driver -

root -

Returns:

Throws:

java.lang.Exception

getDrivers

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

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

Returns:

getHistoricalProviders

default java.util.List<java.lang.String> getHistoricalProviders(java.lang.String driver)

Returns the historical providers that tags from this tag provider can target for history.

Returns:

A list of historical tag providers on the system that hosts the tag provider. The default implementation returns a special value that will build the list from the local system's historical manager.

getExtendedTagResources

default PropertySet getExtendedTagResources(java.lang.String driver)

Returns any additional extended "tag resources". Tag resources are items that may be provided by different modules, like alarm pipelines, that would be used in tag editing.

Returns: