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 enum	TagProviderService2.SubscriptionState

Method Summary

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

Method Details

getProperties

TagProviderProps getProperties(String provider)

getProviders

List<String> getProviders()

read

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

write

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

browse

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

browseTagDataSources

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

getTagDiagnostics

TagDiagnostics getTagDiagnostics(TagPath tagPath)

modifySubscription

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

cancelSubscription

void cancelSubscription(String callbackServer,
 String callbackIntent)

validateSubscription

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

getTagConfigs

List<TagConfigurationModel> getTagConfigs(String provider,
 List<TagPath> tagPaths,
 boolean recursive,
 boolean localPropsOnly)

saveTagConfigs

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

moveTags

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

removeTagConfigs

List<QualityCode> removeTagConfigs(String provider,
 List<TagPath> tagPaths,
 SecurityContext security)

getTagGroups

List<TagGroupConfiguration> getTagGroups(String provider)

saveTagGroups

List<QualityCode> saveTagGroups(String provider,
 List<TagGroupConfiguration> tagGroups,
 SecurityContext security)

removeTagGroups

List<QualityCode> removeTagGroups(String provider,
 List<String> tagGroupNames,
 SecurityContext security)

getTagGroupConfigModel

ConfigurationPropertyModel getTagGroupConfigModel(String provider)

getTagConfigModel

ConfigurationPropertyModel getTagConfigModel(String provider)

importTagsAsync

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

creatorBrowse

Results<NodeDescription> creatorBrowse(String provider,
 String sessionKey,
 TagPath tagPath,
 boolean single,
 SecurityContext securityContext)

creatorModify

PropertySet creatorModify(String provider,
 String session,
 PropertySet changes,
 SecurityContext securityContext)

query

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

getTagCount

Integer getTagCount(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