DataSourceProperties (Spring Boot Docs 2.0.0.RC1 API)

java.lang.Object
- org.springframework.boot.autoconfigure.jdbc.DataSourceProperties

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware
```
@ConfigurationProperties(prefix="spring.datasource")
public class DataSourceProperties
extends Object
implements org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.context.EnvironmentAware, org.springframework.beans.factory.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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataSourceProperties.Xa
XA Specific datasource settings.

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

Constructor Summary

Constructors
Constructor and Description

DataSourceProperties()

Constructors
Constructor and Description
`DataSourceProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
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()`
`String`	`getDataPassword()`
`String`	`getDataUsername()`
`String`	`getDriverClassName()` Return the configured driver or `null` if none was configured.
`DataSourceInitializationMode`	`getInitializationMode()`
`String`	`getJndiName()`
`String`	`getName()`
`String`	`getPassword()` Return the configured password or `null` if none was configured.
`String`	`getPlatform()`
`List<String>`	`getSchema()`
`String`	`getSchemaPassword()`
`String`	`getSchemaUsername()`
`String`	`getSeparator()`
`Charset`	`getSqlScriptEncoding()`
`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()`
`boolean`	`isGenerateUniqueName()`
`void`	`setBeanClassLoader(ClassLoader classLoader)`
`void`	`setContinueOnError(boolean continueOnError)`
`void`	`setData(List<String> data)`
`void`	`setDataPassword(String dataPassword)`
`void`	`setDataUsername(String dataUsername)`
`void`	`setDriverClassName(String driverClassName)`
`void`	`setEnvironment(org.springframework.core.env.Environment environment)`
`void`	`setGenerateUniqueName(boolean generateUniqueName)`
`void`	`setInitializationMode(DataSourceInitializationMode initializationMode)`
`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)`
`void`	`setSchema(List<String> schema)`
`void`	`setSchemaPassword(String schemaPassword)`
`void`	`setSchemaUsername(String schemaUsername)`
`void`	`setSeparator(String separator)`
`void`	`setSqlScriptEncoding(Charset sqlScriptEncoding)`
`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 org.springframework.beans.factory.BeanClassLoaderAware
  - setEnvironment
```
public void setEnvironment(org.springframework.core.env.Environment environment)
```
    Specified by:
    
    setEnvironment in interface org.springframework.context.EnvironmentAware
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.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
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - isGenerateUniqueName
```
public boolean isGenerateUniqueName()
```
  - setGenerateUniqueName
```
public void setGenerateUniqueName(boolean generateUniqueName)
```
  - 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
```
public DataSourceInitializationMode getInitializationMode()
```
  - setInitializationMode
```
public void setInitializationMode(DataSourceInitializationMode initializationMode)
```
  - getPlatform
```
public String getPlatform()
```
  - setPlatform
```
public void setPlatform(String platform)
```
  - getSchema
```
public List<String> getSchema()
```
  - setSchema
```
public void setSchema(List<String> schema)
```
  - getSchemaUsername
```
public String getSchemaUsername()
```
  - setSchemaUsername
```
public void setSchemaUsername(String schemaUsername)
```
  - getSchemaPassword
```
public String getSchemaPassword()
```
  - setSchemaPassword
```
public void setSchemaPassword(String schemaPassword)
```
  - getData
```
public List<String> getData()
```
  - setData
```
public void setData(List<String> data)
```
  - getDataUsername
```
public String getDataUsername()
```
  - setDataUsername
```
public void setDataUsername(String dataUsername)
```
  - getDataPassword
```
public String getDataPassword()
```
  - setDataPassword
```
public void setDataPassword(String dataPassword)
```
  - isContinueOnError
```
public boolean isContinueOnError()
```
  - setContinueOnError
```
public void setContinueOnError(boolean continueOnError)
```
  - getSeparator
```
public String getSeparator()
```
  - setSeparator
```
public void setSeparator(String separator)
```
  - getSqlScriptEncoding
```
public Charset getSqlScriptEncoding()
```
  - setSqlScriptEncoding
```
public void setSqlScriptEncoding(Charset sqlScriptEncoding)
```
  - getClassLoader
```
public ClassLoader getClassLoader()
```
  - getXa
```
public DataSourceProperties.Xa getXa()
```
  - setXa
```
public void setXa(DataSourceProperties.Xa xa)
```

Class DataSourceProperties

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataSourceProperties

Method Detail

setBeanClassLoader

setEnvironment

afterPropertiesSet

initializeDataSourceBuilder

getName

setName

isGenerateUniqueName

setGenerateUniqueName

getType

setType

getDriverClassName

setDriverClassName

determineDriverClassName

getUrl

setUrl

determineUrl

determineDatabaseName

getUsername

setUsername

determineUsername

getPassword

setPassword

determinePassword

getJndiName

setJndiName

getInitializationMode

setInitializationMode

getPlatform

setPlatform

getSchema

setSchema

getSchemaUsername

setSchemaUsername

getSchemaPassword

setSchemaPassword

getData

setData

getDataUsername

setDataUsername

getDataPassword

setDataPassword

isContinueOnError

setContinueOnError

getSeparator

setSeparator

getSqlScriptEncoding

setSqlScriptEncoding

getClassLoader

getXa

setXa