Package org.apache.solr.core.backup.repository

Class LocalFileSystemRepository

java.lang.Object

org.apache.solr.core.backup.repository.LocalFileSystemRepository

All Implemented Interfaces:

Closeable, AutoCloseable, BackupRepository, NamedListInitializedPlugin

public class LocalFileSystemRepository
extends Object
implements BackupRepository

A concrete implementation of BackupRepository interface supporting backup/restore of Solr indexes to a local file-system. (Note - This can even be used for a shared file-system if it is exposed via a local file-system interface e.g. NFS).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.core.backup.repository.BackupRepository

BackupRepository.PathType

Constructor Summary

Constructors

Constructor	Description
LocalFileSystemRepository()

Method Summary

Modifier and Type	Method	Description
void	close()
void	copyFileFrom(org.apache.lucene.store.Directory sourceDir, String fileName, URI dest)	Copy a file from specified sourceDir to the destination repository (i.e.
void	copyFileTo(URI sourceDir, String fileName, org.apache.lucene.store.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 location)	This method returns the URI representation for the specified path.
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
void	init(NamedList args)
String[]	listAll(URI dirPath)	This method returns all the entries (files and directories) in the specified directory.
org.apache.lucene.store.IndexInput	openInput(URI dirPath, String fileName, org.apache.lucene.store.IOContext ctx)	This method returns a Lucene input stream reading an existing file.
URI	resolve(URI baseUri, String... pathComponents)	This method resolves a URI using the specified path components (as method arguments).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.core.backup.repository.BackupRepository

getBackupLocation

Constructor Detail

LocalFileSystemRepository

public LocalFileSystemRepository()

Method Detail

init

public void init(NamedList args)

Specified by:

init in interface NamedListInitializedPlugin

getConfigProperty

public <T> T getConfigProperty(String name)

Description copied from interface: BackupRepository

This method returns the value of the specified configuration property.

Specified by:

getConfigProperty in interface BackupRepository

createURI

public URI createURI(String location)

Description copied from interface: BackupRepository

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.

Specified by:

createURI in interface BackupRepository

Parameters:

location - The path specified by the user.

Returns:

the URI representation of the user supplied value

resolve

public URI resolve(URI baseUri,
                   String... pathComponents)

Description copied from interface: BackupRepository

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

Specified by:

resolve in interface BackupRepository

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

createDirectory

public void createDirectory(URI path)
                     throws IOException

Description copied from interface: BackupRepository

This method creates a directory at the specified path.

Specified by:

createDirectory in interface BackupRepository

Parameters:

path - The path where the directory needs to be created.

Throws:

IOException - in case of errors

deleteDirectory

public void deleteDirectory(URI path)
                     throws IOException

Description copied from interface: BackupRepository

This method deletes a directory at the specified path.

Specified by:

deleteDirectory in interface BackupRepository

Parameters:

path - The path referring to the directory to be deleted.

Throws:

IOException - in case of errors

exists

public boolean exists(URI path)
               throws IOException

Description copied from interface: BackupRepository

This method checks if the specified path exists in this repository.

Specified by:

exists in interface BackupRepository

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

openInput

public org.apache.lucene.store.IndexInput openInput(URI dirPath,
                                                    String fileName,
                                                    org.apache.lucene.store.IOContext ctx)
                                             throws IOException

Description copied from interface: BackupRepository

This method returns a Lucene input stream reading an existing file.

Specified by:

openInput in interface BackupRepository

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

public OutputStream createOutput(URI path)
                          throws IOException

Description copied from interface: BackupRepository

This method returns a OutputStream instance for the specified path

Specified by:

createOutput in interface BackupRepository

Parameters:

path - The path for which OutputStream needs to be created

Returns:

OutputStream instance for the specified path

Throws:

IOException - in case of errors

listAll

public String[] listAll(URI dirPath)
                 throws IOException

Description copied from interface: BackupRepository

This method returns all the entries (files and directories) in the specified directory.

Specified by:

listAll in interface BackupRepository

Parameters:

dirPath - The directory path

Returns:

an array of strings, one for each entry in the directory

Throws:

IOException - in case of errors

getPathType

public BackupRepository.PathType getPathType(URI path)
                                      throws IOException

Description copied from interface: BackupRepository

This method returns the type of a specified path

Specified by:

getPathType in interface BackupRepository

Parameters:

path - The path whose type needs to be checked.

Returns:

the BackupRepository.PathType for the specified path

Throws:

IOException - in case of errors

copyFileFrom

public void copyFileFrom(org.apache.lucene.store.Directory sourceDir,
                         String fileName,
                         URI dest)
                  throws IOException

Description copied from interface: BackupRepository

Copy a file from specified sourceDir to the destination repository (i.e. backup).

Specified by:

copyFileFrom in interface BackupRepository

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

public void copyFileTo(URI sourceDir,
                       String fileName,
                       org.apache.lucene.store.Directory dest)
                throws IOException

Description copied from interface: BackupRepository

Copy a file from specified sourceRepo to the destination directory (i.e. restore).

Specified by:

copyFileTo in interface BackupRepository

Parameters:

sourceDir - 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.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException