Package org.apache.iceberg.encryption

Interface NativeEncryptionOutputFile

All Superinterfaces:

EncryptedOutputFile, OutputFile

public interface NativeEncryptionOutputFile
extends EncryptedOutputFile, OutputFile

An EncryptedOutputFile that can be used for format-native encryption.

Method Summary

Modifier and Type	Method	Description
default PositionOutputStream	create()	Create a new file and return a PositionOutputStream to it.
default PositionOutputStream	createOrOverwrite()	Create a new file and return a PositionOutputStream to it.
NativeEncryptionKeyMetadata	keyMetadata()	Metadata about the encryption key that is being used to encrypt the associated EncryptedOutputFile.encryptingOutputFile().
default String	location()	Return the location this output file will create.
OutputFile	plainOutputFile()	An OutputFile instance for the underlying (plaintext) output stream.
default InputFile	toInputFile()	Return an InputFile for the location of this output file.

Methods inherited from interface org.apache.iceberg.encryption.EncryptedOutputFile

encryptingOutputFile

Method Details

keyMetadata

NativeEncryptionKeyMetadata keyMetadata()

Description copied from interface: EncryptedOutputFile

Metadata about the encryption key that is being used to encrypt the associated EncryptedOutputFile.encryptingOutputFile().

Specified by:

keyMetadata in interface EncryptedOutputFile

plainOutputFile

OutputFile plainOutputFile()

An OutputFile instance for the underlying (plaintext) output stream.

create

default PositionOutputStream create()

Description copied from interface: OutputFile

Create a new file and return a PositionOutputStream to it.

If the file already exists, this will throw an exception.

Specified by:

create in interface OutputFile

Returns:

an output stream that can report its position

createOrOverwrite

default PositionOutputStream createOrOverwrite()

Description copied from interface: OutputFile

Create a new file and return a PositionOutputStream to it.

If the file already exists, this will not throw an exception and will replace the file.

Specified by:

createOrOverwrite in interface OutputFile

Returns:

an output stream that can report its position

location

default String location()

Description copied from interface: OutputFile

Return the location this output file will create.

Specified by:

location in interface OutputFile

Returns:

the location of this output file

toInputFile

default InputFile toInputFile()

Description copied from interface: OutputFile

Return an InputFile for the location of this output file.

Specified by:

toInputFile in interface OutputFile

Returns:

an input file for the location of this output file