Package com.inductiveautomation.ignition.client.sqltags.impl

Class SubManagerAdapter

java.lang.Object

com.inductiveautomation.ignition.client.sqltags.impl.SubManagerAdapter

All Implemented Interfaces:

ClientTagProvider, TagProvider

public class SubManagerAdapter
extends java.lang.Object
implements ClientTagProvider

Constructor Summary

Constructors

Constructor	Description
SubManagerAdapter(ClientSubManager target, TagProviderProps props)
SubManagerAdapter(java.lang.String name, ClientSubManager target)

Method Summary

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()
ClientSubManager	getTarget()
protected QualifiedValue	handleModernProp(TagPath p)
protected java.lang.Boolean	hasModernProp(TagPath p)
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)
protected TagPath	mapToClientProp(TagPath modernPath)
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 security)
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)
protected NodeDescription	toNodeBrowseInfo(Tag t)
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 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.ClientTagProvider

browseAsync, importTagsAsync

Methods inherited from interface com.inductiveautomation.ignition.common.tags.model.TagProvider

reinitializeTagsAsync, removeTagConfigsAsync, saveTagConfigsAsync

Constructor Detail

SubManagerAdapter

public SubManagerAdapter(java.lang.String name,
                         ClientSubManager target)

SubManagerAdapter

public SubManagerAdapter(ClientSubManager target,
                         TagProviderProps props)

Method Detail

getTarget

public ClientSubManager getTarget()

browseAsync

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

Specified by:

browseAsync in interface TagProvider

toNodeBrowseInfo

protected NodeDescription toNodeBrowseInfo(Tag t)

getName

public java.lang.String getName()

Specified by:

getName in interface TagProvider

Returns:

the name of the tag provider

getPropertiesAsync

public java.util.concurrent.CompletableFuture<TagProviderProps> getPropertiesAsync()

Specified by:

getPropertiesAsync in interface TagProvider

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 ClientTagProvider

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 ClientTagProvider

browseTagDataSourcesAsync

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

Specified by:

browseTagDataSourcesAsync in interface TagProvider

readAsync

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

Specified by:

readAsync in interface TagProvider

writeAsync

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

Specified by:

writeAsync in interface TagProvider

removeTagConfigsAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> removeTagConfigsAsync(java.util.List<TagPath> tagPaths,
                                                                                                 SecurityContext securityContext)

Specified by:

removeTagConfigsAsync in interface TagProvider

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

getTagConfigsAsync

public java.util.concurrent.CompletableFuture<java.util.List<TagConfigurationModel>> getTagConfigsAsync(java.util.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 java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> saveTagConfigsAsync(java.util.List<TagConfiguration> tagEdits,
                                                                                               CollisionPolicy collisionPolicy,
                                                                                               SecurityContext securityContext)

Specified by:

saveTagConfigsAsync in interface TagProvider

getTagGroupsAsync

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

Specified by:

getTagGroupsAsync in interface TagProvider

saveTagGroupsAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> saveTagGroupsAsync(java.util.List<TagGroupConfiguration> tagGroups)

Specified by:

saveTagGroupsAsync in interface TagProvider

removeTagGroupsAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> removeTagGroupsAsync(java.util.List<java.lang.String> tagGroupNames)

Specified by:

removeTagGroupsAsync in interface TagProvider

getTagGroupConfigModelAsync

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

Specified by:

getTagGroupConfigModelAsync in interface TagProvider

getTagConfigModelAsync

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

Specified by:

getTagConfigModelAsync in interface TagProvider

getDiagnosticsAsync

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

Specified by:

getDiagnosticsAsync in interface TagProvider

getStatusInformation

public java.util.concurrent.CompletableFuture<TagProviderInformation> getStatusInformation()

Specified by:

getStatusInformation in interface TagProvider

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

importTagDataSourcesAsync

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

Specified by:

importTagDataSourcesAsync in interface ClientTagProvider

startup

public void startup()

Specified by:

startup in interface ClientTagProvider

shutdown

public void shutdown()

Specified by:

shutdown in interface ClientTagProvider

handleModernProp

protected QualifiedValue handleModernProp(TagPath p)

hasModernProp

protected java.lang.Boolean hasModernProp(TagPath p)

mapToClientProp

protected TagPath mapToClientProp(TagPath modernPath)