Server-side Sessions - JDBC

If you don’t wish to use the native container’s strategy for session replication, you can use CAS’s support for JDBC session replication.

This feature is enabled via the following module:

1
2
3
4
5
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-session-jdbc</artifactId>
    <version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-session-jdbc:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-session-jdbc"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
    /*
        The following platform references should be included automatically and are listed here for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-session-jdbc"
}

The following settings and properties are available from the CAS configuration catalog:

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.

The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.

  • spring.datasource.azure.credential.client-certificate-password=
  • Password of the certificate file.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.azure.credential.client-certificate-path=
  • Path of a PEM certificate file to use when performing service principal authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.azure.credential.client-id=
  • Client ID to use when performing service principal authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.azure.credential.client-secret=
  • Client secret to use when performing service principal authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.azure.credential.managed-identity-enabled=false
  • Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client ID as user assigned managed identity client ID.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.azure.credential.password=
  • Password to use when performing username/password authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.azure.credential.username=
  • Username to use when performing username/password authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.azure.passwordless-enabled=false
  • Whether to enable passwordless connections to Azure databases by using OAuth2 Microsoft Entra token credentials.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.azure.profile.cloud-type=
  • Name of the Azure cloud to connect to. Supported types are: AZURE, AZURE_CHINA, AZURE_US_GOVERNMENT, OTHER. The default value is `AZURE`.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.azure.profile.environment.active-directory-endpoint=
  • The Microsoft Entra endpoint to connect to.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.azure.profile.tenant-id=
  • Tenant ID for Azure resources. The values allowed for 'tenant-id' are: 'common', 'organizations', 'consumers', or the tenant ID.

    com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.connection-fetch=eager
  • Whether the auto-configured DataSource should be wrapped in a proxy that fetches JDBC connections as late as possible.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.continue-on-error=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.continue-on-error.

  • spring.datasource.data=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.data-locations.

  • spring.datasource.data-password=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.password.

  • spring.datasource.data-username=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.username.

  • spring.datasource.dbcp2.abandoned-usage-tracking=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.access-to-underlying-connection-allowed=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.auto-commit-on-return=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.cache-state=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.clear-statement-pool-on-return=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.connection-factory-class-name=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.connection-init-sqls=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.default-auto-commit=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.default-catalog=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.default-query-timeout=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

    Deprecation status is WARNINGwithout a replacement setting.

  • spring.datasource.dbcp2.default-read-only=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.default-schema=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.default-transaction-isolation=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.disconnection-ignore-sql-codes=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.disconnection-sql-codes=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.driver-class-name=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.duration-between-eviction-runs=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.enable-auto-commit-on-return=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

    Deprecation status is WARNINGwithout a replacement setting.

  • spring.datasource.dbcp2.eviction-policy-class-name=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.fast-fail-validation=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.initial-size=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.jmx-name=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.lifo=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.log-abandoned=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.log-expired-connections=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.login-timeout=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.max-conn-lifetime-millis=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

    Deprecation status is WARNINGwithout a replacement setting.

  • spring.datasource.dbcp2.max-idle=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.max-open-prepared-statements=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.max-total=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.max-wait-millis=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

    Deprecation status is WARNINGwithout a replacement setting.

  • spring.datasource.dbcp2.min-evictable-idle-time-millis=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

    Deprecation status is WARNINGwithout a replacement setting.

  • spring.datasource.dbcp2.min-idle=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.num-tests-per-eviction-run=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.password=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.pool-prepared-statements=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.remove-abandoned-on-borrow=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.remove-abandoned-on-maintenance=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.remove-abandoned-timeout=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

    Deprecation status is WARNINGwithout a replacement setting.

  • spring.datasource.dbcp2.rollback-on-return=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.soft-min-evictable-idle-time-millis=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

    Deprecation status is WARNINGwithout a replacement setting.

  • spring.datasource.dbcp2.test-on-borrow=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.test-on-create=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.test-on-return=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.test-while-idle=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.time-between-eviction-runs-millis=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

    Deprecation status is WARNINGwithout a replacement setting.

  • spring.datasource.dbcp2.url=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.username=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.validation-query=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.dbcp2.validation-query-timeout=
  • org.apache.commons.dbcp2.BasicDataSource.

    Copy Configuration Property How can I configure this property?

    Deprecation status is WARNINGwithout a replacement setting.

  • spring.datasource.driver-class-name=
  • Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.embedded-database-connection=
  • Connection details for an embedded database. Defaults to the most suitable embedded database that is available on the classpath.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.generate-unique-name=true
  • Whether to generate a random datasource name.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.allow-pool-suspension=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.auto-commit=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.catalog=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.connection-init-sql=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.connection-test-query=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.connection-timeout=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.credentials-provider-class-name=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.data-source-class-name=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.data-source-j-n-d-i=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.data-source-properties=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.driver-class-name=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.exception-override-class-name=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.health-check-properties=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.idle-timeout=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.initialization-fail-timeout=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.isolate-internal-queries=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.jdbc-url=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.keepalive-time=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.leak-detection-threshold=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.login-timeout=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.max-lifetime=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.maximum-pool-size=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.minimum-idle=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.password=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.pool-name=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.read-only=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.register-mbeans=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.schema=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.transaction-isolation=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.username=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.hikari.validation-timeout=
  • com.zaxxer.hikari.HikariDataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.initialization-mode=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.mode.

  • spring.datasource.jmx-enabled=false
  • Whether to enable JMX support (if provided by the underlying pool).

    Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.datasource.tomcat.jmx-enabled.

  • spring.datasource.jndi-name=
  • JNDI location of the datasource. Class, url, username and password are ignored when set.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.name=
  • Datasource name to use if "generate-unique-name" is false. Defaults to "testdb" when using an embedded database, otherwise null.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.abandoned-connection-timeout=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.commit-on-connection-return=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-affinity-callback=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-creation-consumer=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-factory-class-name=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-factory-properties=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-harvest-max-count=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-harvest-trigger-count=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-initialization-callback=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-labeling-callback=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-labeling-high-cost=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-pool-name=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-properties=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-repurpose-threshold=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-validation-timeout=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-wait-duration=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.connection-wait-timeout=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

    Deprecation status is WARNINGwithout a replacement setting.

  • spring.datasource.oracleucp.connection-wait-timeout-while-service-down=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.create-connection-in-borrow-thread=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.data-source-name=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.database-name=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.description=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.fast-connection-failover-enabled=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.high-cost-connection-reuse-threshold=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.inactive-connection-timeout=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.initial-pool-size=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.login-timeout=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.max-connection-reuse-count=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.max-connection-reuse-time=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.max-connections-per-shard=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.max-idle-time=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.max-pool-size=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.max-statements=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.min-idle=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.min-pool-size=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.network-protocol=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.o-n-s-configuration=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.password=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.pdb-roles=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.port-number=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.property-cycle=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.query-timeout=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.read-only-instance-allowed=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.s-q-l-for-validate-connection=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.seconds-to-trust-idle-connection=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.server-name=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.sharding-mode=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.time-to-live-connection-timeout=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.timeout-check-interval=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.u-r-l=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.user=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.oracleucp.validate-connection-on-borrow=
  • oracle.ucp.jdbc.PoolDataSourceImpl.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.password=
  • Login password of the database.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.platform=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.platform.

  • spring.datasource.schema=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.schema-locations.

  • spring.datasource.schema-password=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.password.

  • spring.datasource.schema-username=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.username.

  • spring.datasource.separator=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.separator.

  • spring.datasource.sql-script-encoding=
  • Copy Configuration Property How can I configure this property?

    Deprecation status is ERRORwith a replacement setting: spring.sql.init.encoding.

  • spring.datasource.tomcat.abandon-when-percentage-full=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.access-to-underlying-connection-allowed=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.alternate-username-allowed=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.commit-on-return=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.connection-properties=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.data-source-j-n-d-i=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.db-properties=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.default-auto-commit=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.default-catalog=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.default-read-only=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.default-transaction-isolation=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.driver-class-name=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.fair-queue=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.ignore-exception-on-pre-load=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.init-s-q-l=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.initial-size=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.jdbc-interceptors=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.jmx-enabled=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.log-abandoned=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.log-validation-errors=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.login-timeout=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.max-active=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.max-age=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.max-idle=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.max-wait=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.min-evictable-idle-time-millis=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.min-idle=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.name=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.num-tests-per-eviction-run=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.password=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.propagate-interrupt-state=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.remove-abandoned=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.remove-abandoned-timeout=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.rollback-on-return=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.suspect-timeout=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.test-on-borrow=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.test-on-connect=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.test-on-return=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.test-while-idle=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.time-between-eviction-runs-millis=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.url=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.use-disposable-connection-facade=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.use-equals=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.use-lock=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.use-statement-facade=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.username=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.validation-interval=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.validation-query=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.validation-query-timeout=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.tomcat.validator-class-name=
  • org.apache.tomcat.jdbc.pool.DataSource.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.type=
  • Fully qualified name of the DataSource implementation to use. By default, a connection pool implementation is auto-detected from the classpath.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.url=
  • JDBC URL of the database.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.username=
  • Login username of the database.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.xa.data-source-class-name=
  • XA datasource fully qualified name.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties$Xa.

    Copy Configuration Property How can I configure this property?

  • spring.datasource.xa.properties=
  • Properties to pass to the XA data source.

    org.springframework.boot.jdbc.autoconfigure.DataSourceProperties$Xa.

    Copy Configuration Property How can I configure this property?

  • spring.session.jdbc.cleanup-cron=0 * * * * *
  • Cron expression for expired session cleanup job.

    org.springframework.boot.session.jdbc.autoconfigure.JdbcSessionProperties.

    Copy Configuration Property How can I configure this property?

  • spring.session.jdbc.continue-on-error=true
  • Whether initialization should continue when an error occurs when applying a schema script.

    org.springframework.boot.session.jdbc.autoconfigure.JdbcSessionProperties.

    Copy Configuration Property How can I configure this property?

  • spring.session.jdbc.flush-mode=on-save
  • Sessions flush mode. Determines when session changes are written to the session store.

    org.springframework.boot.session.jdbc.autoconfigure.JdbcSessionProperties.

    Copy Configuration Property How can I configure this property?

  • spring.session.jdbc.initialize-schema=embedded
  • Database schema initialization mode.

    org.springframework.boot.session.jdbc.autoconfigure.JdbcSessionProperties.

    Copy Configuration Property How can I configure this property?

  • spring.session.jdbc.platform=
  • Platform to use in initialization scripts if the @@platform@@ placeholder is used. Auto-detected by default.

    org.springframework.boot.session.jdbc.autoconfigure.JdbcSessionProperties.

    Copy Configuration Property How can I configure this property?

  • spring.session.jdbc.save-mode=on-set-attribute
  • Sessions save mode. Determines how session changes are tracked and saved to the session store.

    org.springframework.boot.session.jdbc.autoconfigure.JdbcSessionProperties.

    Copy Configuration Property How can I configure this property?

  • spring.session.jdbc.schema=
  • Path to the SQL file to use to initialize the database schema.

    org.springframework.boot.session.jdbc.autoconfigure.JdbcSessionProperties.

    Copy Configuration Property How can I configure this property?

  • spring.session.jdbc.table-name=SPRING_SESSION
  • Name of the database table used to store sessions.

    org.springframework.boot.session.jdbc.autoconfigure.JdbcSessionProperties.

    Copy Configuration Property How can I configure this property?

    Configuration Metadata

    The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

    Be Selective

    This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

    YAGNI

    Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

    Naming Convention

    Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

    :information_source: Note

    When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

    Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

    Validation

    Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

    Indexed Settings

    CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.