Interface GatewayTagProvider

    • Method Detail

      • startup

        void startup()
      • shutdown

        void shutdown()
      • moveTagsAsync

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> moveTagsAsync​(java.util.List<TagPath> tags,
                                                                                          TagPath destination,
                                                                                          CollisionPolicy collisionPolicy,
                                                                                          SecurityContext securityContext)
        Moves the specified tags to the given destination, returning the result quality for each requested move. Can be used to rename a single tag if tags.size() is 1 and destination 1) does not exist as a folder and 2) is a single level beneath the same folder as the existing tag. Can also be used to copy tags by sending true for the copy flag. In this case, the original tags will remain unchanged.
      • importTagsAsync

        default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> importTagsAsync​(TagPath basePath,
                                                                                                    java.lang.String importText,
                                                                                                    java.lang.String importType,
                                                                                                    CollisionPolicy cp)
        Specified by:
        importTagsAsync in interface TagProvider
        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.
        cp - The collision policy to use. The collision policy will apply to individual tags, which means that some tag imports may succeed, while others may not.