org.apache.hadoop.hive.metastore.events

Class ListenerEvent

java.lang.Object

org.apache.hadoop.hive.metastore.events.ListenerEvent

Direct Known Subclasses:

AbortTxnEvent, AcidWriteEvent, AddCheckConstraintEvent, AddDefaultConstraintEvent, AddForeignKeyEvent, AddNotNullConstraintEvent, AddPartitionEvent, AddPrimaryKeyEvent, AddSchemaVersionEvent, AddUniqueConstraintEvent, AllocWriteIdEvent, AlterCatalogEvent, AlterDatabaseEvent, AlterDataConnectorEvent, AlterISchemaEvent, AlterPartitionEvent, AlterSchemaVersionEvent, AlterTableEvent, BatchAcidWriteEvent, CommitCompactionEvent, CommitTxnEvent, ConfigChangeEvent, CreateCatalogEvent, CreateDatabaseEvent, CreateDataConnectorEvent, CreateFunctionEvent, CreateISchemaEvent, CreateTableEvent, DeletePartitionColumnStatEvent, DeleteTableColumnStatEvent, DropCatalogEvent, DropConstraintEvent, DropDatabaseEvent, DropDataConnectorEvent, DropFunctionEvent, DropISchemaEvent, DropPartitionEvent, DropSchemaVersionEvent, DropTableEvent, InsertEvent, LoadPartitionDoneEvent, OpenTxnEvent, ReloadEvent, UpdatePartitionColumnStatEvent, UpdatePartitionColumnStatEventBatch, UpdateTableColumnStatEvent

@InterfaceAudience.Public
 @InterfaceStability.Stable
 @NotThreadSafe
public abstract class ListenerEvent
extends Object

Base class for all the events which are defined for metastore. This class is not thread-safe and not expected to be called in parallel.

Constructor Summary

Constructors

Constructor and Description
ListenerEvent(boolean status, IHMSHandler handler)

Method Summary

Modifier and Type	Method and Description
EnvironmentContext	getEnvironmentContext()
HMSHandler	getHandler() Deprecated.
IHMSHandler	getIHMSHandler()
Map<String,String>	getParameters() Return all parameters of the listener event.
boolean	getStatus()
void	putParameter(String name, String value) Put a new parameter to the listener event.
void	putParameters(Map<String,String> parameters) Put a new set the parameters to the listener event.
void	setEnvironmentContext(EnvironmentContext environmentContext) Set the environment context of the event.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListenerEvent

public ListenerEvent(boolean status,
                     IHMSHandler handler)

Method Detail

getStatus

public boolean getStatus()

Returns:

the status of event.

setEnvironmentContext

public void setEnvironmentContext(EnvironmentContext environmentContext)

Set the environment context of the event.

Parameters:

environmentContext - An EnvironmentContext object that contains environment parameters sent from the HMS client.

getEnvironmentContext

public EnvironmentContext getEnvironmentContext()

Returns:

environment properties of the event

getHandler

@Deprecated
public HMSHandler getHandler()

Deprecated.

You should use getIHMSHandler() instead.

Returns:

handler.

getIHMSHandler

public IHMSHandler getIHMSHandler()

Returns:

the handler

getParameters

public final Map<String,String> getParameters()

Return all parameters of the listener event. Parameters are read-only (unmodifiable map). If a new parameter must be added, please use the putParameter() method.

Returns:

A map object with all parameters.

putParameter

public void putParameter(String name,
                         String value)

Put a new parameter to the listener event. Overridden parameters is not allowed, and an exception may be thrown to avoid a mis-configuration between listeners setting the same parameters.

Parameters:

name - Name of the parameter.

value - Value of the parameter.

Throws:

IllegalStateException - if a parameter already exists.

putParameters

public void putParameters(Map<String,String> parameters)

Put a new set the parameters to the listener event. Overridden parameters is not allowed, and an exception may be thrown to avoid a mis-configuration between listeners setting the same parameters.

Parameters:

parameters - A Map object with the a set of parameters.

Throws:

IllegalStateException - if a parameter already exists.