org.apache.nifi.dbcp.hive

Class HiveConnectionPool

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.dbcp.hive.HiveConnectionPool

All Implemented Interfaces:

ConfigurableComponent, ControllerService, DBCPService, HiveDBCPService

@RequiresInstanceClassLoading
 @Tags(value={"hive","dbcp","jdbc","database","connection","pooling","store"})
 @CapabilityDescription(value="Provides Database Connection Pooling Service for Apache Hive. Connections can be asked from pool and returned after usage.")
public class HiveConnectionPool
extends AbstractControllerService
implements HiveDBCPService

Implementation for Database Connection Pooling Service used for Apache Hive connections. Apache DBCP is used for connection pooling functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	DATABASE_URL
static PropertyDescriptor	DB_PASSWORD
static PropertyDescriptor	DB_USER
static PropertyDescriptor	HIVE_CONFIGURATION_RESOURCES
static PropertyDescriptor	MAX_TOTAL_CONNECTIONS
static PropertyDescriptor	MAX_WAIT_TIME
static PropertyDescriptor	VALIDATION_QUERY

Constructor Summary

Constructors

Constructor and Description
HiveConnectionPool()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<ValidationResult>	customValidate(ValidationContext validationContext) Allows subclasses to perform their own validation on the already set properties.
java.sql.Connection	getConnection()
java.lang.String	getConnectionURL()
protected java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
protected void	init(ControllerServiceInitializationContext context) Provides a mechanism by which subclasses can perform initialization of the Controller Service before it is scheduled to be run
void	onConfigured(ConfigurationContext context) Configures connection pool by creating an instance of the BasicDataSource based on configuration provided with ConfigurationContext.
void	shutdown() Shutdown pool, close all open connections.
java.lang.String	toString()

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getProperty, getStateManager, initialize, isEnabled

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

DATABASE_URL

public static final PropertyDescriptor DATABASE_URL

HIVE_CONFIGURATION_RESOURCES

public static final PropertyDescriptor HIVE_CONFIGURATION_RESOURCES

DB_USER

public static final PropertyDescriptor DB_USER

DB_PASSWORD

public static final PropertyDescriptor DB_PASSWORD

MAX_WAIT_TIME

public static final PropertyDescriptor MAX_WAIT_TIME

MAX_TOTAL_CONNECTIONS

public static final PropertyDescriptor MAX_TOTAL_CONNECTIONS

VALIDATION_QUERY

public static final PropertyDescriptor VALIDATION_QUERY

Constructor Detail

HiveConnectionPool

public HiveConnectionPool()

Method Detail

init

protected void init(ControllerServiceInitializationContext context)

Description copied from class: AbstractControllerService

Provides a mechanism by which subclasses can perform initialization of the Controller Service before it is scheduled to be run

Overrides:

init in class AbstractControllerService

Parameters:

context - of initialization context

getSupportedPropertyDescriptors

protected java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

customValidate

protected java.util.Collection<ValidationResult> customValidate(ValidationContext validationContext)

Description copied from class: AbstractConfigurableComponent

Allows subclasses to perform their own validation on the already set properties. Since each property is validated as it is set this allows validation of groups of properties together. Default return is an empty set. This method will be called only when it has been determined that all property values are valid according to their corresponding PropertyDescriptor's validators.

Overrides:

customValidate in class AbstractConfigurableComponent

Parameters:

validationContext - provides a mechanism for obtaining externally managed values, such as property values and supplies convenience methods for operating on those values

Returns:

Collection of ValidationResult objects that will be added to any other validation findings - may be null

onConfigured

@OnEnabled
public void onConfigured(ConfigurationContext context)
                             throws InitializationException

Configures connection pool by creating an instance of the BasicDataSource based on configuration provided with ConfigurationContext.

This operation makes no guarantees that the actual connection could be made since the underlying system may still go off-line during normal operation of the connection pool.

Parameters:

context - the configuration context

Throws:

InitializationException - if unable to create a database connection

shutdown

@OnDisabled
public void shutdown()

Shutdown pool, close all open connections.

getConnection

public java.sql.Connection getConnection()
                                  throws ProcessException

Specified by:

getConnection in interface DBCPService

Throws:

ProcessException

toString

public java.lang.String toString()

Overrides:

toString in class AbstractConfigurableComponent

getConnectionURL

public java.lang.String getConnectionURL()

Specified by:

getConnectionURL in interface HiveDBCPService