JDBC Drivers

While in most cases this is unnecessary and handled by CAS automatically, you may need to also include the following module to account for various database drivers:

1
2
3
4
5

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-jdbc-drivers</artifactId>
    <version>${cas.version}</version>
</dependency>

1

implementation "org.apereo.cas:cas-server-support-jdbc-drivers:${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-jdbc-drivers"
}

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-jdbc-drivers"
}

JPA Implementations

The following JPA implementations are provided by CAS. In most cases, the indicated modules do not need to be included in a CAS build and the implementation would be automatically chosen by the feature module. The details below are listed for reference and may be of use in advanced scenarios where development may be required.

Hibernate

Hibernate ORM is an object–relational mapping tool for the Java programming language. It provides a framework for mapping an object-oriented domain model to a relational database.

1
2
3
4
5

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-jpa-hibernate</artifactId>
    <version>${cas.version}</version>
</dependency>

1

implementation "org.apereo.cas:cas-server-support-jpa-hibernate:${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-jpa-hibernate"
}

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-jpa-hibernate"
}

EclipseLink

EclipseLink is the open source Eclipse Persistence Services Project from the Eclipse Foundation. The software provides an extensible framework that allows Java developers to interact with various data services, including databases, web services, Object XML mapping, and enterprise information systems.

1
2
3
4
5

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-jpa-eclipselink</artifactId>
    <version>${cas.version}</version>
</dependency>

1

implementation "org.apereo.cas:cas-server-support-jpa-eclipselink:${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-jpa-eclipselink"
}

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-jpa-eclipselink"
}

Database Support

Automatic support for drivers includes the following databases. All other drivers need to be manually added to the build configuration.

Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.

Show 510152550 entries

Search:

Processing...

cas.jdbc.case-insensitive=false When choosing physical table names, determine whether names should be considered case-insensitive. How can I configure this property? CAS Property: cas.jdbc.case-insensitive Configuration properties can be included and activated using the following strategies. 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. Java Property YAML Property System Property Environment Variable Command-line Argument CAS properties can be specified using the Java configuration property syntax in any and all .properties files: 1 cas.jdbc.case-insensitive=... This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework. CAS properties can be specified using the YAML syntax: cas: jdbc: case-insensitive: "..." Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice. CAS properties can be passed to the CAS web application as system properties, when the application is launched: 1 java -Dcas.jdbc.case-insensitive="..." -jar build/libs/cas.war The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched. CAS properties can specified as system environment variables before the CAS web application is launched: 1 2 3 export CAS_JDBC_CASE_INSENSITIVE="..." java -jar build/libs/cas.war The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched: 1 java -jar build/libs/cas.war --cas.jdbc.case-insensitive="..." The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.
cas.jdbc.gen-ddl=true Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables. How can I configure this property? CAS Property: cas.jdbc.gen-ddl Configuration properties can be included and activated using the following strategies. 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. Java Property YAML Property System Property Environment Variable Command-line Argument CAS properties can be specified using the Java configuration property syntax in any and all .properties files: 1 cas.jdbc.gen-ddl=true This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework. CAS properties can be specified using the YAML syntax: cas: jdbc: gen-ddl: "true" Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice. CAS properties can be passed to the CAS web application as system properties, when the application is launched: 1 java -Dcas.jdbc.gen-ddl="true" -jar build/libs/cas.war The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched. CAS properties can specified as system environment variables before the CAS web application is launched: 1 2 3 export CAS_JDBC_GEN_DDL="true" java -jar build/libs/cas.war The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched: 1 java -jar build/libs/cas.war --cas.jdbc.gen-ddl="true" The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.
cas.jdbc.physical-table-names= Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default. How can I configure this property? CAS Property: cas.jdbc.physical-table-names Configuration properties can be included and activated using the following strategies. 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. Java Property YAML Property System Property Environment Variable Command-line Argument CAS properties can be specified using the Java configuration property syntax in any and all .properties files: 1 cas.jdbc.physical-table-names=... This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework. CAS properties can be specified using the YAML syntax: cas: jdbc: physical-table-names: "..." Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice. CAS properties can be passed to the CAS web application as system properties, when the application is launched: 1 java -Dcas.jdbc.physical-table-names="..." -jar build/libs/cas.war The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched. CAS properties can specified as system environment variables before the CAS web application is launched: 1 2 3 export CAS_JDBC_PHYSICAL_TABLE_NAMES="..." java -jar build/libs/cas.war The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched: 1 java -jar build/libs/cas.war --cas.jdbc.physical-table-names="..." The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.
cas.jdbc.show-sql=false Whether SQL queries should be displayed in the console/logs. How can I configure this property? CAS Property: cas.jdbc.show-sql Configuration properties can be included and activated using the following strategies. 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. Java Property YAML Property System Property Environment Variable Command-line Argument CAS properties can be specified using the Java configuration property syntax in any and all .properties files: 1 cas.jdbc.show-sql=... This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework. CAS properties can be specified using the YAML syntax: cas: jdbc: show-sql: "..." Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice. CAS properties can be passed to the CAS web application as system properties, when the application is launched: 1 java -Dcas.jdbc.show-sql="..." -jar build/libs/cas.war The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched. CAS properties can specified as system environment variables before the CAS web application is launched: 1 2 3 export CAS_JDBC_SHOW_SQL="..." java -jar build/libs/cas.war The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched: 1 java -jar build/libs/cas.war --cas.jdbc.show-sql="..." The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Showing 1 to 4 of 4 entries

Previous1Next

H2

Available drivers are:

1. org.h2.Driver

HSQLDB

Available drivers are:

1. org.hsqldb.jdbcDriver

Oracle

Available drivers are:

1. oracle.jdbc.driver.OracleDriver

MYSQL

Available drivers are:

1. com.mysql.jdbc.Driver
2. com.mysql.cj.jdbc.Driver

PostgreSQL

Available drivers are:

1. org.postgresql.Driver

MariaDB

Available drivers are:

1. org.mariadb.jdbc.Driver

Microsoft SQL Server

Available drivers are:

1. net.sourceforge.jtds.jdbc.Driver
2. com.microsoft.sqlserver.jdbc.SQLServerDriver