Class GatewayTagInterface.ErrorClientTagProvider
- java.lang.Object
-
- com.inductiveautomation.ignition.client.tags.impl.GatewayTagInterface.ErrorClientTagProvider
-
- All Implemented Interfaces:
ClientTagProvider
,TagProvider
- Enclosing class:
- GatewayTagInterface
protected static class GatewayTagInterface.ErrorClientTagProvider extends java.lang.Object implements ClientTagProvider
This ClientTagProvider is used when the default tag provider is not set on the project. Tag values will result in Bad / Not Found. Subscriptions will result in no-ops. See FB12703
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ErrorClientTagProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.concurrent.CompletableFuture<Results<NodeDescription>>
browseAsync(TagPath tagPath, BrowseFilter filter)
java.util.concurrent.CompletableFuture<Results<BrowseElement>>
browseTagDataSourcesAsync(BrowseElement root, BrowseFilter filter)
java.util.concurrent.CompletableFuture<TagDiagnostics>
getDiagnosticsAsync(TagPath path)
java.lang.String
getName()
java.util.concurrent.CompletableFuture<TagProviderProps>
getPropertiesAsync()
java.util.concurrent.CompletableFuture<TagProviderInformation>
getStatusInformation()
java.util.concurrent.CompletableFuture<ConfigurationPropertyModel>
getTagConfigModelAsync()
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.util.concurrent.CompletableFuture<java.util.List<TagGroupConfiguration>>
getTagGroupsAsync()
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 cp)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
moveTagsAsync(java.util.List<TagPath> tags, TagPath destination, boolean copy, CollisionPolicy collisionPolicy, SecurityContext securityContext)
java.util.concurrent.CompletableFuture<java.util.List<QualifiedValue>>
readAsync(java.util.List<TagPath> tagPaths, SecurityContext securityContext)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
removeTagConfigsAsync(java.util.List<TagPath> tagPaths, SecurityContext securityContext)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
removeTagGroupsAsync(java.util.List<java.lang.String> tagGroupNames)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
saveTagConfigsAsync(java.util.List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy, SecurityContext securityContext)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
saveTagGroupsAsync(java.util.List<TagGroupConfiguration> tagGroups)
void
shutdown()
void
startup()
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<QualifiedValue> values, SecurityContext securityContext)
-
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.ClientTagProvider
browseAsync, importTagsAsync
-
Methods inherited from interface com.inductiveautomation.ignition.common.tags.model.TagProvider
reinitializeTagsAsync, removeTagConfigsAsync, saveTagConfigsAsync
-
-
-
-
Method Detail
-
subscribeAsync
public java.util.concurrent.CompletableFuture<java.lang.Void> subscribeAsync(java.util.List<TagPath> tagPaths, java.util.List<TagChangeListener> listeners)
- Specified by:
subscribeAsync
in interfaceClientTagProvider
-
unsubscribeAsync
public java.util.concurrent.CompletableFuture<java.lang.Void> unsubscribeAsync(java.util.List<TagPath> tagPaths, java.util.List<TagChangeListener> listeners)
- Specified by:
unsubscribeAsync
in interfaceClientTagProvider
-
importTagDataSourcesAsync
public java.util.concurrent.CompletableFuture<QualityCode> importTagDataSourcesAsync(TagPath location, java.util.List<BrowseElement> elements)
- Specified by:
importTagDataSourcesAsync
in interfaceClientTagProvider
-
moveTagsAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> moveTagsAsync(java.util.List<TagPath> tags, TagPath destination, boolean copy, CollisionPolicy collisionPolicy, SecurityContext securityContext)
- Specified by:
moveTagsAsync
in interfaceClientTagProvider
-
startup
public void startup()
- Specified by:
startup
in interfaceClientTagProvider
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfaceClientTagProvider
-
browseTagDataSourcesAsync
public java.util.concurrent.CompletableFuture<Results<BrowseElement>> browseTagDataSourcesAsync(BrowseElement root, BrowseFilter filter)
- Specified by:
browseTagDataSourcesAsync
in interfaceTagProvider
-
browseAsync
public java.util.concurrent.CompletableFuture<Results<NodeDescription>> browseAsync(TagPath tagPath, BrowseFilter filter)
- Specified by:
browseAsync
in interfaceTagProvider
-
readAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualifiedValue>> readAsync(java.util.List<TagPath> tagPaths, SecurityContext securityContext)
- Specified by:
readAsync
in interfaceTagProvider
-
writeAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> writeAsync(java.util.List<TagPath> tagPaths, java.util.List<QualifiedValue> values, SecurityContext securityContext)
- Specified by:
writeAsync
in interfaceTagProvider
-
getTagConfigsAsync
public java.util.concurrent.CompletableFuture<java.util.List<TagConfigurationModel>> getTagConfigsAsync(java.util.List<TagPath> tagPaths, boolean recursive, boolean localPropsOnly)
- Specified by:
getTagConfigsAsync
in interfaceTagProvider
- Parameters:
tagPaths
- a List of TagPath objectsrecursive
- set to true to return all TagConfigurationModels under a TagPath. Useful for returning models for child tags under a UDT.localPropsOnly
- set to True to only return configuration created by a user (aka no inherited properties). Useful for tag export and tag UI edits of raw JSON text.- Returns:
- a list of TagConfigurationModels, one for each passed tagPath.
-
saveTagConfigsAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> saveTagConfigsAsync(java.util.List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy, SecurityContext securityContext)
- Specified by:
saveTagConfigsAsync
in interfaceTagProvider
-
removeTagConfigsAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> removeTagConfigsAsync(java.util.List<TagPath> tagPaths, SecurityContext securityContext)
- Specified by:
removeTagConfigsAsync
in interfaceTagProvider
-
getTagGroupsAsync
public java.util.concurrent.CompletableFuture<java.util.List<TagGroupConfiguration>> getTagGroupsAsync()
- Specified by:
getTagGroupsAsync
in interfaceTagProvider
-
saveTagGroupsAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> saveTagGroupsAsync(java.util.List<TagGroupConfiguration> tagGroups)
- Specified by:
saveTagGroupsAsync
in interfaceTagProvider
-
removeTagGroupsAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> removeTagGroupsAsync(java.util.List<java.lang.String> tagGroupNames)
- Specified by:
removeTagGroupsAsync
in interfaceTagProvider
-
getPropertiesAsync
public java.util.concurrent.CompletableFuture<TagProviderProps> getPropertiesAsync()
- Specified by:
getPropertiesAsync
in interfaceTagProvider
-
getTagGroupConfigModelAsync
public java.util.concurrent.CompletableFuture<ConfigurationPropertyModel> getTagGroupConfigModelAsync()
- Specified by:
getTagGroupConfigModelAsync
in interfaceTagProvider
-
getTagConfigModelAsync
public java.util.concurrent.CompletableFuture<ConfigurationPropertyModel> getTagConfigModelAsync()
- Specified by:
getTagConfigModelAsync
in interfaceTagProvider
-
getDiagnosticsAsync
public java.util.concurrent.CompletableFuture<TagDiagnostics> getDiagnosticsAsync(TagPath path)
- Specified by:
getDiagnosticsAsync
in interfaceTagProvider
-
getStatusInformation
public java.util.concurrent.CompletableFuture<TagProviderInformation> getStatusInformation()
- Specified by:
getStatusInformation
in interfaceTagProvider
-
importTagsAsync
public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> importTagsAsync(TagPath basePath, java.lang.String importText, java.lang.String importType, CollisionPolicy cp)
- Specified by:
importTagsAsync
in interfaceTagProvider
- 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.cp
- The collision policy to use. The collision policy will apply to individual tags, which means that some tag imports may succeed, while others may not.
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceTagProvider
- Returns:
- the name of the tag provider
-
-