org.elasticsearch.repositories.blobstore

Class BlobStoreFormat<T extends ToXContent>

java.lang.Object

org.elasticsearch.repositories.blobstore.BlobStoreFormat<T>

Direct Known Subclasses:

ChecksumBlobStoreFormat, LegacyBlobStoreFormat

public abstract class BlobStoreFormat<T extends ToXContent>
extends Object

Base class that handles serialization of various data structures during snapshot/restore operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	blobNameFormat
protected ParseFieldMatcher	parseFieldMatcher
protected FromXContentBuilder<T>	reader
protected static ToXContent.Params	SNAPSHOT_ONLY_FORMAT_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlobStoreFormat(String blobNameFormat, FromXContentBuilder<T> reader, ParseFieldMatcher parseFieldMatcher)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	blobName(String name)
void	delete(BlobContainer blobContainer, String name) Deletes obj in the blob container
boolean	exists(BlobContainer blobContainer, String name) Checks obj in the blob container
T	read(BlobContainer blobContainer, String name) Reads and parses the blob with given name, applying name translation using the {link #blobName} method
protected T	read(BytesReference bytes)
abstract T	readBlob(BlobContainer blobContainer, String blobName) Reads and parses the blob with given blob name.

Methods inherited from class java.lang.Object

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

Field Detail

blobNameFormat

protected final String blobNameFormat

reader

protected final FromXContentBuilder<T extends ToXContent> reader

parseFieldMatcher

protected final ParseFieldMatcher parseFieldMatcher

SNAPSHOT_ONLY_FORMAT_PARAMS

protected static final ToXContent.Params SNAPSHOT_ONLY_FORMAT_PARAMS

Constructor Detail

BlobStoreFormat

protected BlobStoreFormat(String blobNameFormat,
               FromXContentBuilder<T> reader,
               ParseFieldMatcher parseFieldMatcher)

Parameters:

blobNameFormat - format of the blobname in String.format(Locale, String, Object...) format

reader - the prototype object that can deserialize objects with type T

parseFieldMatcher - parse field matcher

Method Detail

readBlob

public abstract T readBlob(BlobContainer blobContainer,
         String blobName)
                                       throws IOException

Reads and parses the blob with given blob name.

Parameters:

blobContainer - blob container

blobName - blob name

Returns:

parsed blob object

Throws:

IOException

read

public T read(BlobContainer blobContainer,
     String name)
                          throws IOException

Reads and parses the blob with given name, applying name translation using the {link #blobName} method

Parameters:

blobContainer - blob container

name - name to be translated into

Returns:

parsed blob object

Throws:

IOException

delete

public void delete(BlobContainer blobContainer,
          String name)
            throws IOException

Deletes obj in the blob container

Throws:

IOException

exists

public boolean exists(BlobContainer blobContainer,
             String name)
               throws IOException

Checks obj in the blob container

Throws:

IOException

blobName

protected String blobName(String name)

read

protected T read(BytesReference bytes)
                             throws IOException

Throws:

IOException