Package com.inductiveautomation.ignition.common.tags.model

Interface TagManager

All Known Subinterfaces:

ClientTagManager, GatewayTagManager

All Known Implementing Classes:

ClientTagManagerImpl, DesignerTagManagerImpl, ProjectDefaultTagManagerFacade

public interface TagManager

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BROWSE_LOCAL_SYSTEM	Browse can go through a tag provider, but we may also want to just browse the local gateway- for non tag provider related purposes.
static final String	DATA_SOURCE_OPC	Type id for OPC data from browseTagDataSource

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Results<NodeDescription>>	browseAsync(TagPath tagPath, BrowseFilter browseFilter)
CompletableFuture<Results<NodeDescription>>	browseAsync(TagPath tagPath, BrowseFilter browseFilter, SecurityContext securityContext)
CompletableFuture<Results<BrowseElement>>	browseTagDataSourcesAsync(String provider, BrowseElement root, BrowseFilter filter)
CompletableFuture<TagDiagnostics>	getDiagnosticsAsync(TagPath path)
CompletableFuture<ConfigurationPropertyModel>	getTagConfigModelAsync(String provider)
CompletableFuture<ConfigurationPropertyModel>	getTagGroupConfigModelAsync(String provider)
CompletableFuture<List<TagGroupConfiguration>>	getTagGroupsAsync(String provider)
CompletableFuture<List<QualityCode>>	importTagsAsync(TagPath basePath, String importText, String importType, CollisionPolicy collisionPolicy)
CompletableFuture<List<QualityCode>>	importTagsAsync(TagPath basePath, String importText, String importType, CollisionPolicy collisionPolicy, SecurityContext securityContext)
default CompletableFuture<List<QualityCode>>	moveTagsAsync(List<TagPath> tags, TagPath destination, boolean copy, CollisionPolicy collisionPolicy)
CompletableFuture<List<QualityCode>>	moveTagsAsync(List<TagPath> tags, TagPath destination, boolean copy, CollisionPolicy collisionPolicy, SecurityContext securityContext)	Copies tags from any sources to a specific destination.
default CompletableFuture<List<QualifiedValue>>	readAsync(List<TagPath> tagPaths)
CompletableFuture<List<QualifiedValue>>	readAsync(List<TagPath> tagPaths, SecurityContext securityContext)
default CompletableFuture<List<QualityCode>>	reinitializeTags(List<TagPath> tagPaths)
default CompletableFuture<Void>	subscribeAsync(TagPath tagPath, TagChangeListener listener)
CompletableFuture<Void>	subscribeAsync(List<TagPath> tagPaths, List<TagChangeListener> listeners)
default CompletableFuture<Void>	unsubscribeAsync(TagPath tagPath, TagChangeListener listener)
CompletableFuture<Void>	unsubscribeAsync(List<TagPath> tagPaths, List<TagChangeListener> listeners)
default CompletableFuture<List<QualityCode>>	writeAsync(List<TagPath> tagPaths, List<Object> values)
CompletableFuture<List<QualityCode>>	writeAsync(List<TagPath> tagPaths, List<Object> values, SecurityContext securityContext)

Field Details

DATA_SOURCE_OPC

static final String DATA_SOURCE_OPC

Type id for OPC data from browseTagDataSource

See Also:

• Constant Field Values

BROWSE_LOCAL_SYSTEM

static final String BROWSE_LOCAL_SYSTEM

Browse can go through a tag provider, but we may also want to just browse the local gateway- for non tag provider related purposes. Instead of having two browse apis, we can reuse this one with a special provider name.

See Also:

• Constant Field Values

Method Details

browseTagDataSourcesAsync

CompletableFuture<Results<BrowseElement>> browseTagDataSourcesAsync(String provider,
 BrowseElement root,
 BrowseFilter filter)

getTagGroupConfigModelAsync

CompletableFuture<ConfigurationPropertyModel> getTagGroupConfigModelAsync(String provider)

getTagConfigModelAsync

CompletableFuture<ConfigurationPropertyModel> getTagConfigModelAsync(String provider)

getTagGroupsAsync

CompletableFuture<List<TagGroupConfiguration>> getTagGroupsAsync(String provider)

moveTagsAsync

CompletableFuture<List<QualityCode>> moveTagsAsync(List<TagPath> tags,
 TagPath destination,
 boolean copy,
 CollisionPolicy collisionPolicy,
 SecurityContext securityContext)

Copies tags from any sources to a specific destination. Destination may be in a different provider. If the source and destination paths are all in the same provider, and copy is FALSE, it will be treated as a move.

moveTagsAsync

default CompletableFuture<List<QualityCode>> moveTagsAsync(List<TagPath> tags,
 TagPath destination,
 boolean copy,
 CollisionPolicy collisionPolicy)

browseAsync

CompletableFuture<Results<NodeDescription>> browseAsync(TagPath tagPath,
 BrowseFilter browseFilter)

browseAsync

CompletableFuture<Results<NodeDescription>> browseAsync(TagPath tagPath,
 BrowseFilter browseFilter,
 SecurityContext securityContext)

readAsync

default CompletableFuture<List<QualifiedValue>> readAsync(List<TagPath> tagPaths)

readAsync

CompletableFuture<List<QualifiedValue>> readAsync(List<TagPath> tagPaths,
 SecurityContext securityContext)

writeAsync

default CompletableFuture<List<QualityCode>> writeAsync(List<TagPath> tagPaths,
 List<Object> values)

writeAsync

CompletableFuture<List<QualityCode>> writeAsync(List<TagPath> tagPaths,
 List<Object> values,
 SecurityContext securityContext)

reinitializeTags

default CompletableFuture<List<QualityCode>> reinitializeTags(List<TagPath> tagPaths)

subscribeAsync

default CompletableFuture<Void> subscribeAsync(TagPath tagPath,
 TagChangeListener listener)

subscribeAsync

CompletableFuture<Void> subscribeAsync(List<TagPath> tagPaths,
 List<TagChangeListener> listeners)

unsubscribeAsync

default CompletableFuture<Void> unsubscribeAsync(TagPath tagPath,
 TagChangeListener listener)

unsubscribeAsync

CompletableFuture<Void> unsubscribeAsync(List<TagPath> tagPaths,
 List<TagChangeListener> listeners)

getDiagnosticsAsync

CompletableFuture<TagDiagnostics> getDiagnosticsAsync(TagPath path)

importTagsAsync

CompletableFuture<List<QualityCode>> importTagsAsync(TagPath basePath,
 String importText,
 String importType,
 CollisionPolicy collisionPolicy)

Parameters:

basePath - tags will be imported using this location as the base. The provider source must be set.

importText - a String holding the contents of the file to import

importType - The import file type. Use "json", "xml" or "csv". Any other value will return an error.

collisionPolicy - The collision policy to use. Abort will throw an exception on the first tag collision, Ignore will not change the existing tag at all, Overwrite will overwrite the existing tag completely, and Rename will create a new tag with a similar name (MyTag becomes MyTag1).

importTagsAsync

CompletableFuture<List<QualityCode>> importTagsAsync(TagPath basePath,
 String importText,
 String importType,
 CollisionPolicy collisionPolicy,
 SecurityContext securityContext)

Parameters:

basePath - tags will be imported using this location as the base. The provider source must be set.

importText - a String holding the contents of the file to import

importType - The import file type. Use "json", "xml" or "csv". Any other value will return an error.

collisionPolicy - The collision policy to use. Abort will throw an exception on the first tag collision, Ignore will not change the existing tag at all, Overwrite will overwrite the existing tag completely, and Rename will create a new tag with a similar name (MyTag becomes MyTag1).

securityContext - the SecurityContext of the user from the call site