Package io.helidon.service.configuration.hikaricp

Class HikariCPServiceConfiguration

java.lang.Object

io.helidon.service.configuration.api.ServiceConfiguration

io.helidon.service.configuration.hikaricp.HikariCPServiceConfiguration

Direct Known Subclasses:

HikariCPServiceConfigurationLocalhost

public class HikariCPServiceConfiguration
extends ServiceConfiguration

An abstract ServiceConfiguration implementation that provides configuration information for Hikari connection pool componentry.

Author:

Laird Nelson

See Also:

HikariCPServiceConfiguration(Properties, System, Properties), HikariCPServiceConfigurationProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	coordinates A Properties instance representing the meta-properties in effect at the time this HikariCPServiceConfiguration was constructed.
protected Properties	properties A Properties instance supplied at construction time containing the property values that will ultimately be returned by the default implementation of the getPropertyNames() and getProperty(String, String) methods.
protected System	system The System that was determined to be the authoritative System at the time this HikariCPServiceConfiguration was constructed.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HikariCPServiceConfiguration(Properties properties, System system, Properties coordinates) Creates a new HikariCPServiceConfiguration.

Method Summary

Modifier and Type	Method and Description
String	getProperty(String propertyName, String defaultValue) Returns a value for the property described by the supplied propertyName, or the value of the supplied defaultValue parameter if no such property value exists.
Set<String>	getPropertyNames() Returns an unmodifiable and unchanging Set of Strings representing the names of properties whose values may be retrieved with the getProperty(String, String) method.

Methods inherited from class io.helidon.service.configuration.api.ServiceConfiguration

getInstance, getInstance, getProperty, getServiceIdentifier

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected final Properties properties

A Properties instance supplied at construction time containing the property values that will ultimately be returned by the default implementation of the getPropertyNames() and getProperty(String, String) methods.

This field is never null.

See Also:

HikariCPServiceConfiguration(Properties, System, Properties)

system

protected final System system

The System that was determined to be the authoritative System at the time this HikariCPServiceConfiguration was constructed.

This field may be null.

See Also:

HikariCPServiceConfiguration(Properties, System, Properties), ServiceConfigurationProvider.buildFor(Set, Properties)

coordinates

protected final Properties coordinates

A Properties instance representing the meta-properties in effect at the time this HikariCPServiceConfiguration was constructed.

This field may be null.

See Also:

HikariCPServiceConfiguration(Properties, System, Properties), ServiceConfigurationProvider.buildFor(Set, Properties)

Constructor Detail

HikariCPServiceConfiguration

protected HikariCPServiceConfiguration(Properties properties,
                                       System system,
                                       Properties coordinates)

Creates a new HikariCPServiceConfiguration.

Parameters:

properties - a Properties instance containing the property values that will ultimately be returned by the default implementation of the getPropertyNames() and getProperty(String, String) methods; may be null

system - the System that was determined to be the authoritative System; may be null

coordinates - a Properties instance representing the meta-properties in effect; may be null

See Also:

ServiceConfigurationProvider.buildFor(Set, Properties), ServiceConfigurationProvider.getAuthoritativeSystem(Set, Properties)

Method Detail

getPropertyNames

public Set<String> getPropertyNames()

Returns an unmodifiable and unchanging Set of Strings representing the names of properties whose values may be retrieved with the getProperty(String, String) method.

This method never returns null.

Overrides of this method must not return null.

Overrides of this method must ensure that the Set returned may be used without the end user having to peform explicit synchronization.

This method and its overrides, if any, may return the same Set instance with each invocation, or different Set instances with different contents.

Specified by:

getPropertyNames in class ServiceConfiguration

Returns:

an unmodifiable and unchanging Set of Strings representing the names of properties whose values may be retrieved with the getProperty(String, String) method

See Also:

getProperty(String, String)

getProperty

public String getProperty(String propertyName,
                          String defaultValue)

Returns a value for the property described by the supplied propertyName, or the value of the supplied defaultValue parameter if no such property value exists.

This method will return null if defaultValue is null.

Overrides of this method may return null if defaultValue is null.

This method and its overrides, if any, may return the same or different values for each invocation with the same parameters.

Specified by:

getProperty in class ServiceConfiguration

Parameters:

propertyName - the name of the property whose value should be returned; may be null in which case the value of the supplied defaultValue parameter will be returned instead

defaultValue - the value to return if a value for the named property could not be found; may be null

Returns:

a value for the property described by the supplied propertyName, or the value of the supplied defaultValue parameter

See Also:

getPropertyNames()