org.apache.solr.core.backup.repository

Interface BackupRepository

    • Method Detail

      • getBackupLocation

        default String getBackupLocation(String override)
        This method returns the location where the backup should be stored (or restored from).
        Parameters:
        override - The location parameter supplied by the user.
        Returns:
        If override is not null then return the same value Otherwise return the default configuration value for the CoreAdminParams.BACKUP_LOCATION parameter.
      • getConfigProperty

        <T> T getConfigProperty(String name)
        This method returns the value of the specified configuration property.
      • createURI

        URI createURI(String path)
        This method returns the URI representation for the specified path. Note - the specified path could be a fully qualified URI OR a relative path for a file-system.
        Parameters:
        path - The path specified by the user.
        Returns:
        the URI representation of the user supplied value
      • resolve

        URI resolve(URI baseUri,
                    String... pathComponents)
        This method resolves a URI using the specified path components (as method arguments).
        Parameters:
        baseUri - The base URI to use for creating the path
        pathComponents - The directory (or file-name) to be included in the URI.
        Returns:
        A URI containing absolute path
      • exists

        boolean exists(URI path)
                throws IOException
        This method checks if the specified path exists in this repository.
        Parameters:
        path - The path whose existence needs to be checked.
        Returns:
        if the specified path exists in this repository.
        Throws:
        IOException - in case of errors
      • listAll

        String[] listAll(URI path)
                  throws IOException
        This method returns all the entries (files and directories) in the specified directory.
        Parameters:
        path - The directory path
        Returns:
        an array of strings, one for each entry in the directory
        Throws:
        IOException - in case of errors
      • openInput

        IndexInput openInput(URI dirPath,
                             String fileName,
                             IOContext ctx)
                      throws IOException
        This method returns a Lucene input stream reading an existing file.
        Parameters:
        dirPath - The parent directory of the file to be read
        fileName - The name of the file to be read
        ctx - the Lucene IO context
        Returns:
        Lucene IndexInput reference
        Throws:
        IOException - in case of errors
      • createDirectory

        void createDirectory(URI path)
                      throws IOException
        This method creates a directory at the specified path.
        Parameters:
        path - The path where the directory needs to be created.
        Throws:
        IOException - in case of errors
      • deleteDirectory

        void deleteDirectory(URI path)
                      throws IOException
        This method deletes a directory at the specified path.
        Parameters:
        path - The path referring to the directory to be deleted.
        Throws:
        IOException - in case of errors
      • copyFileFrom

        void copyFileFrom(Directory sourceDir,
                          String fileName,
                          URI dest)
                   throws IOException
        Copy a file from specified sourceDir to the destination repository (i.e. backup).
        Parameters:
        sourceDir - The source directory hosting the file to be copied.
        fileName - The name of the file to by copied
        dest - The destination backup location.
        Throws:
        IOException - in case of errors
      • copyFileTo

        void copyFileTo(URI sourceRepo,
                        String fileName,
                        Directory dest)
                 throws IOException
        Copy a file from specified sourceRepo to the destination directory (i.e. restore).
        Parameters:
        sourceRepo - The source URI hosting the file to be copied.
        fileName - The name of the file to by copied
        dest - The destination where the file should be copied.
        Throws:
        IOException - in case of errors.