Package org.apache.solr.gcs

Class GCSBackupRepository

java.lang.Object

org.apache.solr.gcs.GCSBackupRepository

All Implemented Interfaces:

Closeable, AutoCloseable, BackupRepository, NamedListInitializedPlugin

public class GCSBackupRepository
extends Object
implements BackupRepository

BackupRepository implementation that stores files in Google Cloud Storage ("GCS").

Nested Class Summary

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

BackupRepository.PathType

Field Summary

Fields

Modifier and Type	Field	Description
protected String	bucketName
protected String	credentialPath
protected int	readBufferSizeBytes
protected com.google.cloud.storage.Storage	storage
protected com.google.cloud.storage.StorageOptions.Builder	storageOptionsBuilder
protected int	writeBufferSizeBytes

Constructor Summary

Constructors

Constructor	Description
GCSBackupRepository()

Method Summary

Modifier and Type	Method	Description
protected List<com.google.cloud.storage.BlobId>	allBlobsAtDir(URI path)
void	close()
void	copyIndexFileFrom(org.apache.lucene.store.Directory sourceDir, String sourceFileName, URI destDir, String destFileName)
void	copyIndexFileTo(URI sourceRepo, String sourceFileName, org.apache.lucene.store.Directory dest, String destFileName)
void	createDirectory(URI path)
URI	createDirectoryURI(String location)
OutputStream	createOutput(URI path)
URI	createURI(String location)
void	delete(URI path, Collection<String> files, boolean ignoreNoSuchFileException)
void	deleteDirectory(URI path)
boolean	exists(String path)
boolean	exists(URI path)
<T> T	getConfigProperty(String name)
protected com.google.cloud.storage.Storage.BlobWriteOption[]	getDefaultBlobWriteOptions()
BackupRepository.PathType	getPathType(URI path)
void	init(org.apache.solr.common.util.NamedList<?> args)
protected com.google.cloud.storage.Storage	initStorage()
String[]	listAll(URI path)
org.apache.lucene.store.IndexInput	openInput(URI dirPath, String fileName, org.apache.lucene.store.IOContext ctx)
URI	resolve(URI baseUri, String... pathComponents)
URI	resolveDirectory(URI baseUri, String... pathComponents)

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

checksum, copyFileFrom, copyFileTo, copyIndexFileFrom, getBackupLocation, listAllOrEmpty

Field Detail

storage

protected com.google.cloud.storage.Storage storage

bucketName

protected String bucketName

credentialPath

protected String credentialPath

writeBufferSizeBytes

protected int writeBufferSizeBytes

readBufferSizeBytes

protected int readBufferSizeBytes

storageOptionsBuilder

protected com.google.cloud.storage.StorageOptions.Builder storageOptionsBuilder

Constructor Detail

GCSBackupRepository

public GCSBackupRepository()

Method Detail

initStorage

protected com.google.cloud.storage.Storage initStorage()

init

public void init(org.apache.solr.common.util.NamedList<?> args)

Specified by:

init in interface NamedListInitializedPlugin

getConfigProperty

public <T> T getConfigProperty(String name)

Specified by:

getConfigProperty in interface BackupRepository

createURI

public URI createURI(String location)

Specified by:

createURI in interface BackupRepository

createDirectoryURI

public URI createDirectoryURI(String location)

Specified by:

createDirectoryURI in interface BackupRepository

resolve

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

Specified by:

resolve in interface BackupRepository

resolveDirectory

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

Specified by:

resolveDirectory in interface BackupRepository

exists

public boolean exists(URI path)
               throws IOException

Specified by:

exists in interface BackupRepository

Throws:

IOException

exists

public boolean exists(String path)
               throws IOException

Throws:

IOException

getPathType

public BackupRepository.PathType getPathType(URI path)
                                      throws IOException

Specified by:

getPathType in interface BackupRepository

Throws:

IOException

listAll

public String[] listAll(URI path)
                 throws IOException

Specified by:

listAll in interface BackupRepository

Throws:

IOException

openInput

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

Specified by:

openInput in interface BackupRepository

Throws:

IOException

createOutput

public OutputStream createOutput(URI path)
                          throws IOException

Specified by:

createOutput in interface BackupRepository

Throws:

IOException

createDirectory

public void createDirectory(URI path)
                     throws IOException

Specified by:

createDirectory in interface BackupRepository

Throws:

IOException

deleteDirectory

public void deleteDirectory(URI path)
                     throws IOException

Specified by:

deleteDirectory in interface BackupRepository

Throws:

IOException

allBlobsAtDir

protected List<com.google.cloud.storage.BlobId> allBlobsAtDir(URI path)
                                                       throws IOException

Throws:

IOException

delete

public void delete(URI path,
                   Collection<String> files,
                   boolean ignoreNoSuchFileException)
            throws IOException

Specified by:

delete in interface BackupRepository

Throws:

IOException

copyIndexFileFrom

public void copyIndexFileFrom(org.apache.lucene.store.Directory sourceDir,
                              String sourceFileName,
                              URI destDir,
                              String destFileName)
                       throws IOException

Specified by:

copyIndexFileFrom in interface BackupRepository

Throws:

IOException

copyIndexFileTo

public void copyIndexFileTo(URI sourceRepo,
                            String sourceFileName,
                            org.apache.lucene.store.Directory dest,
                            String destFileName)
                     throws IOException

Specified by:

copyIndexFileTo in interface BackupRepository

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getDefaultBlobWriteOptions

protected com.google.cloud.storage.Storage.BlobWriteOption[] getDefaultBlobWriteOptions()