Package org.apache.orc.impl.reader

Class ReaderEncryptionKey

java.lang.Object

org.apache.orc.impl.reader.ReaderEncryptionKey

All Implemented Interfaces:

Comparable<EncryptionKey>, EncryptionKey

public class ReaderEncryptionKey
extends Object
implements EncryptionKey

This tracks the keys for reading encrypted columns.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ReaderEncryptionKey.State	Store the state of whether we've tried to decrypt a local key using this key or not.

Constructor Summary

Constructors

Constructor	Description
ReaderEncryptionKey(OrcProto.EncryptionKey key)

Method Summary

Modifier and Type	Method	Description
int	compareTo(@NotNull EncryptionKey other)
boolean	equals(Object other)
EncryptionAlgorithm	getAlgorithm()	The encryption algorithm for this key.
ReaderEncryptionVariant[]	getEncryptionRoots()	The columns that are encrypted with this key.
String	getKeyName()	The name of the key.
int	getKeyVersion()	The version of the key.
HadoopShims.KeyMetadata	getMetadata()
ReaderEncryptionKey.State	getState()
int	hashCode()
boolean	isAvailable()	Is the key available to this user?
void	setFailure()
void	setSuccess()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ReaderEncryptionKey

public ReaderEncryptionKey(OrcProto.EncryptionKey key)

Method Details

getKeyName

public String getKeyName()

Description copied from interface: EncryptionKey

The name of the key.

Specified by:

getKeyName in interface EncryptionKey

Returns:

the name

getKeyVersion

public int getKeyVersion()

Description copied from interface: EncryptionKey

The version of the key.

Specified by:

getKeyVersion in interface EncryptionKey

Returns:

the version, which for most KeyProviders start at 0.

getAlgorithm

public EncryptionAlgorithm getAlgorithm()

Description copied from interface: EncryptionKey

The encryption algorithm for this key.

Specified by:

getAlgorithm in interface EncryptionKey

Returns:

the encryption algorithm

getEncryptionRoots

public ReaderEncryptionVariant[] getEncryptionRoots()

Description copied from interface: EncryptionKey

The columns that are encrypted with this key.

Specified by:

getEncryptionRoots in interface EncryptionKey

Returns:

the list of columns

getMetadata

public HadoopShims.KeyMetadata getMetadata()

getState

public ReaderEncryptionKey.State getState()

setFailure

public void setFailure()

setSuccess

public void setSuccess()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(@NotNull
 @NotNull EncryptionKey other)

Specified by:

compareTo in interface Comparable<EncryptionKey>

toString

public String toString()

Overrides:

toString in class Object

isAvailable

public boolean isAvailable()

Description copied from interface: EncryptionKey

Is the key available to this user?

Specified by:

isAvailable in interface EncryptionKey

Returns:

true if the key is available