org.apache.hadoop.hive.metastore.utils

Class FilterUtils

java.lang.Object

org.apache.hadoop.hive.metastore.utils.FilterUtils

public class FilterUtils
extends Object

Utilities common to Filtering operations.

Constructor Summary

Constructors

Constructor and Description
FilterUtils()

Method Summary

Modifier and Type	Method and Description
static void	checkDbAndTableFilters(boolean isFilterEnabled, MetaStoreFilterHook filterHook, String catName, String dbName, String tblName) Check if the current user has access to a given database and table name.
static Catalog	filterCatalogIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, Catalog catalog) Filter the catalog if filtering is enabled; Otherwise, return original object
static List<String>	filterCatalogNamesIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, List<String> catalogNames) Filter list of catalog names if filtering is enabled; Otherwise, return original list
static GetLatestCommittedCompactionInfoResponse	filterCommittedCompactionInfoStructIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, String catName, String dbName, String tableName, GetLatestCommittedCompactionInfoResponse response)
static List<ShowCompactResponseElement>	filterCompactionsIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, String catName, List<ShowCompactResponseElement> compactions) Filter the list of compactions if filtering is enabled.
static List<String>	filterDataConnectorsIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, List<String> connectorNames) Filter the list of dataconnectors if filtering is enabled.
static Database	filterDbIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, Database db) Filter the DB if filtering is enabled.
static List<String>	filterDbNamesIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, List<String> dbNames) Filter the list of databases if filtering is enabled.
static Partition	filterPartitionIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, Partition p) Filter the partition if filtering is enabled.
static List<String>	filterPartitionNamesIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, String catName, String dbName, String tableName, List<String> partitionNames) Filter the list of partitions if filtering is enabled.
static List<Partition>	filterPartitionsIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, List<Partition> partitions) Filter the list of partitions if filtering is enabled.
static List<PartitionSpec>	filterPartitionSpecsIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, List<PartitionSpec> partitionSpecs) Filter the list of PartitionSpec if filtering is enabled; Otherwise, return original list
static Table	filterTableIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, Table table) Filter the table if filtering is enabled.
static List<TableMeta>	filterTableMetasIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, List<TableMeta> tableMetas) Filter list of meta data of tables if filtering is enabled.
static List<String>	filterTableNamesIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, String catName, String dbName, List<String> tableNames) Filter the list of tables if filtering is enabled.
static List<Table>	filterTablesIfEnabled(boolean isFilterEnabled, MetaStoreFilterHook filterHook, List<Table> tables) Filter the list of tables if filtering is enabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterUtils

public FilterUtils()

Method Detail

filterDbIfEnabled

public static Database filterDbIfEnabled(boolean isFilterEnabled,
                                         MetaStoreFilterHook filterHook,
                                         Database db)
                                  throws MetaException,
                                         NoSuchObjectException

Filter the DB if filtering is enabled. Otherwise, return original DB object

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

db: - the database object from HMS metadata

Returns:

the original database object if current user has access; otherwise, throw NoSuchObjectException exception

Throws:

MetaException

NoSuchObjectException

filterDbNamesIfEnabled

public static List<String> filterDbNamesIfEnabled(boolean isFilterEnabled,
                                                  MetaStoreFilterHook filterHook,
                                                  List<String> dbNames)
                                           throws MetaException

Filter the list of databases if filtering is enabled. Otherwise, return original list

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

dbNames: - the list of database names to filter

Returns:

the list of database names that current user has access if filtering is enabled; otherwise, the original list

Throws:

MetaException

filterDataConnectorsIfEnabled

public static List<String> filterDataConnectorsIfEnabled(boolean isFilterEnabled,
                                                         MetaStoreFilterHook filterHook,
                                                         List<String> connectorNames)
                                                  throws MetaException

Filter the list of dataconnectors if filtering is enabled. Otherwise, return original list

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

connectorNames: - the list of dataconnector names to filter

Returns:

the list of dataconnector names that current user has access if filtering is enabled; otherwise, the original list

Throws:

MetaException

filterTableNamesIfEnabled

public static List<String> filterTableNamesIfEnabled(boolean isFilterEnabled,
                                                     MetaStoreFilterHook filterHook,
                                                     String catName,
                                                     String dbName,
                                                     List<String> tableNames)
                                              throws MetaException

Filter the list of tables if filtering is enabled. Otherwise, return original list

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

catName: - the catalog name of the tables

dbName: - the database name to the tables

tableNames: - the list of table names to filter

Returns:

the list of table names that current user has access if filtering is enabled; otherwise, the original list

Throws:

MetaException

filterTablesIfEnabled

public static List<Table> filterTablesIfEnabled(boolean isFilterEnabled,
                                                MetaStoreFilterHook filterHook,
                                                List<Table> tables)
                                         throws MetaException

Filter the list of tables if filtering is enabled. Otherwise, return original list

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

tables: - the list of table objects to filter

Returns:

the list of tables that current user has access if filtering is enabled; otherwise, the original list

Throws:

MetaException

filterTableIfEnabled

public static Table filterTableIfEnabled(boolean isFilterEnabled,
                                         MetaStoreFilterHook filterHook,
                                         Table table)
                                  throws MetaException,
                                         NoSuchObjectException

Filter the table if filtering is enabled. Otherwise, return original table object

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

table: - the table object from Hive meta data

Returns:

the table object if user has access or filtering is disabled; throw NoSuchObjectException if user does not have access to this table

Throws:

MetaException

NoSuchObjectException

filterTableMetasIfEnabled

public static List<TableMeta> filterTableMetasIfEnabled(boolean isFilterEnabled,
                                                        MetaStoreFilterHook filterHook,
                                                        List<TableMeta> tableMetas)
                                                 throws MetaException,
                                                        NoSuchObjectException

Filter list of meta data of tables if filtering is enabled. Otherwise, return original list

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

tableMetas: - the list of meta data of tables

Returns:

the list of table meta data that current user has access if filtering is enabled; otherwise, the original list

Throws:

MetaException

NoSuchObjectException

filterPartitionIfEnabled

public static Partition filterPartitionIfEnabled(boolean isFilterEnabled,
                                                 MetaStoreFilterHook filterHook,
                                                 Partition p)
                                          throws MetaException,
                                                 NoSuchObjectException

Filter the partition if filtering is enabled. Otherwise, return original object

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

p: - the partition object

Returns:

the partition object that user has access or original list if filtering is disabled; Otherwise, throw NoSuchObjectException

Throws:

MetaException

NoSuchObjectException

filterPartitionsIfEnabled

public static List<Partition> filterPartitionsIfEnabled(boolean isFilterEnabled,
                                                        MetaStoreFilterHook filterHook,
                                                        List<Partition> partitions)
                                                 throws MetaException

Filter the list of partitions if filtering is enabled. Otherwise, return original list

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

partitions: - the list of partitions

Returns:

the list of partitions that user has access or original list if filtering is disabled;

Throws:

MetaException

filterPartitionNamesIfEnabled

public static List<String> filterPartitionNamesIfEnabled(boolean isFilterEnabled,
                                                         MetaStoreFilterHook filterHook,
                                                         String catName,
                                                         String dbName,
                                                         String tableName,
                                                         List<String> partitionNames)
                                                  throws MetaException

Filter the list of partitions if filtering is enabled. Otherwise, return original list

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

catName: - the catalog name

dbName: - the database name

tableName: - the table name

partitionNames: - the list of partition names

Returns:

the list of partitions that current user has access if filtering is enabled; Otherwise, the original list

Throws:

MetaException

filterPartitionSpecsIfEnabled

public static List<PartitionSpec> filterPartitionSpecsIfEnabled(boolean isFilterEnabled,
                                                                MetaStoreFilterHook filterHook,
                                                                List<PartitionSpec> partitionSpecs)
                                                         throws MetaException

Filter the list of PartitionSpec if filtering is enabled; Otherwise, return original list

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

partitionSpecs: - the list of PartitionSpec

Returns:

the list of PartitionSpec that current user has access if filtering is enabled; Otherwise, the original list

Throws:

MetaException

filterCatalogIfEnabled

public static Catalog filterCatalogIfEnabled(boolean isFilterEnabled,
                                             MetaStoreFilterHook filterHook,
                                             Catalog catalog)
                                      throws MetaException,
                                             NoSuchObjectException

Filter the catalog if filtering is enabled; Otherwise, return original object

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

catalog: - the catalog object

Returns:

the catalog object that current user has access or filtering is disabled; Otherwise, throw NoSuchObjectException

Throws:

MetaException

NoSuchObjectException

filterCatalogNamesIfEnabled

public static List<String> filterCatalogNamesIfEnabled(boolean isFilterEnabled,
                                                       MetaStoreFilterHook filterHook,
                                                       List<String> catalogNames)
                                                throws MetaException

Filter list of catalog names if filtering is enabled; Otherwise, return original list

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtring is disabled.

filterHook: - the object that does filtering

catalogNames: - the list of catalog names

Returns:

the list of catalog names that the current user has access or original list if filtering is disabled;

Throws:

MetaException

checkDbAndTableFilters

public static void checkDbAndTableFilters(boolean isFilterEnabled,
                                          MetaStoreFilterHook filterHook,
                                          String catName,
                                          String dbName,
                                          String tblName)
                                   throws NoSuchObjectException,
                                          MetaException

Check if the current user has access to a given database and table name. Throw NoSuchObjectException if user has no access. When the db or table is filtered out, we don't need to even fetch the partitions. Therefore this check ensures table-level security and could improve performance when filtering partitions.

Parameters:

dbName - the database name

tblName - the table name contained in the database

Throws:

NoSuchObjectException - if the database or table is filtered out

MetaException

filterCompactionsIfEnabled

public static List<ShowCompactResponseElement> filterCompactionsIfEnabled(boolean isFilterEnabled,
                                                                          MetaStoreFilterHook filterHook,
                                                                          String catName,
                                                                          List<ShowCompactResponseElement> compactions)
                                                                   throws MetaException

Filter the list of compactions if filtering is enabled. Otherwise, return original list

Parameters:

isFilterEnabled - true: filtering is enabled; false: filtering is disabled.

filterHook - the object that does filtering

compactions - the list of compactions

Returns:

the list of compactions that user has access or original list if filtering is disabled;

Throws:

MetaException

filterCommittedCompactionInfoStructIfEnabled

public static GetLatestCommittedCompactionInfoResponse filterCommittedCompactionInfoStructIfEnabled(boolean isFilterEnabled,
                                                                                                    MetaStoreFilterHook filterHook,
                                                                                                    String catName,
                                                                                                    String dbName,
                                                                                                    String tableName,
                                                                                                    GetLatestCommittedCompactionInfoResponse response)
                                                                                             throws MetaException

Throws:

MetaException