AesGcmInputFile

java.lang.Object

org.apache.iceberg.encryption.AesGcmInputFile

All Implemented Interfaces:: InputFile

public class AesGcmInputFile extends Object implements InputFile

Constructor Summary

Constructors

Constructor

Description

AesGcmInputFile(InputFile sourceFile, byte[] dataKey, byte[] fileAADPrefix)

Deprecated.
will be removed in 2.0.0 This API does not receive file length, and is therefore not safe

AesGcmInputFile(InputFile sourceFile, byte[] dataKey, byte[] fileAADPrefix, Long length)
Method Summary

Modifier and Type

Method

Description

boolean

exists()

Checks whether the file exists.

long

getLength()

Returns the total length of the file, in bytes

String

location()

The fully-qualified location of the input file as a String.

SeekableInputStream

newStream()

Opens a new SeekableInputStream for the underlying data file

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- AesGcmInputFile
  
  @Deprecated public AesGcmInputFile(InputFile sourceFile, byte[] dataKey, byte[] fileAADPrefix)
  
  Deprecated.
  will be removed in 2.0.0 This API does not receive file length, and is therefore not safe
- AesGcmInputFile
  
  public AesGcmInputFile(InputFile sourceFile, byte[] dataKey, byte[] fileAADPrefix, Long length)
Method Details
- getLength
  
  public long getLength()
  
  Description copied from interface: InputFile
  
  Returns the total length of the file, in bytes
  
  Specified by:
  
  getLength in interface InputFile
  
  Returns:
  
  the total length of the file, in bytes
- newStream
  
  public SeekableInputStream newStream()
  
  Description copied from interface: InputFile
  
  Opens a new SeekableInputStream for the underlying data file
  
  Specified by:
  
  newStream in interface InputFile
  
  Returns:
  
  a seekable stream for reading the file
- location
  
  public String location()
  
  Description copied from interface: InputFile
  
  The fully-qualified location of the input file as a String.
  
  Specified by:
  
  location in interface InputFile
  
  Returns:
  
  the input file location
- exists
  
  public boolean exists()
  
  Description copied from interface: InputFile
  
  Checks whether the file exists.
  
  Specified by:
  
  exists in interface InputFile
  
  Returns:
  
  true if the file exists, false otherwise