Package com.inductiveautomation.ignition.gateway.tags.model

Class ProjectDefaultTagManagerFacade

java.lang.Object

com.inductiveautomation.ignition.gateway.tags.model.ProjectDefaultTagManagerFacade

All Implemented Interfaces:

TagManager, TagHistoryManager

public abstract class ProjectDefaultTagManagerFacade
extends Object
implements TagManager, TagHistoryManager

A tag manager that translates tag paths sources between the "default" source of empty string and the absolute name of a project's default tag provider

Field Summary

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

BROWSE_LOCAL_SYSTEM, DATA_SOURCE_OPC

Constructor Summary

Constructors

Constructor	Description
ProjectDefaultTagManagerFacade(GatewayContext context, LoggerEx logger)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Results<NodeDescription>>	browseAsync(TagPath tagPath, BrowseFilter filter)
CompletableFuture<Results<NodeDescription>>	browseAsync(TagPath tagPath, BrowseFilter filter, SecurityContext securityContext)
Results<Result>	browseHistoricalTags(QualifiedPath root, BrowseFilter filter)
Results<Result>	browseHistoricalTags(QualifiedPath root, BrowseFilter filter, boolean bustCache)
CompletableFuture<Results<BrowseElement>>	browseTagDataSourcesAsync(String provider, BrowseElement root, BrowseFilter filter)
protected abstract String	getDefaultDatabaseName()
protected abstract String	getDefaultTagProvider()
CompletableFuture<TagDiagnostics>	getDiagnosticsAsync(TagPath path)
CompletableFuture<ConfigurationPropertyModel>	getTagConfigModelAsync(String provider)
CompletableFuture<ConfigurationPropertyModel>	getTagGroupConfigModelAsync(String provider)
CompletableFuture<List<TagGroupConfiguration>>	getTagGroupsAsync(String provider)
List<String>	getTagHistoryProviders()	Returns the names of all of the registered tag history providers.
CompletableFuture<List<QualityCode>>	importTagsAsync(TagPath basePath, String importText, String importType, CollisionPolicy collisionPolicy)
CompletableFuture<List<QualityCode>>	importTagsAsync(TagPath basePath, String importText, String importType, CollisionPolicy collisionPolicy, SecurityContext securityContext)
boolean	matches(String defaultTagProvider, String defaultDatabaseName)
CompletableFuture<List<QualityCode>>	moveTagsAsync(List<TagPath> tags, TagPath destination, boolean copy, CollisionPolicy collisionPolicy, SecurityContext securityContext)	Copies tags from any sources to a specific destination.
List<Annotation>	queryAnnotations(List<? extends Path> path, Date start, Date end, TypeFilter filter)
void	queryHistory(TagHistoryQueryParams query, StreamingDatasetWriter writer)	Queries the tag history system for the data as defined by the query parameters.
void	queryHistoryDensity(StreamingDatasetWriter writer, List<? extends Path> paths, Date start, Date end)	Queries the tag store for data density information.
CompletableFuture<List<QualifiedValue>>	readAsync(List<TagPath> tagPaths, SecurityContext security)
void	setDefaultTagProvider(String newProvider)
List<QualifiedValue>	storeAnnotations(List<Annotation> annotations)	Stores the given annotations.
CompletableFuture<Void>	subscribeAsync(List<TagPath> paths, List<TagChangeListener> listeners)
CompletableFuture<Void>	unsubscribeAsync(List<TagPath> paths, List<TagChangeListener> listeners)
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.common.tags.model.TagManager

moveTagsAsync, readAsync, reinitializeTags, subscribeAsync, unsubscribeAsync, writeAsync

Constructor Details

ProjectDefaultTagManagerFacade

public ProjectDefaultTagManagerFacade(GatewayContext context,
 LoggerEx logger)

Method Details

matches

public boolean matches(String defaultTagProvider,
 String defaultDatabaseName)

getDefaultTagProvider

@Nullable
protected abstract String getDefaultTagProvider()

getDefaultDatabaseName

@Nullable
protected abstract String getDefaultDatabaseName()

browseTagDataSourcesAsync

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

Specified by:

browseTagDataSourcesAsync in interface TagManager

subscribeAsync

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

Specified by:

subscribeAsync in interface TagManager

unsubscribeAsync

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

Specified by:

unsubscribeAsync in interface TagManager

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

browseAsync

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

Specified by:

browseAsync in interface TagManager

browseAsync

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

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

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

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

importTagsAsync

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

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

securityContext - the SecurityContext of the user from the call site

setDefaultTagProvider

public void setDefaultTagProvider(String newProvider)

browseHistoricalTags

public Results<Result> browseHistoricalTags(QualifiedPath root,
 BrowseFilter filter)

Specified by:

browseHistoricalTags in interface TagHistoryManager

browseHistoricalTags

public Results<Result> browseHistoricalTags(QualifiedPath root,
 BrowseFilter filter,
 boolean bustCache)

Specified by:

browseHistoricalTags in interface TagHistoryManager

getTagHistoryProviders

public List<String> getTagHistoryProviders()

Description copied from interface: TagHistoryManager

Returns the names of all of the registered tag history providers. The return list is immutable.

Specified by:

getTagHistoryProviders in interface TagHistoryManager

queryHistory

public void queryHistory(TagHistoryQueryParams query,
 StreamingDatasetWriter writer)

Description copied from interface: TagHistoryManager

Queries the tag history system for the data as defined by the query parameters. The results are written to the provided StreamingDatasetWriter. This allows results to be streamed and not collected in memory. However, in order to get a simple Dataset result, simply use the BasicStreamingDataset.

Specified by:

queryHistory in interface TagHistoryManager

queryHistoryDensity

public void queryHistoryDensity(StreamingDatasetWriter writer,
 List<? extends Path> paths,
 Date start,
 Date end)
                         throws Exception

Description copied from interface: TagHistoryManager

Queries the tag store for data density information. Will return a structure with two columns: a timestamp, and the "weight", which is not really defined, but instead relative across the return set. The weight is valid until the next entry.

Specified by:

queryHistoryDensity in interface TagHistoryManager

Throws:

Exception

queryAnnotations

public List<Annotation> queryAnnotations(List<? extends Path> path,
 Date start,
 Date end,
 TypeFilter filter)

Specified by:

queryAnnotations in interface TagHistoryManager

storeAnnotations

public List<QualifiedValue> storeAnnotations(List<Annotation> annotations)

Description copied from interface: TagHistoryManager

Stores the given annotations. Returns the new id of the stored annotation, if the quality code is good.

Specified by:

storeAnnotations in interface TagHistoryManager

Returns:

a 1-to-1 result for each annotation, with the result quality, and the new storage id if successful.