org.apache.nifi.dbcp

Class AbstractDBCPConnectionPool

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.dbcp.AbstractDBCPConnectionPool

All Implemented Interfaces:

ConfigurableComponent, ControllerService, VerifiableControllerService, DBCPService

public abstract class AbstractDBCPConnectionPool
extends AbstractControllerService
implements DBCPService, VerifiableControllerService

Abstract base class for Database Connection Pooling Services using Apache Commons DBCP as the underlying connection pool implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	DATABASE_URL
protected org.apache.commons.dbcp2.BasicDataSource	dataSource
static PropertyDescriptor	DB_DRIVER_LOCATION
static PropertyDescriptor	DB_DRIVERNAME
static PropertyDescriptor	DB_PASSWORD
static PropertyDescriptor	DB_USER
private static String	DEFAULT_EVICTION_RUN_PERIOD Copied from BaseObjectPoolConfig.DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS in Commons-DBCP 2.7.0
private static String	DEFAULT_MAX_CONN_LIFETIME Copied from private variable BasicDataSource.maxConnLifetimeMillis in Commons-DBCP 2.7.0
private static String	DEFAULT_MAX_IDLE Copied from GenericObjectPoolConfig.DEFAULT_MAX_IDLE in Commons-DBCP 2.7.0
private static String	DEFAULT_MIN_EVICTABLE_IDLE_TIME Copied from BaseObjectPoolConfig.DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS in Commons-DBCP 2.7.0 and converted from 1800000L to "1800000 millis" to "30 mins"
private static String	DEFAULT_MIN_IDLE Copied from GenericObjectPoolConfig.DEFAULT_MIN_IDLE in Commons-DBCP 2.7.0
private static String	DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME Copied from BaseObjectPoolConfig.DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS in Commons-DBCP 2.7.0
static PropertyDescriptor	EVICTION_RUN_PERIOD
static PropertyDescriptor	KERBEROS_CREDENTIALS_SERVICE
static PropertyDescriptor	KERBEROS_PASSWORD
static PropertyDescriptor	KERBEROS_PRINCIPAL
static PropertyDescriptor	KERBEROS_USER_SERVICE
protected KerberosUser	kerberosUser
static PropertyDescriptor	MAX_CONN_LIFETIME
static PropertyDescriptor	MAX_IDLE
static PropertyDescriptor	MAX_TOTAL_CONNECTIONS
static PropertyDescriptor	MAX_WAIT_TIME
static PropertyDescriptor	MIN_EVICTABLE_IDLE_TIME
static PropertyDescriptor	MIN_IDLE
protected static String	SENSITIVE_PROPERTY_PREFIX Property Name Prefix for Sensitive Dynamic Properties
static PropertyDescriptor	SOFT_MIN_EVICTABLE_IDLE_TIME
static PropertyDescriptor	VALIDATION_QUERY

Constructor Summary

Constructors

Constructor and Description
AbstractDBCPConnectionPool()

Method Summary

Modifier and Type	Method and Description
private void	configureDataSource(org.apache.commons.dbcp2.BasicDataSource dataSource, KerberosUser kerberosUser, ConfigurationContext context)
protected Long	extractMillisWithInfinite(PropertyValue prop)
Connection	getConnection()
private Connection	getConnection(org.apache.commons.dbcp2.BasicDataSource dataSource, KerberosUser kerberosUser)
protected Map<String,String>	getConnectionProperties(ConfigurationContext context) Override in subclasses to provide connection properties to the data source
protected Driver	getDriver(String driverName, String url)
private KerberosUser	getKerberosUser(ConfigurationContext context)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected String	getUrl(ConfigurationContext context)
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.
private void	shutdown(org.apache.commons.dbcp2.BasicDataSource dataSource, KerberosUser kerberosUser)
String	toString()
List<ConfigVerificationResult>	verify(ConfigurationContext context, ComponentLog verificationLogger, Map<String,String> variables)

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

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

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedPropertyDescriptors, 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.dbcp.DBCPService

getConnection, getFlowFileFilter, getFlowFileFilter

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

initialize, isStateful

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

SENSITIVE_PROPERTY_PREFIX

protected static final String SENSITIVE_PROPERTY_PREFIX

Property Name Prefix for Sensitive Dynamic Properties

See Also:

Constant Field Values

DEFAULT_MIN_IDLE

private static final String DEFAULT_MIN_IDLE

Copied from GenericObjectPoolConfig.DEFAULT_MIN_IDLE in Commons-DBCP 2.7.0

See Also:

Constant Field Values

DEFAULT_MAX_IDLE

private static final String DEFAULT_MAX_IDLE

Copied from GenericObjectPoolConfig.DEFAULT_MAX_IDLE in Commons-DBCP 2.7.0

See Also:

Constant Field Values

DEFAULT_MAX_CONN_LIFETIME

private static final String DEFAULT_MAX_CONN_LIFETIME

Copied from private variable BasicDataSource.maxConnLifetimeMillis in Commons-DBCP 2.7.0

See Also:

Constant Field Values

DEFAULT_EVICTION_RUN_PERIOD

private static final String DEFAULT_EVICTION_RUN_PERIOD

Copied from BaseObjectPoolConfig.DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS in Commons-DBCP 2.7.0

DEFAULT_MIN_EVICTABLE_IDLE_TIME

private static final String DEFAULT_MIN_EVICTABLE_IDLE_TIME

Copied from BaseObjectPoolConfig.DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS in Commons-DBCP 2.7.0 and converted from 1800000L to "1800000 millis" to "30 mins"

See Also:

Constant Field Values

DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME

private static final String DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME

Copied from BaseObjectPoolConfig.DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS in Commons-DBCP 2.7.0

DATABASE_URL

public static final PropertyDescriptor DATABASE_URL

DB_DRIVERNAME

public static final PropertyDescriptor DB_DRIVERNAME

DB_DRIVER_LOCATION

public static final PropertyDescriptor DB_DRIVER_LOCATION

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

MIN_IDLE

public static final PropertyDescriptor MIN_IDLE

MAX_IDLE

public static final PropertyDescriptor MAX_IDLE

MAX_CONN_LIFETIME

public static final PropertyDescriptor MAX_CONN_LIFETIME

EVICTION_RUN_PERIOD

public static final PropertyDescriptor EVICTION_RUN_PERIOD

MIN_EVICTABLE_IDLE_TIME

public static final PropertyDescriptor MIN_EVICTABLE_IDLE_TIME

SOFT_MIN_EVICTABLE_IDLE_TIME

public static final PropertyDescriptor SOFT_MIN_EVICTABLE_IDLE_TIME

KERBEROS_CREDENTIALS_SERVICE

public static final PropertyDescriptor KERBEROS_CREDENTIALS_SERVICE

KERBEROS_USER_SERVICE

public static final PropertyDescriptor KERBEROS_USER_SERVICE

KERBEROS_PRINCIPAL

public static final PropertyDescriptor KERBEROS_PRINCIPAL

KERBEROS_PASSWORD

public static final PropertyDescriptor KERBEROS_PASSWORD

dataSource

protected volatile org.apache.commons.dbcp2.BasicDataSource dataSource

kerberosUser

protected volatile KerberosUser kerberosUser

Constructor Detail

AbstractDBCPConnectionPool

public AbstractDBCPConnectionPool()

Method Detail

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

verify

public List<ConfigVerificationResult> verify(ConfigurationContext context,
                                             ComponentLog verificationLogger,
                                             Map<String,String> variables)

Specified by:

verify in interface VerifiableControllerService

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

configureDataSource

private void configureDataSource(org.apache.commons.dbcp2.BasicDataSource dataSource,
                                 KerberosUser kerberosUser,
                                 ConfigurationContext context)
                          throws InitializationException

Throws:

InitializationException

getKerberosUser

private KerberosUser getKerberosUser(ConfigurationContext context)

getUrl

protected String getUrl(ConfigurationContext context)

getDriver

protected Driver getDriver(String driverName,
                           String url)

getConnectionProperties

protected Map<String,String> getConnectionProperties(ConfigurationContext context)

Override in subclasses to provide connection properties to the data source

Returns:

Key-value pairs that will be added as connection properties

extractMillisWithInfinite

protected Long extractMillisWithInfinite(PropertyValue prop)

shutdown

@OnDisabled
public void shutdown()
                          throws SQLException

Shutdown pool, close all open connections. If a principal is authenticated with a KDC, that principal is logged out. If a @LoginException occurs while attempting to log out the @KerberosUser, an attempt will still be made to shut down the pool and close open connections.

Throws:

SQLException - if there is an error while closing open connections

LoginException - if there is an error during the principal log out, and will only be thrown if there was no exception while closing open connections

shutdown

private void shutdown(org.apache.commons.dbcp2.BasicDataSource dataSource,
                      KerberosUser kerberosUser)
               throws SQLException

Throws:

SQLException

getConnection

public Connection getConnection()
                         throws ProcessException

Specified by:

getConnection in interface DBCPService

Throws:

ProcessException

getConnection

private Connection getConnection(org.apache.commons.dbcp2.BasicDataSource dataSource,
                                 KerberosUser kerberosUser)

toString

public String toString()

Overrides:

toString in class AbstractConfigurableComponent