org.apache.hadoop.hive.metastore

Class MetaStoreListenerNotifier

java.lang.Object

org.apache.hadoop.hive.metastore.MetaStoreListenerNotifier

@InterfaceAudience.Private
public class MetaStoreListenerNotifier
extends Object

This class is used to notify a list of listeners about specific MetaStore events.

Constructor Summary

Constructors

Constructor and Description
MetaStoreListenerNotifier()

Method Summary

Modifier and Type	Method and Description
static Map<String,String>	notifyEvent(List<? extends MetaStoreEventListener> listeners, EventMessage.EventType eventType, ListenerEvent event) Notify a list of listeners about a specific metastore event.
static Map<String,String>	notifyEvent(List<? extends MetaStoreEventListener> listeners, EventMessage.EventType eventType, ListenerEvent event, EnvironmentContext environmentContext) Notify a list of listeners about a specific metastore event.
static Map<String,String>	notifyEvent(List<? extends MetaStoreEventListener> listeners, EventMessage.EventType eventType, ListenerEvent event, EnvironmentContext environmentContext, Map<String,String> parameters, RawStore ms) Notify a list of listeners about a specific metastore event.
static Map<String,String>	notifyEventWithDirectSql(List<? extends MetaStoreEventListener> listeners, EventMessage.EventType eventType, ListenerEvent event, Connection dbConn, SQLGenerator sqlGenerator) Notify a list of listeners about a specific metastore event to be executed within a txn.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaStoreListenerNotifier

public MetaStoreListenerNotifier()

Method Detail

notifyEvent

public static Map<String,String> notifyEvent(List<? extends MetaStoreEventListener> listeners,
                                             EventMessage.EventType eventType,
                                             ListenerEvent event)
                                      throws MetaException

Notify a list of listeners about a specific metastore event. Each listener notified might update the (ListenerEvent) event by setting a parameter key/value pair. These updated parameters will be returned to the caller.

Parameters:

listeners - List of MetaStoreEventListener listeners.

eventType - Type of the notification event.

event - The ListenerEvent with information about the event.

Returns:

A list of key/value pair parameters that the listeners set. The returned object will return an empty map if no parameters were updated or if no listeners were notified.

Throws:

MetaException - If an error occurred while calling the listeners.

notifyEventWithDirectSql

public static Map<String,String> notifyEventWithDirectSql(List<? extends MetaStoreEventListener> listeners,
                                                          EventMessage.EventType eventType,
                                                          ListenerEvent event,
                                                          Connection dbConn,
                                                          SQLGenerator sqlGenerator)
                                                   throws MetaException

Notify a list of listeners about a specific metastore event to be executed within a txn. Each listener notified might update the (ListenerEvent) event by setting a parameter key/value pair. These updated parameters will be returned to the caller.

Parameters:

listeners - List of MetaStoreEventListener listeners.

eventType - Type of the notification event.

event - The ListenerEvent with information about the event.

dbConn - The JDBC connection to the remote meta store db.

sqlGenerator - The helper class to generate db specific SQL string.

Returns:

A list of key/value pair parameters that the listeners set. The returned object will return an empty map if no parameters were updated or if no listeners were notified.

Throws:

MetaException - If an error occurred while calling the listeners.

notifyEvent

public static Map<String,String> notifyEvent(List<? extends MetaStoreEventListener> listeners,
                                             EventMessage.EventType eventType,
                                             ListenerEvent event,
                                             EnvironmentContext environmentContext)
                                      throws MetaException

Notify a list of listeners about a specific metastore event. Each listener notified might update the (ListenerEvent) event by setting a parameter key/value pair. These updated parameters will be returned to the caller.

Parameters:

listeners - List of MetaStoreEventListener listeners.

eventType - Type of the notification event.

event - The ListenerEvent with information about the event.

environmentContext - An EnvironmentContext object with parameters sent by the HMS client.

Returns:

A list of key/value pair parameters that the listeners set. The returned object will return an empty map if no parameters were updated or if no listeners were notified.

Throws:

MetaException - If an error occurred while calling the listeners.

notifyEvent

public static Map<String,String> notifyEvent(List<? extends MetaStoreEventListener> listeners,
                                             EventMessage.EventType eventType,
                                             ListenerEvent event,
                                             EnvironmentContext environmentContext,
                                             Map<String,String> parameters,
                                             RawStore ms)
                                      throws MetaException

Notify a list of listeners about a specific metastore event. Each listener notified might update the (ListenerEvent) event by setting a parameter key/value pair. These updated parameters will be returned to the caller. Sometimes these events are run inside a DB transaction and might cause issues with the listeners, for instance, Sentry blocks the HMS until an event is seen committed on the DB. To notify the listener about this, a new parameter to verify if a transaction is active is added to the ListenerEvent, and is up to the listener to skip this notification if so.

Parameters:

listeners - List of MetaStoreEventListener listeners.

eventType - Type of the notification event.

event - The ListenerEvent with information about the event.

environmentContext - An EnvironmentContext object with parameters sent by the HMS client.

parameters - A list of key/value pairs with the new parameters to add.

ms - The RawStore object from where to check if a transaction is active.

Returns:

A list of key/value pair parameters that the listeners set. The returned object will return an empty map if no parameters were updated or if no listeners were notified.

Throws:

MetaException - If an error occurred while calling the listeners.