org.apache.hadoop.hive.shims

Interface HadoopShims.HdfsEncryptionShim

All Known Implementing Classes:

Hadoop23Shims.HdfsEncryptionShim, HadoopShims.NoopHdfsEncryptionShim

Enclosing interface:

HadoopShims

public static interface HadoopShims.HdfsEncryptionShim

This interface encapsulates methods used to get encryption information from HDFS paths.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	arePathsOnSameEncryptionZone(org.apache.hadoop.fs.Path path1, org.apache.hadoop.fs.Path path2) Checks if two HDFS paths are on the same encrypted or unencrypted zone.
int	comparePathKeyStrength(org.apache.hadoop.fs.Path path1, org.apache.hadoop.fs.Path path2) Compares two encrypted path strengths.
void	createEncryptionZone(org.apache.hadoop.fs.Path path, String keyName) create encryption zone by path and keyname
void	createKey(String keyName, int bitLength) Creates an encryption key.
void	deleteKey(String keyName)
List<String>	getKeys()
boolean	isPathEncrypted(org.apache.hadoop.fs.Path path) Checks if a given HDFS path is encrypted.

Method Detail

isPathEncrypted

boolean isPathEncrypted(org.apache.hadoop.fs.Path path)
                        throws IOException

Checks if a given HDFS path is encrypted.

Parameters:

path - Path to HDFS file system

Returns:

True if it is encrypted; False otherwise.

Throws:

IOException - If an error occurred attempting to get encryption information

arePathsOnSameEncryptionZone

boolean arePathsOnSameEncryptionZone(org.apache.hadoop.fs.Path path1,
                                   org.apache.hadoop.fs.Path path2)
                                     throws IOException

Checks if two HDFS paths are on the same encrypted or unencrypted zone.

Parameters:

path1 - Path to HDFS file system

path2 - Path to HDFS file system

Returns:

True if both paths are in the same zone; False otherwise.

Throws:

IOException - If an error occurred attempting to get encryption information

comparePathKeyStrength

int comparePathKeyStrength(org.apache.hadoop.fs.Path path1,
                         org.apache.hadoop.fs.Path path2)
                           throws IOException

Compares two encrypted path strengths.

Parameters:

path1 - HDFS path to compare.

path2 - HDFS path to compare.

Returns:

1 if path1 is stronger; 0 if paths are equals; -1 if path1 is weaker.

Throws:

IOException - If an error occurred attempting to get encryption/key metadata

createEncryptionZone

void createEncryptionZone(org.apache.hadoop.fs.Path path,
                        String keyName)
                          throws IOException

create encryption zone by path and keyname

Parameters:

path - HDFS path to create encryption zone

keyName - keyname

Throws:

IOException

createKey

void createKey(String keyName,
             int bitLength)
               throws IOException,
                      NoSuchAlgorithmException

Creates an encryption key.

Parameters:

keyName - Name of the key

bitLength - Key encryption length in bits (128 or 256).

Throws:

IOException - If an error occurs while creating the encryption key

NoSuchAlgorithmException - If cipher algorithm is invalid.

deleteKey

void deleteKey(String keyName)
               throws IOException

Throws:

IOException

getKeys

List<String> getKeys()
                     throws IOException

Throws:

IOException