Package csw.config.api.javadsl

Interface IConfigClientService

All Known Subinterfaces:
IConfigService
public interface IConfigClientService
Defines an interface to be used by clients for retrieving configuration information

  • Method Details

    • asScala

      csw.config.api.scaladsl.ConfigService asScala()
      Returns the Scala API for this instance of config service
      Returns:
      (undocumented)

    • exists

      CompletableFuture<Boolean> exists(Path path)
      Returns true if the given path exists and is being managed

      Parameters:
      path - the file path relative to the repository root
      Returns:
      a CompletableFuture that completes with true if the file exists, false otherwise. It can fail with InvalidInput or FileNotFound

    • exists

      CompletableFuture<Boolean> exists(Path path, ConfigId id)
      Returns true if the given path exists at the given revision

      Parameters:
      path - the file path relative to the repository root
      id - revision of the file
      Returns:
      a CompletableFuture that completes with true if the file exists, false otherwise. It can fail with InvalidInput or FileNotFound

    • getActive

      CompletableFuture<Optional<ConfigData>> getActive(Path path)
      Gets and returns the content of active version of the file stored under the given path.

      Parameters:
      path - the file path relative to the repository root
      Returns:
      a CompletableFuture that can be used to access the file's data, if found. It can fail with EmptyResponse or InvalidInput or FileNotFound