Package io.agroal.api.configuration.supplier

Class AgroalPropertiesReader

java.lang.Object

io.agroal.api.configuration.supplier.AgroalPropertiesReader

All Implemented Interfaces:

Supplier<AgroalDataSourceConfiguration>

public class AgroalPropertiesReader
extends Object
implements Supplier<AgroalDataSourceConfiguration>

Convenient way to build an Agroal configuration. This class can build a configuration from a *.properties file or a Properties object. This class defines keys for all the options and also allows for a prefix when looking for that properties.

Author:

Luis Barreiro

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACQUISITION_TIMEOUT
static String	ACQUISITION_TIMEOUT_M
static String	ACQUISITION_TIMEOUT_MS
static String	ACQUISITION_TIMEOUT_S
static String	AUTO_COMMIT
static String	CREDENTIAL
static String	ENHANCED_LEAK_REPORT
static String	FLUSH_ON_CLOSE
static String	IMPLEMENTATION
static String	INITIAL_SIZE
static String	INITIAL_SQL
static String	JDBC_PROPERTIES
static String	JDBC_URL
static String	LEAK_TIMEOUT
static String	LEAK_TIMEOUT_M
static String	LEAK_TIMEOUT_MS
static String	LEAK_TIMEOUT_S
static String	LOGIN_TIMEOUT
static String	MAX_LIFETIME
static String	MAX_LIFETIME_M
static String	MAX_LIFETIME_MS
static String	MAX_LIFETIME_S
static String	MAX_SIZE
static String	METRICS_ENABLED
static String	MIN_SIZE
static String	MULTIPLE_ACQUISITION
static String	PRINCIPAL
static String	PROVIDER_CLASS_NAME
static String	REAP_TIMEOUT
static String	REAP_TIMEOUT_M
static String	REAP_TIMEOUT_MS
static String	REAP_TIMEOUT_S
static String	RECOVERY_CREDENTIAL
static String	RECOVERY_PRINCIPAL
static String	TRACK_JDBC_RESOURCES
static String	TRANSACTION_ISOLATION
static String	TRANSACTION_REQUIREMENT
static String	VALIDATION_TIMEOUT
static String	VALIDATION_TIMEOUT_M
static String	VALIDATION_TIMEOUT_MS
static String	VALIDATION_TIMEOUT_S

Constructor Summary

Constructors

Constructor	Description
AgroalPropertiesReader()
AgroalPropertiesReader(String readerPrefix)

Method Summary

Modifier and Type	Method	Description
AgroalDataSourceConfiguration	get()
AgroalDataSourceConfigurationSupplier	modify()
AgroalPropertiesReader	readProperties(File file)
AgroalPropertiesReader	readProperties(String filename)
AgroalPropertiesReader	readProperties(Path path)
AgroalPropertiesReader	readProperties(Map<String,String> properties)
AgroalPropertiesReader	readProperties(Properties properties)

Methods inherited from class java.lang.Object

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

Field Detail

IMPLEMENTATION

public static final String IMPLEMENTATION

See Also:

Constant Field Values

METRICS_ENABLED

public static final String METRICS_ENABLED

See Also:

Constant Field Values

MIN_SIZE

public static final String MIN_SIZE

See Also:

Constant Field Values

MAX_SIZE

public static final String MAX_SIZE

See Also:

Constant Field Values

INITIAL_SIZE

public static final String INITIAL_SIZE

See Also:

Constant Field Values

FLUSH_ON_CLOSE

public static final String FLUSH_ON_CLOSE

See Also:

Constant Field Values

ENHANCED_LEAK_REPORT

public static final String ENHANCED_LEAK_REPORT

See Also:

Constant Field Values

MULTIPLE_ACQUISITION

public static final String MULTIPLE_ACQUISITION

See Also:

Constant Field Values

TRANSACTION_REQUIREMENT

public static final String TRANSACTION_REQUIREMENT

See Also:

Constant Field Values

ACQUISITION_TIMEOUT

public static final String ACQUISITION_TIMEOUT

See Also:

Constant Field Values

ACQUISITION_TIMEOUT_MS

public static final String ACQUISITION_TIMEOUT_MS

See Also:

Constant Field Values

ACQUISITION_TIMEOUT_S

public static final String ACQUISITION_TIMEOUT_S

See Also:

Constant Field Values

ACQUISITION_TIMEOUT_M

public static final String ACQUISITION_TIMEOUT_M

See Also:

Constant Field Values

VALIDATION_TIMEOUT

public static final String VALIDATION_TIMEOUT

See Also:

Constant Field Values

VALIDATION_TIMEOUT_MS

public static final String VALIDATION_TIMEOUT_MS

See Also:

Constant Field Values

VALIDATION_TIMEOUT_S

public static final String VALIDATION_TIMEOUT_S

See Also:

Constant Field Values

VALIDATION_TIMEOUT_M

public static final String VALIDATION_TIMEOUT_M

See Also:

Constant Field Values

LEAK_TIMEOUT

public static final String LEAK_TIMEOUT

See Also:

Constant Field Values

LEAK_TIMEOUT_MS

public static final String LEAK_TIMEOUT_MS

See Also:

Constant Field Values

LEAK_TIMEOUT_S

public static final String LEAK_TIMEOUT_S

See Also:

Constant Field Values

LEAK_TIMEOUT_M

public static final String LEAK_TIMEOUT_M

See Also:

Constant Field Values

REAP_TIMEOUT

public static final String REAP_TIMEOUT

See Also:

Constant Field Values

REAP_TIMEOUT_MS

public static final String REAP_TIMEOUT_MS

See Also:

Constant Field Values

REAP_TIMEOUT_S

public static final String REAP_TIMEOUT_S

See Also:

Constant Field Values

REAP_TIMEOUT_M

public static final String REAP_TIMEOUT_M

See Also:

Constant Field Values

MAX_LIFETIME

public static final String MAX_LIFETIME

See Also:

Constant Field Values

MAX_LIFETIME_MS

public static final String MAX_LIFETIME_MS

See Also:

Constant Field Values

MAX_LIFETIME_S

public static final String MAX_LIFETIME_S

See Also:

Constant Field Values

MAX_LIFETIME_M

public static final String MAX_LIFETIME_M

See Also:

Constant Field Values

JDBC_URL

public static final String JDBC_URL

See Also:

Constant Field Values

AUTO_COMMIT

public static final String AUTO_COMMIT

See Also:

Constant Field Values

TRACK_JDBC_RESOURCES

public static final String TRACK_JDBC_RESOURCES

See Also:

Constant Field Values

LOGIN_TIMEOUT

public static final String LOGIN_TIMEOUT

See Also:

Constant Field Values

INITIAL_SQL

public static final String INITIAL_SQL

See Also:

Constant Field Values

PROVIDER_CLASS_NAME

public static final String PROVIDER_CLASS_NAME

See Also:

Constant Field Values

TRANSACTION_ISOLATION

public static final String TRANSACTION_ISOLATION

See Also:

Constant Field Values

PRINCIPAL

public static final String PRINCIPAL

See Also:

Constant Field Values

CREDENTIAL

public static final String CREDENTIAL

See Also:

Constant Field Values

RECOVERY_PRINCIPAL

public static final String RECOVERY_PRINCIPAL

See Also:

Constant Field Values

RECOVERY_CREDENTIAL

public static final String RECOVERY_CREDENTIAL

See Also:

Constant Field Values

JDBC_PROPERTIES

public static final String JDBC_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

AgroalPropertiesReader

public AgroalPropertiesReader()

AgroalPropertiesReader

public AgroalPropertiesReader(String readerPrefix)

Method Detail

get

public AgroalDataSourceConfiguration get()

Specified by:

get in interface Supplier<AgroalDataSourceConfiguration>

modify

public AgroalDataSourceConfigurationSupplier modify()

readProperties

public AgroalPropertiesReader readProperties(Path path)
                                      throws IOException

Throws:

IOException

readProperties

public AgroalPropertiesReader readProperties(String filename)
                                      throws IOException

Throws:

IOException

readProperties

public AgroalPropertiesReader readProperties(File file)
                                      throws IOException

Throws:

IOException

readProperties

public AgroalPropertiesReader readProperties(Properties properties)

readProperties

public AgroalPropertiesReader readProperties(Map<String,String> properties)