org.apache.hive.hcatalog.messaging

Class MessageFactory

java.lang.Object

org.apache.hive.hcatalog.messaging.MessageFactory

Direct Known Subclasses:

JSONMessageFactory

public abstract class MessageFactory
extends Object

Abstract Factory for the construction of HCatalog message instances.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	HCAT_SERVER_URL
protected static String	HCAT_SERVICE_PRINCIPAL
protected static HiveConf	hiveConf

Constructor Summary

Constructors

Constructor and Description
MessageFactory()

Method Summary

Methods

Modifier and Type	Method and Description
abstract AddPartitionMessage	buildAddPartitionMessage(Table table, Iterator<Partition> partitions) Factory method for AddPartitionMessage.
abstract AlterPartitionMessage	buildAlterPartitionMessage(Table table, Partition before, Partition after) Factory method for building AlterPartitionMessage
abstract AlterTableMessage	buildAlterTableMessage(Table before, Table after) Factory method for AlterTableMessage.
abstract CreateDatabaseMessage	buildCreateDatabaseMessage(Database db) Factory method for CreateDatabaseMessage.
abstract CreateTableMessage	buildCreateTableMessage(Table table) Factory method for CreateTableMessage.
abstract DropDatabaseMessage	buildDropDatabaseMessage(Database db) Factory method for DropDatabaseMessage.
abstract DropPartitionMessage	buildDropPartitionMessage(Table table, Iterator<Partition> partitions) Factory method for DropPartitionMessage.
abstract DropTableMessage	buildDropTableMessage(Table table) Factory method for DropTableMessage.
abstract InsertMessage	buildInsertMessage(String db, String table, Map<String,String> partVals, List<String> files) Factory method for building insert message
abstract MessageDeserializer	getDeserializer()
static MessageDeserializer	getDeserializer(String format, String version) Getter for MessageDeserializer, corresponding to the specified format and version.
static MessageFactory	getInstance() Getter for MessageFactory instance.
abstract String	getMessageFormat() Getter for message-format.
abstract String	getVersion() Getter for version-string, corresponding to all constructed messages.

Methods inherited from class java.lang.Object

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

Field Detail

hiveConf

protected static final HiveConf hiveConf

HCAT_SERVER_URL

protected static final String HCAT_SERVER_URL

HCAT_SERVICE_PRINCIPAL

protected static final String HCAT_SERVICE_PRINCIPAL

Constructor Detail

MessageFactory

public MessageFactory()

Method Detail

getInstance

public static MessageFactory getInstance()

Getter for MessageFactory instance.

getDeserializer

public static MessageDeserializer getDeserializer(String format,
                                  String version)

Getter for MessageDeserializer, corresponding to the specified format and version.

Parameters:

format - Serialization format for notifications.

version - Version of serialization format (currently ignored.)

Returns:

MessageDeserializer.

getDeserializer

public abstract MessageDeserializer getDeserializer()

getVersion

public abstract String getVersion()

Getter for version-string, corresponding to all constructed messages.

getMessageFormat

public abstract String getMessageFormat()

Getter for message-format.

buildCreateDatabaseMessage

public abstract CreateDatabaseMessage buildCreateDatabaseMessage(Database db)

Factory method for CreateDatabaseMessage.

Parameters:

db - The Database being added.

Returns:

CreateDatabaseMessage instance.

buildDropDatabaseMessage

public abstract DropDatabaseMessage buildDropDatabaseMessage(Database db)

Factory method for DropDatabaseMessage.

Parameters:

db - The Database being dropped.

Returns:

DropDatabaseMessage instance.

buildCreateTableMessage

public abstract CreateTableMessage buildCreateTableMessage(Table table)

Factory method for CreateTableMessage.

Parameters:

table - The Table being created.

Returns:

CreateTableMessage instance.

buildAlterTableMessage

public abstract AlterTableMessage buildAlterTableMessage(Table before,
                                       Table after)

Factory method for AlterTableMessage. Unlike most of these calls, this one can return null, which means no message should be sent. This is because there are many flavors of alter table (add column, add partition, etc.). Some are covered elsewhere (like add partition) and some are not yet supported.

Parameters:

before - The table before the alter

after - The table after the alter

Returns:

buildDropTableMessage

public abstract DropTableMessage buildDropTableMessage(Table table)

Factory method for DropTableMessage.

Parameters:

table - The Table being dropped.

Returns:

DropTableMessage instance.

buildAddPartitionMessage

public abstract AddPartitionMessage buildAddPartitionMessage(Table table,
                                           Iterator<Partition> partitions)

Factory method for AddPartitionMessage.

Parameters:

table - The Table to which the partitions are added.

partitions - The iterator to set of Partitions being added.

Returns:

AddPartitionMessage instance.

buildAlterPartitionMessage

public abstract AlterPartitionMessage buildAlterPartitionMessage(Table table,
                                               Partition before,
                                               Partition after)

Factory method for building AlterPartitionMessage

Parameters:

table - The table in which the partition is being altered

before - The partition before it was altered

after - The partition after it was altered

Returns:

a new AlterPartitionMessage

buildDropPartitionMessage

public abstract DropPartitionMessage buildDropPartitionMessage(Table table,
                                             Iterator<Partition> partitions)

Factory method for DropPartitionMessage.

Parameters:

table - The Table from which the partition is dropped.

partitions - The set of partitions being dropped.

Returns:

DropPartitionMessage instance.

buildInsertMessage

public abstract InsertMessage buildInsertMessage(String db,
                               String table,
                               Map<String,String> partVals,
                               List<String> files)

Factory method for building insert message

Parameters:

db - Name of the database the insert occurred in

table - Name of the table the insert occurred in

partVals - Partition values for the partition that the insert occurred in, may be null if the insert was done into a non-partitioned table

files - List of files created as a result of the insert, may be null.

Returns:

instance of InsertMessage