Interface GatewayTagManager
-
- All Superinterfaces:
ExtensionPointManager
,TagManager
public interface GatewayTagManager extends TagManager, ExtensionPointManager
-
-
Field Summary
-
Fields inherited from interface com.inductiveautomation.ignition.common.tags.model.TagManager
BROWSE_LOCAL_SYSTEM, DATA_SOURCE_OPC
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
addTagStructureListener(java.lang.String provider, TagStructureListener listener)
Adds a listener that will be notified when tags are added, removed, or renamed.TagConfigurationManager
getConfigManager()
int
getLicensedTagCount()
int
getLicensedTagLimit()
ManagedTagProvider
getOrCreateManagedProvider(ProviderConfiguration config)
Creates a ManagedTagProvider with the given configuration.GatewaySystemTags
getSystemTags()
Returns the tag provider for gateway status tags.@Nullable TagProvider
getTagProvider(java.lang.String name)
java.util.List<java.lang.String>
getTagProviderNames()
java.util.List<TagProvider>
getTagProviders()
default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
pasteTags(java.util.List<TagConfigurationModel> tagConfigs, TagPath destination, boolean removeOriginal)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
pasteTags(java.util.List<TagConfigurationModel> tagConfigs, TagPath destination, boolean removeOriginal, SecurityContext securityContext)
Copies tagConfigs to the destination pathvoid
registerProviderType(TagProviderExtensionPointType providerType)
void
removeTagStructureListener(java.lang.String provider, TagStructureListener listener)
Removes a previously registered tag structure listener.default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
renameTag(TagPath tag, java.lang.String newName, CollisionPolicy collisionPolicy)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>
renameTag(TagPath tag, java.lang.String newName, CollisionPolicy collisionPolicy, SecurityContext securityContext)
Renames a tag.void
unregisterProviderType(TagProviderExtensionPointType providerType)
-
Methods inherited from interface com.inductiveautomation.ignition.gateway.model.ExtensionPointManager
getExtensionPoint, getExtensionPoints
-
Methods inherited from interface com.inductiveautomation.ignition.common.tags.model.TagManager
browseAsync, browseTagDataSourcesAsync, getDiagnosticsAsync, getTagConfigModelAsync, getTagGroupConfigModelAsync, getTagGroupsAsync, importTagsAsync, moveTagsAsync, moveTagsAsync, readAsync, readAsync, reinitializeTags, subscribeAsync, subscribeAsync, unsubscribeAsync, unsubscribeAsync, writeAsync, writeAsync
-
-
-
-
Method Detail
-
getConfigManager
TagConfigurationManager getConfigManager()
-
getTagProvider
@Nullable @Nullable TagProvider getTagProvider(@Nonnull java.lang.String name)
-
getTagProviders
@Nonnull java.util.List<TagProvider> getTagProviders()
-
registerProviderType
void registerProviderType(TagProviderExtensionPointType providerType) throws java.lang.Exception
- Throws:
java.lang.Exception
-
unregisterProviderType
void unregisterProviderType(TagProviderExtensionPointType providerType) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getTagProviderNames
java.util.List<java.lang.String> getTagProviderNames()
- Returns:
- a list of the names of all available tag providers
-
getOrCreateManagedProvider
ManagedTagProvider getOrCreateManagedProvider(ProviderConfiguration config)
Creates a ManagedTagProvider with the given configuration. If the provider does not exist, it will be created. If it already exists, the configuration will be applied, which _may_ cause the provider to be restarted. Managed Tag Providers are tag providers that are "managed" by outside code, not users. They provide an easy way for module authors and subsystems to provide tag based data to the system.
-
getSystemTags
GatewaySystemTags getSystemTags()
Returns the tag provider for gateway status tags.
-
addTagStructureListener
void addTagStructureListener(java.lang.String provider, TagStructureListener listener)
Adds a listener that will be notified when tags are added, removed, or renamed. Will not be notified on initial add.
-
removeTagStructureListener
void removeTagStructureListener(java.lang.String provider, TagStructureListener listener)
Removes a previously registered tag structure listener.
-
getLicensedTagCount
int getLicensedTagCount()
- Returns:
- For a limited tag license, returns the number of currently licensed tags. This number will never exceed the tag limit. For an unlimited tag license, 0 is returned.
-
getLicensedTagLimit
int getLicensedTagLimit()
- Returns:
- For a limited tag license, returns the tag license limit. For an unlimited tag license, 0 is returned.
-
pasteTags
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> pasteTags(java.util.List<TagConfigurationModel> tagConfigs, TagPath destination, boolean removeOriginal, SecurityContext securityContext)
Copies tagConfigs to the destination path- Parameters:
removeOriginal
- After copy, remove tags from their original location (Cut/Drag)
-
pasteTags
default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> pasteTags(java.util.List<TagConfigurationModel> tagConfigs, TagPath destination, boolean removeOriginal)
-
renameTag
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> renameTag(TagPath tag, java.lang.String newName, CollisionPolicy collisionPolicy, SecurityContext securityContext)
Renames a tag. This method will not delete and recreate the tag, but will simply update the tag's name property.- Parameters:
tag
- the TagPath of the tag to renamenewName
- the new tag namecollisionPolicy
- the action to take if another tag with the new name already exists- Returns:
- a CompletableFuture whose value holds the result of the rename operation
-
renameTag
default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> renameTag(TagPath tag, java.lang.String newName, CollisionPolicy collisionPolicy)
-
-