com.inductiveautomation.ignition.client.tags.impl

Class ClientTagManagerImpl

java.lang.Object

com.inductiveautomation.ignition.client.tags.impl.ClientTagManagerImpl

All Implemented Interfaces:

ClientTagManager, TagManager

Direct Known Subclasses:

DesignerTagManagerImpl

public class ClientTagManagerImpl
extends java.lang.Object
implements ClientTagManager

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.tags.model.TagManager

BROWSE_LOCAL_SYSTEM, DATA_SOURCE_OPC

Constructor Summary

Constructors

Constructor and Description
ClientTagManagerImpl(ClientContext clientContext)

Method Summary

Modifier and Type	Method and Description
void	addClientTagProvider(ClientTagProvider provider)
java.util.concurrent.CompletableFuture<Results<NodeDescription>>	browseAsync(TagPath tagPath, BrowseFilter browseFilter)
java.util.concurrent.CompletableFuture<Results<Result>>	browseHistoricalTagsAsync(QualifiedPath root, BrowseFilter filter)
java.util.concurrent.CompletableFuture<Results<BrowseElement>>	browseTagDataSourcesAsync(java.lang.String provider, BrowseElement root, BrowseFilter filter)
TagAttributeManager	getAttributeManager()
ClientTagProvider	getClientTagProvider(java.lang.String provider)
ClientTagProvider	getDefaultProvider()
java.util.concurrent.CompletableFuture<TagDiagnostics>	getDiagnosticsAsync(TagPath path)
java.util.List<TagProviderProps>	getProviderProperties()
TagProviderProps	getProviderProperties(java.lang.String provider)
protected java.lang.String	getSource(TagPath path)
SystemTagManager	getSystemTagManager()
java.util.concurrent.CompletableFuture<ConfigurationPropertyModel>	getTagConfigModelAsync(java.lang.String provider)
java.util.concurrent.CompletableFuture<java.util.List<TagEditModel>>	getTagConfigsAsync(java.util.List<TagPath> tagPaths, boolean recursive, boolean localPropsOnly)
java.util.concurrent.CompletableFuture<ConfigurationPropertyModel>	getTagGroupConfigModelAsync(java.lang.String provider)
java.util.concurrent.CompletableFuture<java.util.List<TagGroupConfiguration>>	getTagGroupsAsync(java.lang.String provider)
UdtDefinitionInfo	getTypeDefinition(TagPath typeId)
java.util.concurrent.CompletableFuture<QualityCode>	importTagDataSourcesAsync(TagPath location, java.util.List<BrowseElement> elements)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>	importTagsAsync(TagPath basePath, java.lang.String importText, java.lang.String importType, CollisionPolicy collisionPolicy)
boolean	isAncestorOf(TagPath baseTypeId, TagPath potentialSubTypeId) Returns true if the second argument is equal to or subtype of the first argument.
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>	moveTagsAsync(java.util.List<TagPath> tags, TagPath destination, boolean copy, CollisionPolicy collisionPolicy)
protected ClientTagProvider	provider(TagPath path)
java.util.concurrent.CompletableFuture<java.util.List<QualifiedValue>>	readAsync(java.util.List<TagPath> tagPaths, SecurityContext security)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>	reinitializeTagsAsync(java.util.List<TagPath> tagPaths)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>	removeTagsAsync(java.util.List<TagPath> tagPaths)
void	requestTagGroupExecution(java.lang.String provider, java.lang.String tagGroup)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>	saveTagConfigsAsync(java.util.List<TagEdit> tagEdits, CollisionPolicy collisionPolicy)
void	shutdown()
java.util.concurrent.CompletableFuture<java.lang.Void>	subscribeAsync(java.util.List<TagPath> tagPaths, java.util.List<TagChangeListener> listeners)
java.util.concurrent.CompletableFuture<java.lang.Void>	unsubscribeAsync(java.util.List<TagPath> tagPaths, java.util.List<TagChangeListener> listeners)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>	writeAsync(java.util.List<TagPath> tagPaths, java.util.List<java.lang.Object> values, SecurityContext security)

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.common.tags.model.TagManager

readAsync, reinitializeTags, subscribeAsync, unsubscribeAsync, writeAsync

Constructor Detail

ClientTagManagerImpl

public ClientTagManagerImpl(ClientContext clientContext)

Method Detail

shutdown

public void shutdown()

getSystemTagManager

public SystemTagManager getSystemTagManager()

Specified by:

getSystemTagManager in interface ClientTagManager

addClientTagProvider

public void addClientTagProvider(ClientTagProvider provider)

Specified by:

addClientTagProvider in interface ClientTagManager

getClientTagProvider

public ClientTagProvider getClientTagProvider(java.lang.String provider)

Specified by:

getClientTagProvider in interface ClientTagManager

provider

protected ClientTagProvider provider(TagPath path)

getSource

protected java.lang.String getSource(TagPath path)

browseTagDataSourcesAsync

public java.util.concurrent.CompletableFuture<Results<BrowseElement>> browseTagDataSourcesAsync(java.lang.String provider,
                                                                                                BrowseElement root,
                                                                                                BrowseFilter filter)

Specified by:

browseTagDataSourcesAsync in interface TagManager

importTagDataSourcesAsync

public java.util.concurrent.CompletableFuture<QualityCode> importTagDataSourcesAsync(TagPath location,
                                                                                     java.util.List<BrowseElement> elements)

Specified by:

importTagDataSourcesAsync in interface ClientTagManager

browseAsync

public java.util.concurrent.CompletableFuture<Results<NodeDescription>> browseAsync(TagPath tagPath,
                                                                                    BrowseFilter browseFilter)

Specified by:

browseAsync in interface TagManager

readAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualifiedValue>> readAsync(java.util.List<TagPath> tagPaths,
                                                                                        SecurityContext security)

Specified by:

readAsync in interface TagManager

writeAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> writeAsync(java.util.List<TagPath> tagPaths,
                                                                                      java.util.List<java.lang.Object> values,
                                                                                      SecurityContext security)

Specified by:

writeAsync in interface TagManager

subscribeAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> subscribeAsync(java.util.List<TagPath> tagPaths,
                                                                             java.util.List<TagChangeListener> listeners)

Specified by:

subscribeAsync in interface TagManager

unsubscribeAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> unsubscribeAsync(java.util.List<TagPath> tagPaths,
                                                                               java.util.List<TagChangeListener> listeners)

Specified by:

unsubscribeAsync in interface TagManager

getProviderProperties

public java.util.List<TagProviderProps> getProviderProperties()

Specified by:

getProviderProperties in interface ClientTagManager

getDefaultProvider

public ClientTagProvider getDefaultProvider()

Specified by:

getDefaultProvider in interface ClientTagManager

getProviderProperties

public TagProviderProps getProviderProperties(java.lang.String provider)

Specified by:

getProviderProperties in interface ClientTagManager

saveTagConfigsAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> saveTagConfigsAsync(java.util.List<TagEdit> tagEdits,
                                                                                               CollisionPolicy collisionPolicy)

Specified by:

saveTagConfigsAsync in interface ClientTagManager

moveTagsAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> moveTagsAsync(java.util.List<TagPath> tags,
                                                                                         TagPath destination,
                                                                                         boolean copy,
                                                                                         CollisionPolicy collisionPolicy)

Specified by:

moveTagsAsync in interface ClientTagManager

getTagConfigsAsync

public java.util.concurrent.CompletableFuture<java.util.List<TagEditModel>> getTagConfigsAsync(java.util.List<TagPath> tagPaths,
                                                                                               boolean recursive,
                                                                                               boolean localPropsOnly)

Specified by:

getTagConfigsAsync in interface ClientTagManager

getTagGroupConfigModelAsync

public java.util.concurrent.CompletableFuture<ConfigurationPropertyModel> getTagGroupConfigModelAsync(java.lang.String provider)

Specified by:

getTagGroupConfigModelAsync in interface TagManager

getTagConfigModelAsync

public java.util.concurrent.CompletableFuture<ConfigurationPropertyModel> getTagConfigModelAsync(java.lang.String provider)

Specified by:

getTagConfigModelAsync in interface TagManager

getTagGroupsAsync

public java.util.concurrent.CompletableFuture<java.util.List<TagGroupConfiguration>> getTagGroupsAsync(java.lang.String provider)

Specified by:

getTagGroupsAsync in interface TagManager

getDiagnosticsAsync

public java.util.concurrent.CompletableFuture<TagDiagnostics> getDiagnosticsAsync(TagPath path)

Specified by:

getDiagnosticsAsync in interface TagManager

importTagsAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> importTagsAsync(TagPath basePath,
                                                                                           java.lang.String importText,
                                                                                           java.lang.String importType,
                                                                                           CollisionPolicy collisionPolicy)

Specified by:

importTagsAsync in interface TagManager

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).

removeTagsAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> removeTagsAsync(java.util.List<TagPath> tagPaths)

Specified by:

removeTagsAsync in interface ClientTagManager

requestTagGroupExecution

public void requestTagGroupExecution(java.lang.String provider,
                                     java.lang.String tagGroup)
                              throws java.lang.Exception

Specified by:

requestTagGroupExecution in interface ClientTagManager

Throws:

java.lang.Exception

getAttributeManager

public TagAttributeManager getAttributeManager()

Specified by:

getAttributeManager in interface ClientTagManager

reinitializeTagsAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> reinitializeTagsAsync(java.util.List<TagPath> tagPaths)

Specified by:

reinitializeTagsAsync in interface ClientTagManager

browseHistoricalTagsAsync

public java.util.concurrent.CompletableFuture<Results<Result>> browseHistoricalTagsAsync(QualifiedPath root,
                                                                                         BrowseFilter filter)

Specified by:

browseHistoricalTagsAsync in interface ClientTagManager

getTypeDefinition

public UdtDefinitionInfo getTypeDefinition(TagPath typeId)

Specified by:

getTypeDefinition in interface ClientTagManager

isAncestorOf

public boolean isAncestorOf(TagPath baseTypeId,
                            TagPath potentialSubTypeId)

Description copied from interface: ClientTagManager

Returns true if the second argument is equal to or subtype of the first argument.

Specified by:

isAncestorOf in interface ClientTagManager