org.springframework.boot.autoconfigure.jdbc

Class DataSourceProperties

java.lang.Object

org.springframework.boot.autoconfigure.jdbc.DataSourceProperties

All Implemented Interfaces:

Aware, BeanClassLoaderAware, InitializingBean

@ConfigurationProperties(prefix="spring.datasource")
public class DataSourceProperties
extends Object
implements BeanClassLoaderAware, InitializingBean

Base class for configuration of a data source.

Since:

1.1.0

Author:

Dave Syer, Maciej Walkowiak, Stephane Nicoll, Benedikt Ritter, Eddú Meléndez, Scott Frederick

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSourceProperties.Xa XA Specific datasource settings.

Constructor Summary

Constructors

Constructor and Description
DataSourceProperties()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
String	determineDatabaseName() Determine the name to used based on this configuration.
String	determineDriverClassName() Determine the driver to use based on this configuration and the environment.
String	determinePassword() Determine the password to use based on this configuration and the environment.
String	determineUrl() Determine the url to use based on this configuration and the environment.
String	determineUsername() Determine the username to use based on this configuration and the environment.
ClassLoader	getClassLoader()
List<String>	getData() Deprecated.
String	getDataPassword() Deprecated.
String	getDataUsername() Deprecated.
String	getDriverClassName() Return the configured driver or null if none was configured.
EmbeddedDatabaseConnection	getEmbeddedDatabaseConnection()
DataSourceInitializationMode	getInitializationMode() Deprecated.
String	getJndiName()
String	getName()
String	getPassword() Return the configured password or null if none was configured.
String	getPlatform() Deprecated.
List<String>	getSchema() Deprecated.
String	getSchemaPassword() Deprecated.
String	getSchemaUsername() Deprecated.
String	getSeparator() Deprecated.
Charset	getSqlScriptEncoding() Deprecated.
Class<? extends DataSource>	getType()
String	getUrl() Return the configured url or null if none was configured.
String	getUsername() Return the configured username or null if none was configured.
DataSourceProperties.Xa	getXa()
DataSourceBuilder<?>	initializeDataSourceBuilder() Initialize a DataSourceBuilder with the state of this instance.
boolean	isContinueOnError() Deprecated.
boolean	isGenerateUniqueName()
void	setBeanClassLoader(ClassLoader classLoader)
void	setContinueOnError(boolean continueOnError) Deprecated.
void	setData(List<String> data) Deprecated.
void	setDataPassword(String dataPassword) Deprecated.
void	setDataUsername(String dataUsername) Deprecated.
void	setDriverClassName(String driverClassName)
void	setEmbeddedDatabaseConnection(EmbeddedDatabaseConnection embeddedDatabaseConnection)
void	setGenerateUniqueName(boolean generateUniqueName)
void	setInitializationMode(DataSourceInitializationMode initializationMode) Deprecated.
void	setJndiName(String jndiName) Allows the DataSource to be managed by the container and obtained via JNDI.
void	setName(String name)
void	setPassword(String password)
void	setPlatform(String platform) Deprecated.
void	setSchema(List<String> schema) Deprecated.
void	setSchemaPassword(String schemaPassword) Deprecated.
void	setSchemaUsername(String schemaUsername) Deprecated.
void	setSeparator(String separator) Deprecated.
void	setSqlScriptEncoding(Charset sqlScriptEncoding) Deprecated.
void	setType(Class<? extends DataSource> type)
void	setUrl(String url)
void	setUsername(String username)
void	setXa(DataSourceProperties.Xa xa)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceProperties

public DataSourceProperties()

Method Detail

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

initializeDataSourceBuilder

public DataSourceBuilder<?> initializeDataSourceBuilder()

Initialize a DataSourceBuilder with the state of this instance.

Returns:

a DataSourceBuilder initialized with the customizations defined on this instance

isGenerateUniqueName

public boolean isGenerateUniqueName()

setGenerateUniqueName

public void setGenerateUniqueName(boolean generateUniqueName)

getName

public String getName()

setName

public void setName(String name)

getType

public Class<? extends DataSource> getType()

setType

public void setType(Class<? extends DataSource> type)

getDriverClassName

public String getDriverClassName()

Return the configured driver or null if none was configured.

Returns:

the configured driver

See Also:

determineDriverClassName()

setDriverClassName

public void setDriverClassName(String driverClassName)

determineDriverClassName

public String determineDriverClassName()

Determine the driver to use based on this configuration and the environment.

Returns:

the driver to use

Since:

1.4.0

getUrl

public String getUrl()

Return the configured url or null if none was configured.

Returns:

the configured url

See Also:

determineUrl()

setUrl

public void setUrl(String url)

determineUrl

public String determineUrl()

Determine the url to use based on this configuration and the environment.

Returns:

the url to use

Since:

1.4.0

determineDatabaseName

public String determineDatabaseName()

Determine the name to used based on this configuration.

Returns:

the database name to use or null

Since:

2.0.0

getUsername

public String getUsername()

Return the configured username or null if none was configured.

Returns:

the configured username

See Also:

determineUsername()

setUsername

public void setUsername(String username)

determineUsername

public String determineUsername()

Determine the username to use based on this configuration and the environment.

Returns:

the username to use

Since:

1.4.0

getPassword

public String getPassword()

Return the configured password or null if none was configured.

Returns:

the configured password

See Also:

determinePassword()

setPassword

public void setPassword(String password)

determinePassword

public String determinePassword()

Determine the password to use based on this configuration and the environment.

Returns:

the password to use

Since:

1.4.0

getJndiName

public String getJndiName()

setJndiName

public void setJndiName(String jndiName)

Allows the DataSource to be managed by the container and obtained via JNDI. The URL, driverClassName, username and password fields will be ignored when using JNDI lookups.

Parameters:

jndiName - the JNDI name

getInitializationMode

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.mode")
public DataSourceInitializationMode getInitializationMode()

Deprecated.

setInitializationMode

@Deprecated
public void setInitializationMode(DataSourceInitializationMode initializationMode)

Deprecated.

getPlatform

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.platform")
public String getPlatform()

Deprecated.

setPlatform

@Deprecated
public void setPlatform(String platform)

Deprecated.

getSchema

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.schema-locations")
public List<String> getSchema()

Deprecated.

setSchema

@Deprecated
public void setSchema(List<String> schema)

Deprecated.

getSchemaUsername

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.username")
public String getSchemaUsername()

Deprecated.

setSchemaUsername

@Deprecated
public void setSchemaUsername(String schemaUsername)

Deprecated.

getSchemaPassword

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.password")
public String getSchemaPassword()

Deprecated.

setSchemaPassword

@Deprecated
public void setSchemaPassword(String schemaPassword)

Deprecated.

getData

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.data-locations")
public List<String> getData()

Deprecated.

setData

@Deprecated
public void setData(List<String> data)

Deprecated.

getDataUsername

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.username")
public String getDataUsername()

Deprecated.

setDataUsername

@Deprecated
public void setDataUsername(String dataUsername)

Deprecated.

getDataPassword

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.password")
public String getDataPassword()

Deprecated.

setDataPassword

@Deprecated
public void setDataPassword(String dataPassword)

Deprecated.

isContinueOnError

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.continue-on-error")
public boolean isContinueOnError()

Deprecated.

setContinueOnError

@Deprecated
public void setContinueOnError(boolean continueOnError)

Deprecated.

getSeparator

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.separator")
public String getSeparator()

Deprecated.

setSeparator

@Deprecated
public void setSeparator(String separator)

Deprecated.

getSqlScriptEncoding

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.sql.init.encoding")
public Charset getSqlScriptEncoding()

Deprecated.

setSqlScriptEncoding

@Deprecated
public void setSqlScriptEncoding(Charset sqlScriptEncoding)

Deprecated.

getEmbeddedDatabaseConnection

public EmbeddedDatabaseConnection getEmbeddedDatabaseConnection()

setEmbeddedDatabaseConnection

public void setEmbeddedDatabaseConnection(EmbeddedDatabaseConnection embeddedDatabaseConnection)

getClassLoader

public ClassLoader getClassLoader()

getXa

public DataSourceProperties.Xa getXa()

setXa

public void setXa(DataSourceProperties.Xa xa)