Package de.aservo.confapi.commons.service.api

Interface DirectoriesService

public interface DirectoriesService
The User directory service interface.

  • Method Details

    • getDirectories

      DirectoriesBean getDirectories()
      Gets all directories.
      Returns:
      the directories

    • getDirectory

      AbstractDirectoryBean getDirectory(long id)
      Gets a single directory.
      Parameters:
      id - the directory id to query
      Returns:
      the directory

    • setDirectories

      DirectoriesBean setDirectories(@NotNull DirectoriesBean directories, boolean testConnection)
      Adds or Updates directory configurations. Any existing configurations with the same 'name' property is updated.
      Parameters:
      directories - the directories
      testConnection - whether to test connection
      Returns:
      the directories

    • setDirectory

      AbstractDirectoryBean setDirectory(long id, @NotNull AbstractDirectoryBean directory, boolean testConnection)
      Updates a single directory configuration. Any existing configuration with the same 'name' property is updated.
      Parameters:
      id - the directory id to update
      directory - the directory
      testConnection - whether to test connection
      Returns:
      the directories

    • addDirectory

      AbstractDirectoryBean addDirectory(@NotNull AbstractDirectoryBean directory, boolean testConnection)
      Adds a new directory configuration.
      Parameters:
      directory - the directories
      testConnection - whether to test connection
      Returns:
      the added directory

    • deleteDirectories

      void deleteDirectories(boolean force)
      Deletes all directories
      Parameters:
      force - must be set to 'true' in order to delete all entries

    • deleteDirectory

      void deleteDirectory(long id)
      Deletes a single directory
      Parameters:
      id - the directory id to delete