Module org.elasticsearch.server

Package org.elasticsearch.repositories.blobstore

Class ChecksumBlobStoreFormat<T>

java.lang.Object

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

public final class ChecksumBlobStoreFormat<T>
extends Object

Snapshot metadata file format used in v2.0 and above

Field Summary

Fields

Modifier and Type	Field	Description
static final ToXContent.Params	SNAPSHOT_ONLY_FORMAT_PARAMS
static final int	VERSION

Constructor Summary

Constructors

Constructor	Description
ChecksumBlobStoreFormat(String codec, String blobNameFormat, CheckedBiFunction<String,XContentParser,T,IOException> reader, Function<T,? extends ToXContent> writer)
ChecksumBlobStoreFormat(String codec, String blobNameFormat, CheckedBiFunction<String,XContentParser,T,IOException> reader, CheckedBiFunction<String,XContentParser,T,IOException> fallbackReader, Function<T,? extends ToXContent> writer)

Method Summary

Modifier and Type	Method	Description
String	blobName(String name)
T	deserialize(String repoName, NamedXContentRegistry namedXContentRegistry, InputStream input)
T	read(String repoName, BlobContainer blobContainer, String name, NamedXContentRegistry namedXContentRegistry)	Reads and parses the blob with given name, applying name translation using the {link #blobName} method
void	serialize(T obj, String blobName, boolean compress, OutputStream outputStream)
void	serialize(T obj, String blobName, boolean compress, Map<String,String> extraParams, OutputStream outputStream)
void	write(T obj, BlobContainer blobContainer, String name, boolean compress)	Writes blob with resolving the blob name using blobName(java.lang.String) method.
void	write(T obj, BlobContainer blobContainer, String name, boolean compress, Map<String,String> serializationParams)	Writes blob with resolving the blob name using blobName(java.lang.String) method.

Methods inherited from class java.lang.Object

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

Field Details

SNAPSHOT_ONLY_FORMAT_PARAMS

public static final ToXContent.Params SNAPSHOT_ONLY_FORMAT_PARAMS

VERSION

public static final int VERSION

See Also:

• Constant Field Values

Constructor Details

ChecksumBlobStoreFormat

public ChecksumBlobStoreFormat(String codec,
 String blobNameFormat,
 CheckedBiFunction<String,XContentParser,T,IOException> reader,
 @Nullable
 CheckedBiFunction<String,XContentParser,T,IOException> fallbackReader,
 Function<T,? extends ToXContent> writer)

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

fallbackReader - fallback prototype object that can deserialize T from XContent in case reader fails

writer - function that maps the given type to a ToXContent for serialization

ChecksumBlobStoreFormat

public ChecksumBlobStoreFormat(String codec,
 String blobNameFormat,
 CheckedBiFunction<String,XContentParser,T,IOException> reader,
 Function<T,? extends ToXContent> writer)

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

writer - function that maps the given type to a ToXContent for serialization

Method Details

read

public T read(String repoName,
 BlobContainer blobContainer,
 String name,
 NamedXContentRegistry namedXContentRegistry)
       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

blobName

public String blobName(String name)

deserialize

public T deserialize(String repoName,
 NamedXContentRegistry namedXContentRegistry,
 InputStream input)
              throws IOException

Throws:

IOException

write

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

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

The blob will optionally be compressed.

Parameters:

obj - object to be serialized

blobContainer - blob container

name - blob name

compress - whether to use compression

Throws:

IOException

write

public void write(T obj,
 BlobContainer blobContainer,
 String name,
 boolean compress,
 Map<String,String> serializationParams)
           throws IOException

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

The blob will optionally be compressed.

Parameters:

obj - object to be serialized

blobContainer - blob container

name - blob name

compress - whether to use compression

serializationParams - extra serialization parameters

Throws:

IOException

serialize

public void serialize(T obj,
 String blobName,
 boolean compress,
 OutputStream outputStream)
               throws IOException

Throws:

IOException

serialize

public void serialize(T obj,
 String blobName,
 boolean compress,
 Map<String,String> extraParams,
 OutputStream outputStream)
               throws IOException

Throws:

IOException