public interface TagStore extends TagConfigProvider
Modifier and Type | Method and Description |
---|---|
void |
addConfigurationListener(TagStoreListener listener)
The configuration listener will be notified any time items are added or removed.
|
void |
addScanClasses(java.util.Collection<ScanClass> scanclasses)
Same as with tags, but for scanclasses.
|
void |
addTags(TagPath parentFolder,
java.util.List<? extends Tag> tag)
Saves the specified tag definitions to the store.
|
void |
deleteScanClasses(java.util.Collection<EntityId> scanClasses) |
void |
deleteTags(java.util.Collection<EntityId> tagIds)
Deletes the given tags from the store.
|
java.lang.Exception |
getLastError()
If isErrored() is TRUE, this should return the error that is causing that state.
|
boolean |
isErrored()
Returns whether or not the tag provider is running without error.
|
void |
modifyScanClass(EntityId scid,
ScanClass definition) |
void |
modifyTagPaths(java.util.List<EntityId> ids,
java.util.List<TagPath> paths)
Writes new tag paths to the store.
|
void |
modifyTags(TagDiff diff,
java.util.Collection<EntityId> tagIds)
Applies the tagdiff to the given tags.
|
void |
reloadTags(java.util.Set<EntityId> ids) |
void |
removeConfigurationListener(TagStoreListener listener) |
void |
shutdown()
Shuts down the tag store, finalizing any writes and preventing further operations.
|
void |
startup()
Initializes the tag store, loading all tags/scs.
|
void |
storeTagValues(java.util.Collection<TagPropertyValue> tagValues)
Writes the given values to the store.
|
void |
updateStatMetrics(java.util.Map<java.lang.String,StatMetric> statMetrics)
ALlows tag stores to update StatMetrics for the provider status display.
|
getDefinition, getDefinitions, getProperty
void addConfigurationListener(TagStoreListener listener)
listener
- void removeConfigurationListener(TagStoreListener listener)
void startup() throws java.lang.Exception
java.lang.Exception
void shutdown()
void addTags(TagPath parentFolder, java.util.List<? extends Tag> tag) throws java.lang.Exception
tags
- java.lang.Exception
void modifyTags(TagDiff diff, java.util.Collection<EntityId> tagIds) throws java.lang.Exception
tags
- java.lang.Exception
void deleteTags(java.util.Collection<EntityId> tagIds) throws java.lang.Exception
tags
- java.lang.Exception
void modifyTagPaths(java.util.List<EntityId> ids, java.util.List<TagPath> paths) throws java.lang.Exception
ids
- paths
- java.lang.Exception
void addScanClasses(java.util.Collection<ScanClass> scanclasses) throws java.lang.Exception
scanclasses
- java.lang.Exception
void modifyScanClass(EntityId scid, ScanClass definition) throws java.lang.Exception
java.lang.Exception
void deleteScanClasses(java.util.Collection<EntityId> scanClasses)
void storeTagValues(java.util.Collection<TagPropertyValue> tagValues)
tags
- void reloadTags(java.util.Set<EntityId> ids)
boolean isErrored()
java.lang.Exception getLastError()
void updateStatMetrics(java.util.Map<java.lang.String,StatMetric> statMetrics)
statMetrics
-