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 Description ClientTagManagerImpl(ClientContext clientContext)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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)
void
copyTagsToClipboard(java.util.List<TagPath> tagPaths, boolean removeOriginalTags)
TagAttributeManager
getAttributeManager()
ClientTagProvider
getClientTagProvider(java.lang.String provider)
ClientTagProvider
getDefaultProvider()
java.util.concurrent.CompletableFuture<TagDiagnostics>
getDiagnosticsAsync(TagPath path)
StatMetric
getPollingMetric()
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<TagConfigurationModel>>
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)
StatMetric
getValueChangeMetric()
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, SecurityContext securityContext)
Copies tags from any sources to a specific destination.java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
pasteFromClipboard(TagPath destination)
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, SecurityContext securityContext)
java.util.concurrent.CompletableFuture<QualityCode>
renameTagAsync(TagPath tag, java.lang.String newName, CollisionPolicy collisionPolicy, SecurityContext securityContext)
void
requestTagGroupExecution(java.lang.String provider, java.lang.String tagGroup)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
saveTagConfigsAsync(java.util.List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy, SecurityContext securityContext)
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.client.tags.model.ClientTagManager
renameTagAsync
-
Methods inherited from interface com.inductiveautomation.ignition.common.tags.model.TagManager
moveTagsAsync, 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 interfaceClientTagManager
-
getPollingMetric
public StatMetric getPollingMetric()
- Specified by:
getPollingMetric
in interfaceClientTagManager
-
getValueChangeMetric
public StatMetric getValueChangeMetric()
- Specified by:
getValueChangeMetric
in interfaceClientTagManager
-
addClientTagProvider
public void addClientTagProvider(ClientTagProvider provider)
- Specified by:
addClientTagProvider
in interfaceClientTagManager
-
getClientTagProvider
public ClientTagProvider getClientTagProvider(java.lang.String provider)
- Specified by:
getClientTagProvider
in interfaceClientTagManager
-
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 interfaceTagManager
-
importTagDataSourcesAsync
public java.util.concurrent.CompletableFuture<QualityCode> importTagDataSourcesAsync(TagPath location, java.util.List<BrowseElement> elements)
- Specified by:
importTagDataSourcesAsync
in interfaceClientTagManager
-
browseAsync
public java.util.concurrent.CompletableFuture<Results<NodeDescription>> browseAsync(TagPath tagPath, BrowseFilter browseFilter)
- Specified by:
browseAsync
in interfaceTagManager
-
readAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualifiedValue>> readAsync(java.util.List<TagPath> tagPaths, SecurityContext security)
- Specified by:
readAsync
in interfaceTagManager
-
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 interfaceTagManager
-
subscribeAsync
public java.util.concurrent.CompletableFuture<java.lang.Void> subscribeAsync(java.util.List<TagPath> tagPaths, java.util.List<TagChangeListener> listeners)
- Specified by:
subscribeAsync
in interfaceTagManager
-
unsubscribeAsync
public java.util.concurrent.CompletableFuture<java.lang.Void> unsubscribeAsync(java.util.List<TagPath> tagPaths, java.util.List<TagChangeListener> listeners)
- Specified by:
unsubscribeAsync
in interfaceTagManager
-
getProviderProperties
public java.util.List<TagProviderProps> getProviderProperties()
- Specified by:
getProviderProperties
in interfaceClientTagManager
-
getDefaultProvider
public ClientTagProvider getDefaultProvider()
- Specified by:
getDefaultProvider
in interfaceClientTagManager
-
getProviderProperties
public TagProviderProps getProviderProperties(java.lang.String provider)
- Specified by:
getProviderProperties
in interfaceClientTagManager
-
saveTagConfigsAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> saveTagConfigsAsync(java.util.List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy, SecurityContext securityContext)
- Specified by:
saveTagConfigsAsync
in interfaceClientTagManager
-
moveTagsAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> moveTagsAsync(java.util.List<TagPath> tags, TagPath destination, boolean copy, CollisionPolicy collisionPolicy, SecurityContext securityContext)
Description copied from interface:TagManager
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.- Specified by:
moveTagsAsync
in interfaceTagManager
-
renameTagAsync
public java.util.concurrent.CompletableFuture<QualityCode> renameTagAsync(TagPath tag, java.lang.String newName, CollisionPolicy collisionPolicy, SecurityContext securityContext)
- Specified by:
renameTagAsync
in interfaceClientTagManager
-
getTagConfigsAsync
public java.util.concurrent.CompletableFuture<java.util.List<TagConfigurationModel>> getTagConfigsAsync(java.util.List<TagPath> tagPaths, boolean recursive, boolean localPropsOnly)
- Specified by:
getTagConfigsAsync
in interfaceClientTagManager
-
getTagGroupConfigModelAsync
public java.util.concurrent.CompletableFuture<ConfigurationPropertyModel> getTagGroupConfigModelAsync(java.lang.String provider)
- Specified by:
getTagGroupConfigModelAsync
in interfaceTagManager
-
getTagConfigModelAsync
public java.util.concurrent.CompletableFuture<ConfigurationPropertyModel> getTagConfigModelAsync(java.lang.String provider)
- Specified by:
getTagConfigModelAsync
in interfaceTagManager
-
getTagGroupsAsync
public java.util.concurrent.CompletableFuture<java.util.List<TagGroupConfiguration>> getTagGroupsAsync(java.lang.String provider)
- Specified by:
getTagGroupsAsync
in interfaceTagManager
-
getDiagnosticsAsync
public java.util.concurrent.CompletableFuture<TagDiagnostics> getDiagnosticsAsync(TagPath path)
- Specified by:
getDiagnosticsAsync
in interfaceTagManager
-
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 interfaceTagManager
- 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 importimportType
- 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, SecurityContext securityContext)
- Specified by:
removeTagsAsync
in interfaceClientTagManager
-
copyTagsToClipboard
public void copyTagsToClipboard(java.util.List<TagPath> tagPaths, boolean removeOriginalTags)
- Specified by:
copyTagsToClipboard
in interfaceClientTagManager
-
pasteFromClipboard
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> pasteFromClipboard(TagPath destination)
- Specified by:
pasteFromClipboard
in interfaceClientTagManager
-
requestTagGroupExecution
public void requestTagGroupExecution(java.lang.String provider, java.lang.String tagGroup) throws java.lang.Exception
- Specified by:
requestTagGroupExecution
in interfaceClientTagManager
- Throws:
java.lang.Exception
-
getAttributeManager
public TagAttributeManager getAttributeManager()
- Specified by:
getAttributeManager
in interfaceClientTagManager
-
reinitializeTagsAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> reinitializeTagsAsync(java.util.List<TagPath> tagPaths)
- Specified by:
reinitializeTagsAsync
in interfaceClientTagManager
-
browseHistoricalTagsAsync
public java.util.concurrent.CompletableFuture<Results<Result>> browseHistoricalTagsAsync(QualifiedPath root, BrowseFilter filter)
- Specified by:
browseHistoricalTagsAsync
in interfaceClientTagManager
-
getTypeDefinition
public UdtDefinitionInfo getTypeDefinition(TagPath typeId)
- Specified by:
getTypeDefinition
in interfaceClientTagManager
-
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 interfaceClientTagManager
-
-