Package org.apache.nifi.dbcp

Class HikariCPConnectionPool

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.dbcp.HikariCPConnectionPool

All Implemented Interfaces:

ConfigurableComponent, ControllerService, DBCPService

@RequiresInstanceClassLoading
@Tags({"dbcp","hikari","jdbc","database","connection","pooling","store"})
@CapabilityDescription("Provides Database Connection Pooling Service based on HikariCP. Connections can be asked from pool and returned after usage.")
@SupportsSensitiveDynamicProperties
@DynamicProperty(name="JDBC property name",
                 value="JDBC property value",
                 expressionLanguageScope=ENVIRONMENT,
                 description="Specifies a property name and value to be set on the JDBC connection(s). If Expression Language is used, evaluation will be performed upon the controller service being enabled. Note that no flow file input (attributes, e.g.) is available for use in Expression Language constructs for these properties.")
@Restricted(restrictions=@Restriction(requiredPermission=REFERENCE_REMOTE_RESOURCES,explanation="Database Driver Location can reference resources over HTTP"))
public class HikariCPConnectionPool
extends AbstractControllerService
implements DBCPService

Implementation of Database Connection Pooling Service. HikariCP is used for connection pooling functionality.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyDescriptor	DATABASE_URL
private com.zaxxer.hikari.HikariDataSource	dataSource
static final PropertyDescriptor	DB_DRIVER_LOCATION
static final PropertyDescriptor	DB_DRIVERNAME
static final PropertyDescriptor	DB_PASSWORD
static final PropertyDescriptor	DB_USER
private static final String	DEFAULT_MAX_CONN_LIFETIME
private static final String	DEFAULT_TOTAL_CONNECTIONS
protected static final long	INFINITE_MILLISECONDS
static final PropertyDescriptor	KERBEROS_USER_SERVICE
private KerberosUser	kerberosUser
static final PropertyDescriptor	MAX_CONN_LIFETIME
static final PropertyDescriptor	MAX_TOTAL_CONNECTIONS
static final PropertyDescriptor	MAX_WAIT_TIME
static final PropertyDescriptor	MIN_IDLE
private static final List<PropertyDescriptor>	properties
protected static final String	SENSITIVE_PROPERTY_PREFIX	Property Name Prefix for Sensitive Dynamic Properties
static final PropertyDescriptor	VALIDATION_QUERY

Constructor Summary

Constructors

Constructor	Description
HikariCPConnectionPool()

Method Summary

Modifier and Type	Method	Description
private long	extractMillisWithInfinite(PropertyValue prop)
Connection	getConnection()
(package private) com.zaxxer.hikari.HikariDataSource	getDataSource()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onConfigured(ConfigurationContext context)	Configures connection pool by creating an instance of the HikariDataSource based on configuration provided with ConfigurationContext.
void	shutdown()	Shutdown pool, close all open connections.
String	toString()

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, 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.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

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

initialize, isStateful, migrateProperties

Methods inherited from interface org.apache.nifi.dbcp.DBCPService

getConnection, getFlowFileFilter, getFlowFileFilter

Field Details

SENSITIVE_PROPERTY_PREFIX

protected static final String SENSITIVE_PROPERTY_PREFIX

Property Name Prefix for Sensitive Dynamic Properties

See Also:

• Constant Field Values

INFINITE_MILLISECONDS

protected static final long INFINITE_MILLISECONDS

See Also:

• Constant Field Values

DEFAULT_TOTAL_CONNECTIONS

private static final String DEFAULT_TOTAL_CONNECTIONS

See Also:

• Constant Field Values

DEFAULT_MAX_CONN_LIFETIME

private static final String DEFAULT_MAX_CONN_LIFETIME

See Also:

• Constant Field Values

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_CONN_LIFETIME

public static final PropertyDescriptor MAX_CONN_LIFETIME

KERBEROS_USER_SERVICE

public static final PropertyDescriptor KERBEROS_USER_SERVICE

properties

private static final List<PropertyDescriptor> properties

dataSource

private volatile com.zaxxer.hikari.HikariDataSource dataSource

kerberosUser

private volatile KerberosUser kerberosUser

Constructor Details

HikariCPConnectionPool

public HikariCPConnectionPool()

Method Details

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

onConfigured

@OnEnabled
public void onConfigured(ConfigurationContext context)

Configures connection pool by creating an instance of the HikariDataSource 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

extractMillisWithInfinite

private long extractMillisWithInfinite(PropertyValue prop)

shutdown

@OnDisabled
public void shutdown()

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.

getConnection

public Connection getConnection()
                         throws ProcessException

Specified by:

getConnection in interface DBCPService

Throws:

ProcessException

toString

public String toString()

Overrides:

toString in class AbstractConfigurableComponent

getDataSource

com.zaxxer.hikari.HikariDataSource getDataSource()