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

Modifier and Type	Method	Description
void	addClientTagProvider(ClientTagProvider provider)
CompletableFuture<Results<NodeDescription>>	browseAsync(TagPath tagPath, BrowseFilter browseFilter)
CompletableFuture<Results<Result>>	browseHistoricalTagsAsync(QualifiedPath root, BrowseFilter filter)
CompletableFuture<Results<BrowseElement>>	browseTagDataSourcesAsync(String provider, BrowseElement root, BrowseFilter filter)
void	copyTagsToClipboard(List<TagPath> tagPaths, boolean removeOriginalTags)
CompletableFuture<Results<NodeDescription>>	creatorBrowse(String provider, String session, TagPath path, boolean single)
CompletableFuture<PropertySet>	creatorModify(String provider, String session, PropertySet changes)
QualityCode	deleteAllTagReference(String providerName)
QualityCode	deleteTagReferences(TagPath path, Long afterTime, Long beforeTime)
TagAttributeManager	getAttributeManager()
ClientTagProvider	getClientTagProvider(String provider)
ClientTagProvider	getDefaultProvider()
CompletableFuture<TagDiagnostics>	getDiagnosticsAsync(TagPath path)
StatMetric	getPollingMetric()
List<TagProviderProps>	getProviderProperties()
TagProviderProps	getProviderProperties(String provider)
protected String	getSource(TagPath path)
SystemTagManager	getSystemTagManager()
CompletableFuture<ConfigurationPropertyModel>	getTagConfigModelAsync(String provider)
CompletableFuture<List<TagConfigurationModel>>	getTagConfigsAsync(List<TagPath> tagPaths, boolean recursive, boolean localPropsOnly)
CompletableFuture<ConfigurationPropertyModel>	getTagGroupConfigModelAsync(String provider)
CompletableFuture<List<TagGroupConfiguration>>	getTagGroupsAsync(String provider)
Results<com.inductiveautomation.ignition.common.tags.config.model.TagReference>	getTagReferences(com.inductiveautomation.ignition.common.tags.config.model.TagReferenceQuery query)
Results<com.inductiveautomation.ignition.common.tags.query.TagReportSearch>	getTagReportSearches()
UdtDefinitionInfo	getTypeDefinition(TagPath typeId)
Map<TagPath,UdtDefinitionInfo>	getTypeDefinitions(List<TagPath> typeIds)
StatMetric	getValueChangeMetric()
CompletableFuture<QualityCode>	importTagDataSourcesAsync(TagPath location, List<BrowseElement> elements)
CompletableFuture<List<QualityCode>>	importTagsAsync(TagPath basePath, String importText, 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.
CompletableFuture<List<QualityCode>>	moveTagsAsync(List<TagPath> tags, TagPath destination, boolean copy, CollisionPolicy collisionPolicy, SecurityContext securityContext)	Copies tags from any sources to a specific destination.
CompletableFuture<List<QualityCode>>	pasteFromClipboard(TagPath destination)
protected ClientTagProvider	provider(TagPath path)
Results<NodeDescription>	query(String provider, TagQueryFilter filter)
CompletableFuture<List<QualifiedValue>>	readAsync(List<TagPath> tagPaths, SecurityContext security)
CompletableFuture<List<QualityCode>>	reinitializeTagsAsync(List<TagPath> tagPaths)
CompletableFuture<List<QualityCode>>	removeTagsAsync(List<TagPath> tagPaths, SecurityContext securityContext)
CompletableFuture<QualityCode>	renameTagAsync(TagPath tag, String newName, CollisionPolicy collisionPolicy, SecurityContext securityContext)
void	requestTagGroupExecution(String provider, String tagGroup)
CompletableFuture<List<QualityCode>>	saveTagConfigsAsync(List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy, SecurityContext securityContext)
void	shutdown()
CompletableFuture<Void>	subscribeAsync(List<TagPath> tagPaths, List<TagChangeListener> listeners)
CompletableFuture<Void>	unsubscribeAsync(List<TagPath> tagPaths, List<TagChangeListener> listeners)
Results<com.inductiveautomation.ignition.common.tags.query.TagReportSearch>	updateTagReportSearch(com.inductiveautomation.ignition.common.tags.query.TagReportSearch search, boolean delete)
CompletableFuture<List<QualityCode>>	writeAsync(List<TagPath> tagPaths, List<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

browseAsync, importTagsAsync, renameTagAsync

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

moveTagsAsync, readAsync, reinitializeTags, subscribeAsync, unsubscribeAsync, writeAsync

Constructor Details

ClientTagManagerImpl

public ClientTagManagerImpl(ClientContext clientContext)

Method Details

shutdown

public void shutdown()

getSystemTagManager

public SystemTagManager getSystemTagManager()

Specified by:

getSystemTagManager in interface ClientTagManager

getPollingMetric

public StatMetric getPollingMetric()

Specified by:

getPollingMetric in interface ClientTagManager

getValueChangeMetric

public StatMetric getValueChangeMetric()

Specified by:

getValueChangeMetric in interface ClientTagManager

addClientTagProvider

public void addClientTagProvider(ClientTagProvider provider)

Specified by:

addClientTagProvider in interface ClientTagManager

getClientTagProvider

public ClientTagProvider getClientTagProvider(String provider)

Specified by:

getClientTagProvider in interface ClientTagManager

provider

protected ClientTagProvider provider(TagPath path)

getSource

protected String getSource(TagPath path)

browseTagDataSourcesAsync

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

Specified by:

browseTagDataSourcesAsync in interface TagManager

importTagDataSourcesAsync

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

Specified by:

importTagDataSourcesAsync in interface ClientTagManager

browseAsync

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

Specified by:

browseAsync in interface TagManager

readAsync

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

Specified by:

readAsync in interface TagManager

writeAsync

public CompletableFuture<List<QualityCode>> writeAsync(List<TagPath> tagPaths,
 List<Object> values,
 SecurityContext security)

Specified by:

writeAsync in interface TagManager

subscribeAsync

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

Specified by:

subscribeAsync in interface TagManager

unsubscribeAsync

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

Specified by:

unsubscribeAsync in interface TagManager

getProviderProperties

public List<TagProviderProps> getProviderProperties()

Specified by:

getProviderProperties in interface ClientTagManager

getDefaultProvider

public ClientTagProvider getDefaultProvider()

Specified by:

getDefaultProvider in interface ClientTagManager

getProviderProperties

public TagProviderProps getProviderProperties(String provider)

Specified by:

getProviderProperties in interface ClientTagManager

saveTagConfigsAsync

public CompletableFuture<List<QualityCode>> saveTagConfigsAsync(List<TagConfiguration> tagEdits,
 CollisionPolicy collisionPolicy,
 SecurityContext securityContext)

Specified by:

saveTagConfigsAsync in interface ClientTagManager

moveTagsAsync

public CompletableFuture<List<QualityCode>> moveTagsAsync(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 interface TagManager

renameTagAsync

public CompletableFuture<QualityCode> renameTagAsync(TagPath tag,
 String newName,
 CollisionPolicy collisionPolicy,
 SecurityContext securityContext)

Specified by:

renameTagAsync in interface ClientTagManager

getTagConfigsAsync

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

Specified by:

getTagConfigsAsync in interface ClientTagManager

getTagGroupConfigModelAsync

public CompletableFuture<ConfigurationPropertyModel> getTagGroupConfigModelAsync(String provider)

Specified by:

getTagGroupConfigModelAsync in interface TagManager

getTagConfigModelAsync

public CompletableFuture<ConfigurationPropertyModel> getTagConfigModelAsync(String provider)

Specified by:

getTagConfigModelAsync in interface TagManager

getTagGroupsAsync

public CompletableFuture<List<TagGroupConfiguration>> getTagGroupsAsync(String provider)

Specified by:

getTagGroupsAsync in interface TagManager

getDiagnosticsAsync

public CompletableFuture<TagDiagnostics> getDiagnosticsAsync(TagPath path)

Specified by:

getDiagnosticsAsync in interface TagManager

importTagsAsync

public CompletableFuture<List<QualityCode>> importTagsAsync(TagPath basePath,
 String importText,
 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).

creatorBrowse

public CompletableFuture<Results<NodeDescription>> creatorBrowse(String provider,
 String session,
 TagPath path,
 boolean single)

Specified by:

creatorBrowse in interface ClientTagManager

creatorModify

public CompletableFuture<PropertySet> creatorModify(String provider,
 String session,
 PropertySet changes)

Specified by:

creatorModify in interface ClientTagManager

removeTagsAsync

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

Specified by:

removeTagsAsync in interface ClientTagManager

copyTagsToClipboard

public void copyTagsToClipboard(List<TagPath> tagPaths,
 boolean removeOriginalTags)

Specified by:

copyTagsToClipboard in interface ClientTagManager

pasteFromClipboard

public CompletableFuture<List<QualityCode>> pasteFromClipboard(TagPath destination)

Specified by:

pasteFromClipboard in interface ClientTagManager

requestTagGroupExecution

public void requestTagGroupExecution(String provider,
 String tagGroup)
                              throws Exception

Specified by:

requestTagGroupExecution in interface ClientTagManager

Throws:

Exception

getAttributeManager

public TagAttributeManager getAttributeManager()

Specified by:

getAttributeManager in interface ClientTagManager

reinitializeTagsAsync

public CompletableFuture<List<QualityCode>> reinitializeTagsAsync(List<TagPath> tagPaths)

Specified by:

reinitializeTagsAsync in interface ClientTagManager

browseHistoricalTagsAsync

public 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

getTypeDefinitions

public Map<TagPath,UdtDefinitionInfo> getTypeDefinitions(List<TagPath> typeIds)
                                                  throws Exception

Specified by:

getTypeDefinitions in interface ClientTagManager

Throws:

Exception

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

query

public Results<NodeDescription> query(String provider,
 TagQueryFilter filter)

Specified by:

query in interface ClientTagManager

getTagReportSearches

public Results<com.inductiveautomation.ignition.common.tags.query.TagReportSearch> getTagReportSearches()

Specified by:

getTagReportSearches in interface ClientTagManager

updateTagReportSearch

public Results<com.inductiveautomation.ignition.common.tags.query.TagReportSearch> updateTagReportSearch(com.inductiveautomation.ignition.common.tags.query.TagReportSearch search,
 boolean delete)

Specified by:

updateTagReportSearch in interface ClientTagManager

getTagReferences

public Results<com.inductiveautomation.ignition.common.tags.config.model.TagReference> getTagReferences(com.inductiveautomation.ignition.common.tags.config.model.TagReferenceQuery query)

Specified by:

getTagReferences in interface ClientTagManager

deleteTagReferences

public QualityCode deleteTagReferences(TagPath path,
 Long afterTime,
 Long beforeTime)

Specified by:

deleteTagReferences in interface ClientTagManager

deleteAllTagReference

public QualityCode deleteAllTagReference(String providerName)

Specified by:

deleteAllTagReference in interface ClientTagManager