org.bytedeco.parquet

Class FileDecryptionProperties.Builder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.parquet.FileDecryptionProperties.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

FileDecryptionProperties

@NoOffset
public static class FileDecryptionProperties.Builder
extends Pointer

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(long size) Native array allocator.
Builder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
FileDecryptionProperties.Builder	aad_prefix_verifier(AADPrefixVerifier aad_prefix_verifier) Set callback for verification of AAD Prefixes stored in file.
FileDecryptionProperties.Builder	aad_prefix(BytePointer aad_prefix)
FileDecryptionProperties.Builder	aad_prefix(String aad_prefix) Explicitly supply the file AAD prefix.
FileDecryptionProperties	build()
FileDecryptionProperties.Builder	column_keys(ColumnDecryptionPropertiesStringMap column_decryption_properties) Set explicit column keys (decryption properties).
FileDecryptionProperties.Builder	disable_footer_signature_verification() Skip integrity verification of plaintext footers.
FileDecryptionProperties.Builder	footer_key(BytePointer footer_key)
FileDecryptionProperties.Builder	footer_key(String footer_key) Set an explicit footer key.
FileDecryptionProperties.Builder	getPointer(long i)
FileDecryptionProperties.Builder	key_retriever(DecryptionKeyRetriever key_retriever) Set a key retriever callback.
FileDecryptionProperties.Builder	plaintext_files_allowed() By default, reading plaintext (unencrypted) files is not allowed when using a decryptor - in order to detect files that were not encrypted by mistake.
FileDecryptionProperties.Builder	position(long position)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Builder

public Builder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Builder

public Builder(long size)

Native array allocator. Access with Pointer.position(long).

Builder

public Builder()

Method Detail

position

public FileDecryptionProperties.Builder position(long position)

Overrides:

position in class Pointer

getPointer

public FileDecryptionProperties.Builder getPointer(long i)

Overrides:

getPointer in class Pointer

footer_key

public FileDecryptionProperties.Builder footer_key(@StdString
                                                   String footer_key)

Set an explicit footer key. If applied on a file that contains footer key metadata the metadata will be ignored, the footer will be decrypted/verified with this key. If explicit key is not set, footer key will be fetched from key retriever. With explicit keys or AAD prefix, new encryption properties object must be created for each encrypted file. Explicit encryption keys (footer and column) are cloned. Upon completion of file reading, the cloned encryption keys in the properties will be wiped out (array values set to 0). Caller is responsible for wiping out the input key array. param footerKey Key length must be either 16, 24 or 32 bytes.

footer_key

public FileDecryptionProperties.Builder footer_key(@StdString
                                                   BytePointer footer_key)

column_keys

public FileDecryptionProperties.Builder column_keys(@Cast(value="const parquet::ColumnPathToDecryptionPropertiesMap*") @ByRef
                                                    ColumnDecryptionPropertiesStringMap column_decryption_properties)

Set explicit column keys (decryption properties). Its also possible to set a key retriever on this property object. Upon file decryption, availability of explicit keys is checked before invocation of the retriever callback. If an explicit key is available for a footer or a column, its key metadata will be ignored.

key_retriever

public FileDecryptionProperties.Builder key_retriever(@SharedPtr
                                                      DecryptionKeyRetriever key_retriever)

Set a key retriever callback. Its also possible to set explicit footer or column keys on this file property object. Upon file decryption, availability of explicit keys is checked before invocation of the retriever callback. If an explicit key is available for a footer or a column, its key metadata will be ignored.

disable_footer_signature_verification

public FileDecryptionProperties.Builder disable_footer_signature_verification()

Skip integrity verification of plaintext footers. If not called, integrity of plaintext footers will be checked in runtime, and an exception will be thrown in the following situations: - footer signing key is not available (not passed, or not found by key retriever) - footer content and signature don't match

aad_prefix

public FileDecryptionProperties.Builder aad_prefix(@StdString
                                                   String aad_prefix)

Explicitly supply the file AAD prefix. A must when a prefix is used for file encryption, but not stored in file. If AAD prefix is stored in file, it will be compared to the explicitly supplied value and an exception will be thrown if they differ.

aad_prefix

public FileDecryptionProperties.Builder aad_prefix(@StdString
                                                   BytePointer aad_prefix)

aad_prefix_verifier

public FileDecryptionProperties.Builder aad_prefix_verifier(@SharedPtr
                                                            AADPrefixVerifier aad_prefix_verifier)

Set callback for verification of AAD Prefixes stored in file.

plaintext_files_allowed

public FileDecryptionProperties.Builder plaintext_files_allowed()

By default, reading plaintext (unencrypted) files is not allowed when using a decryptor - in order to detect files that were not encrypted by mistake. However, the default behavior can be overridden by calling this method. The caller should use then a different method to ensure encryption of files with sensitive data.

build

@SharedPtr
public FileDecryptionProperties build()