Package com.inductiveautomation.ignition.client.tags.impl

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

Modifier and Type	Method	Description
CompletableFuture<Results<NodeDescription>>	browseAsync(TagPath tagPath, BrowseFilter filter)
CompletableFuture<Results<BrowseElement>>	browseTagDataSourcesAsync(BrowseElement root, BrowseFilter filter)
CompletableFuture<TagDiagnostics>	getDiagnosticsAsync(TagPath path)
String	getName()
CompletableFuture<TagProviderProps>	getPropertiesAsync()
CompletableFuture<TagProviderInformation>	getStatusInformation()
CompletableFuture<ConfigurationPropertyModel>	getTagConfigModelAsync()
CompletableFuture<List<TagConfigurationModel>>	getTagConfigsAsync(List<TagPath> tagPaths, boolean recursive, boolean localPropsOnly)
CompletableFuture<ConfigurationPropertyModel>	getTagGroupConfigModelAsync()
CompletableFuture<List<TagGroupConfiguration>>	getTagGroupsAsync()
CompletableFuture<QualityCode>	importTagDataSourcesAsync(TagPath location, List<BrowseElement> elements)
CompletableFuture<List<QualityCode>>	importTagsAsync(TagPath basePath, String importText, String importType, CollisionPolicy cp)
CompletableFuture<List<QualityCode>>	moveTagsAsync(List<TagPath> tags, TagPath destination, boolean copy, CollisionPolicy collisionPolicy, SecurityContext securityContext)
CompletableFuture<List<QualifiedValue>>	readAsync(List<TagPath> tagPaths, SecurityContext securityContext)
CompletableFuture<List<QualityCode>>	removeTagConfigsAsync(List<TagPath> tagPaths, SecurityContext securityContext)
CompletableFuture<List<QualityCode>>	removeTagGroupsAsync(List<String> tagGroupNames, SecurityContext securityContext)
CompletableFuture<List<QualityCode>>	saveTagConfigsAsync(List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy, SecurityContext securityContext)
CompletableFuture<List<QualityCode>>	saveTagGroupsAsync(List<TagGroupConfiguration> tagGroups, SecurityContext securityContext)
void	shutdown()
void	startup()
CompletableFuture<Void>	subscribeAsync(List<TagPath> tagPaths, List<TagChangeListener> listeners)
CompletableFuture<Void>	unsubscribeAsync(List<TagPath> tagPaths, List<TagChangeListener> listeners)
CompletableFuture<List<QualityCode>>	writeAsync(List<TagPath> tagPaths, 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, removeTagGroupsAsync, saveTagConfigsAsync, saveTagGroupsAsync

Constructor Details

ErrorClientTagProvider

protected ErrorClientTagProvider()

Method Details

subscribeAsync

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

Specified by:

subscribeAsync in interface ClientTagProvider

unsubscribeAsync

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

Specified by:

unsubscribeAsync in interface ClientTagProvider

importTagDataSourcesAsync

public CompletableFuture<QualityCode> importTagDataSourcesAsync(TagPath location,
 List<BrowseElement> elements)

Specified by:

importTagDataSourcesAsync in interface ClientTagProvider

moveTagsAsync

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

Specified by:

moveTagsAsync in interface ClientTagProvider

startup

public void startup()

Specified by:

startup in interface ClientTagProvider

shutdown

public void shutdown()

Specified by:

shutdown in interface ClientTagProvider

browseTagDataSourcesAsync

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

Specified by:

browseTagDataSourcesAsync in interface TagProvider

browseAsync

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

Specified by:

browseAsync in interface TagProvider

readAsync

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

Specified by:

readAsync in interface TagProvider

writeAsync

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

Specified by:

writeAsync in interface TagProvider

getTagConfigsAsync

public CompletableFuture<List<TagConfigurationModel>> getTagConfigsAsync(List<TagPath> tagPaths,
 boolean recursive,
 boolean localPropsOnly)

Specified by:

getTagConfigsAsync in interface TagProvider

Parameters:

tagPaths - a List of TagPath objects

recursive - 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 CompletableFuture<List<QualityCode>> saveTagConfigsAsync(List<TagConfiguration> tagEdits,
 CollisionPolicy collisionPolicy,
 SecurityContext securityContext)

Specified by:

saveTagConfigsAsync in interface TagProvider

removeTagConfigsAsync

public CompletableFuture<List<QualityCode>> removeTagConfigsAsync(List<TagPath> tagPaths,
 SecurityContext securityContext)

Specified by:

removeTagConfigsAsync in interface TagProvider

getTagGroupsAsync

public CompletableFuture<List<TagGroupConfiguration>> getTagGroupsAsync()

Specified by:

getTagGroupsAsync in interface TagProvider

saveTagGroupsAsync

public CompletableFuture<List<QualityCode>> saveTagGroupsAsync(List<TagGroupConfiguration> tagGroups,
 SecurityContext securityContext)

Specified by:

saveTagGroupsAsync in interface TagProvider

removeTagGroupsAsync

public CompletableFuture<List<QualityCode>> removeTagGroupsAsync(List<String> tagGroupNames,
 SecurityContext securityContext)

Specified by:

removeTagGroupsAsync in interface TagProvider

getPropertiesAsync

public CompletableFuture<TagProviderProps> getPropertiesAsync()

Specified by:

getPropertiesAsync in interface TagProvider

getTagGroupConfigModelAsync

public CompletableFuture<ConfigurationPropertyModel> getTagGroupConfigModelAsync()

Specified by:

getTagGroupConfigModelAsync in interface TagProvider

getTagConfigModelAsync

public CompletableFuture<ConfigurationPropertyModel> getTagConfigModelAsync()

Specified by:

getTagConfigModelAsync in interface TagProvider

getDiagnosticsAsync

public CompletableFuture<TagDiagnostics> getDiagnosticsAsync(TagPath path)

Specified by:

getDiagnosticsAsync in interface TagProvider

getStatusInformation

public CompletableFuture<TagProviderInformation> getStatusInformation()

Specified by:

getStatusInformation in interface TagProvider

importTagsAsync

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

Specified by:

importTagsAsync in interface TagProvider

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.

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 String getName()

Specified by:

getName in interface TagProvider

Returns:

the name of the tag provider