org.elasticsearch.repositories.blobstore

Class ChecksumBlobStoreFormat<T extends ToXContent>

java.lang.Object

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

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

public class ChecksumBlobStoreFormat<T extends ToXContent>
extends BlobStoreFormat<T>

Snapshot metadata file format used in v2.0 and above

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	compress
static int	VERSION
protected XContentType	xContentType

Fields inherited from class org.elasticsearch.repositories.blobstore.BlobStoreFormat

blobNameFormat, parseFieldMatcher, reader, SNAPSHOT_ONLY_FORMAT_PARAMS

Constructor Summary

Constructors

Constructor and Description
ChecksumBlobStoreFormat(String codec, String blobNameFormat, FromXContentBuilder<T> reader, ParseFieldMatcher parseFieldMatcher, boolean compress)
ChecksumBlobStoreFormat(String codec, String blobNameFormat, FromXContentBuilder<T> reader, ParseFieldMatcher parseFieldMatcher, boolean compress, XContentType xContentType)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isTempBlobName(String blobName) Returns true if the blob is a leftover temporary blob.
T	readBlob(BlobContainer blobContainer, String blobName) Reads blob with specified name without resolving the blobName using using BlobStoreFormat.blobName(java.lang.String) method.
protected String	tempBlobName(String name)
protected BytesReference	write(T obj)
void	write(T obj, BlobContainer blobContainer, String name) Writes blob with resolving the blob name using BlobStoreFormat.blobName(java.lang.String) method.
protected void	write(T obj, StreamOutput streamOutput)
void	writeAtomic(T obj, BlobContainer blobContainer, String name) Writes blob in atomic manner with resolving the blob name using BlobStoreFormat.blobName(java.lang.String) and tempBlobName(java.lang.String) methods.
protected void	writeBlob(T obj, BlobContainer blobContainer, String blobName) Writes blob in atomic manner without resolving the blobName using using BlobStoreFormat.blobName(java.lang.String) method.

Methods inherited from class org.elasticsearch.repositories.blobstore.BlobStoreFormat

blobName, delete, exists, read, read

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final int VERSION

See Also:

Constant Field Values

xContentType

protected final XContentType xContentType

compress

protected final boolean compress

Constructor Detail

ChecksumBlobStoreFormat

public ChecksumBlobStoreFormat(String codec,
                       String blobNameFormat,
                       FromXContentBuilder<T> reader,
                       ParseFieldMatcher parseFieldMatcher,
                       boolean compress,
                       XContentType xContentType)

Parameters:

codec - codec name

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

reader - prototype object that can deserialize T from XContent

compress - true if the content should be compressed

xContentType - content type that should be used for write operations

ChecksumBlobStoreFormat

public ChecksumBlobStoreFormat(String codec,
                       String blobNameFormat,
                       FromXContentBuilder<T> reader,
                       ParseFieldMatcher parseFieldMatcher,
                       boolean compress)

Parameters:

codec - codec name

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

reader - prototype object that can deserialize T from XContent

compress - true if the content should be compressed

Method Detail

readBlob

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

Reads blob with specified name without resolving the blobName using using BlobStoreFormat.blobName(java.lang.String) method.

Specified by:

readBlob in class BlobStoreFormat<T extends ToXContent>

Parameters:

blobContainer - blob container

blobName - blob name

Returns:

parsed blob object

Throws:

IOException

writeAtomic

public void writeAtomic(T obj,
               BlobContainer blobContainer,
               String name)
                 throws IOException

Writes blob in atomic manner with resolving the blob name using BlobStoreFormat.blobName(java.lang.String) and tempBlobName(java.lang.String) methods.

The blob will be compressed and checksum will be written if required. Atomic move might be very inefficient on some repositories. It also cannot override existing files.

Parameters:

obj - object to be serialized

blobContainer - blob container

name - blob name

Throws:

IOException

write

public void write(T obj,
         BlobContainer blobContainer,
         String name)
           throws IOException

Writes blob with resolving the blob name using BlobStoreFormat.blobName(java.lang.String) method.

The blob will be compressed and checksum will be written if required.

Parameters:

obj - object to be serialized

blobContainer - blob container

name - blob name

Throws:

IOException

writeBlob

protected void writeBlob(T obj,
             BlobContainer blobContainer,
             String blobName)
                  throws IOException

Writes blob in atomic manner without resolving the blobName using using BlobStoreFormat.blobName(java.lang.String) method.

The blob will be compressed and checksum will be written if required.

Parameters:

obj - object to be serialized

blobContainer - blob container

blobName - blob name

Throws:

IOException

isTempBlobName

public boolean isTempBlobName(String blobName)

Returns true if the blob is a leftover temporary blob. The temporary blobs might be left after failed atomic write operation.

write

protected BytesReference write(T obj)
                        throws IOException

Throws:

IOException

write

protected void write(T obj,
         StreamOutput streamOutput)
              throws IOException

Throws:

IOException

tempBlobName

protected String tempBlobName(String name)