Package com.inductiveautomation.ignition.gateway.tags.distributed

Interface TagProviderService2

public interface TagProviderService2

Implements all of the functions necessary for remote tag providers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TagProviderService2.SubscriptionState

Method Summary

Modifier and Type	Method	Description
Results<NodeDescription>	browse(TagPath tagPath, BrowseFilter filter, SecurityContext security)
Results<BrowseElement>	browseTagDataSources(java.lang.String provider, BrowseElement root, BrowseFilter filter)
void	cancelSubscription(java.lang.String callbackServer, java.lang.String callbackIntent)
TagProviderProps	getProperties(java.lang.String provider)
java.util.List<java.lang.String>	getProviders()
ConfigurationPropertyModel	getTagConfigModel(java.lang.String provider)
java.util.List<TagConfigurationModel>	getTagConfigs(java.lang.String provider, java.util.List<TagPath> tagPaths, boolean recursive, boolean localPropsOnly)
java.lang.Integer	getTagCount(java.lang.String provider)
TagDiagnostics	getTagDiagnostics(TagPath tagPath)
ConfigurationPropertyModel	getTagGroupConfigModel(java.lang.String provider)
java.util.List<TagGroupConfiguration>	getTagGroups(java.lang.String provider)
java.util.List<QualityCode>	importTagsAsync(TagPath basePath, java.lang.String importText, java.lang.String importType, CollisionPolicy cp, SecurityContext security)
void	modifySubscription(java.lang.String callbackServer, java.lang.String callbackIntent, long currentId, SecurityTagPath[] addedPaths, SecurityTagPath[] removedPaths)
java.util.List<QualityCode>	moveTags(java.lang.String provider, java.util.List<TagPath> tags, TagPath destination, CollisionPolicy collisionPolicy, SecurityContext security)
java.util.List<QualifiedValue>	read(java.util.List<TagPath> paths, SecurityContext security)
java.util.List<QualityCode>	removeTagConfigs(java.lang.String provider, java.util.List<TagPath> tagPaths, SecurityContext security)
java.util.List<QualityCode>	removeTagGroups(java.lang.String provider, java.util.List<java.lang.String> tagGroupNames)
java.util.List<QualityCode>	saveTagConfigs(java.lang.String provider, java.util.List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy, SecurityContext security)
java.util.List<QualityCode>	saveTagGroups(java.lang.String provider, java.util.List<TagGroupConfiguration> tagGroups)
TagProviderService2.SubscriptionState	validateSubscription(java.lang.String callbackServer, java.lang.String callbackIntent, long currentId, long crc)
java.util.List<QualityCode>	write(java.util.List<TagPath> writes, java.util.List<QualifiedValue> values, SecurityContext security)

Method Detail

getProperties

TagProviderProps getProperties(java.lang.String provider)

getProviders

java.util.List<java.lang.String> getProviders()

read

java.util.List<QualifiedValue> read(java.util.List<TagPath> paths,
                                    SecurityContext security)

write

java.util.List<QualityCode> write(java.util.List<TagPath> writes,
                                  java.util.List<QualifiedValue> values,
                                  SecurityContext security)

browse

Results<NodeDescription> browse(TagPath tagPath,
                                BrowseFilter filter,
                                SecurityContext security)

browseTagDataSources

Results<BrowseElement> browseTagDataSources(java.lang.String provider,
                                            BrowseElement root,
                                            BrowseFilter filter)

getTagDiagnostics

TagDiagnostics getTagDiagnostics(TagPath tagPath)

modifySubscription

void modifySubscription(java.lang.String callbackServer,
                        java.lang.String callbackIntent,
                        long currentId,
                        SecurityTagPath[] addedPaths,
                        SecurityTagPath[] removedPaths)

cancelSubscription

void cancelSubscription(java.lang.String callbackServer,
                        java.lang.String callbackIntent)

validateSubscription

TagProviderService2.SubscriptionState validateSubscription(java.lang.String callbackServer,
                                                           java.lang.String callbackIntent,
                                                           long currentId,
                                                           long crc)

getTagConfigs

java.util.List<TagConfigurationModel> getTagConfigs(java.lang.String provider,
                                                    java.util.List<TagPath> tagPaths,
                                                    boolean recursive,
                                                    boolean localPropsOnly)

saveTagConfigs

java.util.List<QualityCode> saveTagConfigs(java.lang.String provider,
                                           java.util.List<TagConfiguration> tagEdits,
                                           CollisionPolicy collisionPolicy,
                                           SecurityContext security)

moveTags

java.util.List<QualityCode> moveTags(java.lang.String provider,
                                     java.util.List<TagPath> tags,
                                     TagPath destination,
                                     CollisionPolicy collisionPolicy,
                                     SecurityContext security)

removeTagConfigs

java.util.List<QualityCode> removeTagConfigs(java.lang.String provider,
                                             java.util.List<TagPath> tagPaths,
                                             SecurityContext security)

getTagGroups

java.util.List<TagGroupConfiguration> getTagGroups(java.lang.String provider)

saveTagGroups

java.util.List<QualityCode> saveTagGroups(java.lang.String provider,
                                          java.util.List<TagGroupConfiguration> tagGroups)

removeTagGroups

java.util.List<QualityCode> removeTagGroups(java.lang.String provider,
                                            java.util.List<java.lang.String> tagGroupNames)

getTagGroupConfigModel

ConfigurationPropertyModel getTagGroupConfigModel(java.lang.String provider)

getTagConfigModel

ConfigurationPropertyModel getTagConfigModel(java.lang.String provider)

importTagsAsync

java.util.List<QualityCode> importTagsAsync(TagPath basePath,
                                            java.lang.String importText,
                                            java.lang.String importType,
                                            CollisionPolicy cp,
                                            SecurityContext security)

getTagCount

java.lang.Integer getTagCount(java.lang.String provider)

Parameters:

provider - the remote tag provider name to target

Returns:

the tag count for the remote tag provider. values of null or < zero means the tag count is not available or not supported