org.apache.solr.core.backup.repository

Interface BackupRepository

All Superinterfaces:

AutoCloseable, Closeable, NamedListInitializedPlugin

All Known Implementing Classes:

HdfsBackupRepository, LocalFileSystemRepository

public interface BackupRepository
extends NamedListInitializedPlugin, Closeable

This interface defines the functionality required to backup/restore Solr indexes to an arbitrary storage system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BackupRepository.PathType This enumeration defines the type of a given path.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFileFrom(Directory sourceDir, String fileName, URI dest) Copy a file from specified sourceDir to the destination repository (i.e.
void	copyFileTo(URI sourceRepo, String fileName, Directory dest) Copy a file from specified sourceRepo to the destination directory (i.e.
void	createDirectory(URI path) This method creates a directory at the specified path.
OutputStream	createOutput(URI path) This method returns a OutputStream instance for the specified path
URI	createURI(String... pathComponents) This method creates a URI using the specified path components (as method arguments).
void	deleteDirectory(URI path) This method deletes a directory at the specified path.
boolean	exists(URI path) This method checks if the specified path exists in this repository.
<T> T	getConfigProperty(String name) This method returns the value of the specified configuration property.
BackupRepository.PathType	getPathType(URI path) This method returns the type of a specified path
String[]	listAll(URI path) This method returns all the entries (files and directories) in the specified directory.
IndexInput	openInput(URI dirPath, String fileName, IOContext ctx) This method returns a Lucene input stream reading an existing file.

Methods inherited from interface org.apache.solr.util.plugin.NamedListInitializedPlugin

init

Methods inherited from interface java.io.Closeable

close

Method Detail

getConfigProperty

<T> T getConfigProperty(String name)

This method returns the value of the specified configuration property.

createURI

URI createURI(String... pathComponents)

This method creates a URI using the specified path components (as method arguments).

Parameters:

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

getPathType

BackupRepository.PathType getPathType(URI path)
                                      throws IOException

This method returns the type of a specified path

Parameters:

path - The path whose type needs to be checked.

Returns:

the BackupRepository.PathType for the specified path

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

createOutput

OutputStream createOutput(URI path)
                          throws IOException

This method returns a OutputStream instance for the specified path

Parameters:

path - The path for which OutputStream needs to be created

Returns:

OutputStream instance for the specified path

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.