org.elasticsearch.repositories.blobstore

クラス 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

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected boolean	compress
static int	VERSION
protected XContentType	xContentType

クラスから継承されたフィールド org.elasticsearch.repositories.blobstore.BlobStoreFormat

blobNameFormat, parseFieldMatcher, reader, SNAPSHOT_ONLY_FORMAT_PARAMS

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
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)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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.

クラスから継承されたメソッド org.elasticsearch.repositories.blobstore.BlobStoreFormat

blobName, delete, exists, read, read

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

VERSION

public static final int VERSION

関連項目:

定数フィールド値

xContentType

protected final XContentType xContentType

compress

protected final boolean compress

コンストラクタの詳細

ChecksumBlobStoreFormat

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

パラメータ:

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)

パラメータ:

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

メソッドの詳細

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.

定義:

readBlob クラス内 BlobStoreFormat<T extends ToXContent>

パラメータ:

blobContainer - blob container

blobName - blob name

戻り値:

parsed blob object

例外:

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.

パラメータ:

obj - object to be serialized

blobContainer - blob container

name - blob name

例外:

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.

パラメータ:

obj - object to be serialized

blobContainer - blob container

name - blob name

例外:

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.

パラメータ:

obj - object to be serialized

blobContainer - blob container

blobName - blob name

例外:

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

例外:

IOException

write

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

例外:

IOException

tempBlobName

protected String tempBlobName(String name)