Class DatasourceConfiguration

java.lang.Object

io.micronaut.configuration.jdbc.unpooled.DatasourceConfiguration

All Implemented Interfaces:

BasicJdbcConfiguration

@EachProperty(value="datasources",
              primary="default")
public class DatasourceConfiguration
extends Object
implements BasicJdbcConfiguration

Allows configuration of an unpooled JDBC datasource backed by DriverManager.

Since:

7.0.0

Author:

Micronaut

Field Summary

Fields inherited from interface BasicJdbcConfiguration

PREFIX

Constructor Summary

Constructors

Constructor	Description
DatasourceConfiguration(String name)	Constructor.

Method Summary

Modifier and Type	Method	Description
@Nullable String	getConfiguredDriverClassName()
@Nullable String	getConfiguredPassword()
@Nullable String	getConfiguredUrl()
@Nullable String	getConfiguredUsername()
@Nullable String	getConfiguredValidationQuery()
Map<String,String>	getDataSourceProperties()
@Nullable Class<? extends Driver>	getDriverClass()
String	getDriverClassName()
@Nullable Integer	getLoginTimeout()
String	getName()
@Nullable String	getPassword()
String	getUrl()
@Nullable String	getUsername()
@Nullable String	getValidationQuery()
void	setDataSourceProperties(Map<String,?> dsProperties)	Sets the datasource properties.
void	setDriverClass(@Nullable Class<? extends Driver> driverClass)
void	setDriverClassName(String driverClassName)
void	setLoginTimeout(@Nullable Integer loginTimeout)
void	setPassword(@Nullable String password)
void	setUrl(String url)
void	setUsername(@Nullable String username)
void	setValidationQuery(@Nullable String validationQuery)

Methods inherited from class Object

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

Constructor Details

DatasourceConfiguration

public DatasourceConfiguration(@Parameter
 String name)

Constructor.

Parameters:

name - The datasource name

Method Details

getName

public String getName()

Specified by:

getName in interface BasicJdbcConfiguration

Returns:

A user provided name to identify the datasource

getConfiguredUrl

public @Nullable String getConfiguredUrl()

Specified by:

getConfiguredUrl in interface BasicJdbcConfiguration

Returns:

The URL supplied via configuration

getUrl

public String getUrl()

Specified by:

getUrl in interface BasicJdbcConfiguration

Returns:

The URL to be used by the data source

setUrl

public void setUrl(String url)

Specified by:

setUrl in interface BasicJdbcConfiguration

Parameters:

url - Sets the url

getConfiguredDriverClassName

public @Nullable String getConfiguredDriverClassName()

Specified by:

getConfiguredDriverClassName in interface BasicJdbcConfiguration

Returns:

The driver class name supplied via configuration

getDriverClassName

public String getDriverClassName()

Specified by:

getDriverClassName in interface BasicJdbcConfiguration

Returns:

The driver class name to be used by the data source

setDriverClassName

public void setDriverClassName(String driverClassName)

Specified by:

setDriverClassName in interface BasicJdbcConfiguration

Parameters:

driverClassName - Sets the driver class name

getDriverClass

public @Nullable Class<? extends Driver> getDriverClass()

Returns:

The configured driver class

setDriverClass

public void setDriverClass(@Nullable Class<? extends Driver> driverClass)

Parameters:

driverClass - The configured driver class

getConfiguredUsername

public @Nullable String getConfiguredUsername()

Specified by:

getConfiguredUsername in interface BasicJdbcConfiguration

Returns:

The username supplied via configuration

getUsername

public @Nullable String getUsername()

Specified by:

getUsername in interface BasicJdbcConfiguration

Returns:

The username to be used by the data source

setUsername

public void setUsername(@Nullable String username)

Specified by:

setUsername in interface BasicJdbcConfiguration

Parameters:

username - Sets the username

getConfiguredPassword

public @Nullable String getConfiguredPassword()

Specified by:

getConfiguredPassword in interface BasicJdbcConfiguration

Returns:

The password supplied via configuration

getPassword

public @Nullable String getPassword()

Specified by:

getPassword in interface BasicJdbcConfiguration

Returns:

The password to be used by the data source

setPassword

public void setPassword(@Nullable String password)

Specified by:

setPassword in interface BasicJdbcConfiguration

Parameters:

password - Sets the password

getConfiguredValidationQuery

public @Nullable String getConfiguredValidationQuery()

Specified by:

getConfiguredValidationQuery in interface BasicJdbcConfiguration

Returns:

The validation query supplied via configuration

getValidationQuery

public @Nullable String getValidationQuery()

Specified by:

getValidationQuery in interface BasicJdbcConfiguration

Returns:

The validation query to be used by the data source

setValidationQuery

public void setValidationQuery(@Nullable String validationQuery)

Parameters:

validationQuery - The configured validation query

getLoginTimeout

public @Nullable Integer getLoginTimeout()

Returns:

The configured login timeout in seconds

setLoginTimeout

public void setLoginTimeout(@Nullable Integer loginTimeout)

Parameters:

loginTimeout - The login timeout in seconds

getDataSourceProperties

public Map<String,String> getDataSourceProperties()

Returns:

Additional datasource properties passed to the JDBC driver

setDataSourceProperties

public void setDataSourceProperties(@MapFormat(transformation=FLAT,keyFormat=RAW)
 Map<String,?> dsProperties)

Description copied from interface: BasicJdbcConfiguration

Sets the datasource properties.

Specified by:

setDataSourceProperties in interface BasicJdbcConfiguration

Parameters:

dsProperties - The properties