WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

JDBC Attribute Resolution

CAS does allow for attributes to be retrieved from a variety of SQL databases.

Support is enabled by including the following dependency in the WAR overlay:

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

implementation "org.apereo.cas:cas-server-support-jdbc:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-jdbc"
}

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

To learn how to configure database drivers, please see this guide.

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.}

cas.authn.attribute-repository.jdbc[0].driver-class=

The JDBC driver used to connect to the database.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

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.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].driver-class=...

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: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        driver-class: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].driver-class="..." -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:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_DRIVER_CLASS="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].driver-class="..."

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.authn.attribute-repository.jdbc[0].password=

The database connection password.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].password=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        password: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].password="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_PASSWORD="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].password="..."

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.authn.attribute-repository.jdbc[0].url=

The database connection URL.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].url=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        url: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_URL="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].url="..."

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.authn.attribute-repository.jdbc[0].user=

The database user.

The database user must have sufficient permissions to be able to handle schema changes and updates, when needed.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].user=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        user: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].user="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_USER="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].user="..."

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.

_{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.}

cas.authn.attribute-repository.jdbc=

Retrieve attributes from multiple JDBC repositories.

org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc: "..."

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:

java -Dcas.authn.attribute-repository.jdbc="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc="..."

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.authn.attribute-repository.jdbc[0].pool.keep-alive-time=0

This property controls the keepalive interval for a connection in the pool. An in-use connection will never be tested by the keepalive thread, only when it is idle will it be tested. Default is zero, which disables this feature.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].pool.keep-alive-time=0

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        pool: 
          keep-alive-time: "0"

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:

java -Dcas.authn.attribute-repository.jdbc[0].pool.keep-alive-time="0" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_POOL_KEEP_ALIVE_TIME="0"

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].pool.keep-alive-time="0"

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.authn.attribute-repository.jdbc[0].pool.max-size=18

Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].pool.max-size=18

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        pool: 
          max-size: "18"

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:

java -Dcas.authn.attribute-repository.jdbc[0].pool.max-size="18" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_POOL_MAX_SIZE="18"

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].pool.max-size="18"

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.authn.attribute-repository.jdbc[0].pool.max-wait=PT2S

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.

A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].pool.max-wait=PT2S

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        pool: 
          max-wait: "PT2S"

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:

java -Dcas.authn.attribute-repository.jdbc[0].pool.max-wait="PT2S" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_POOL_MAX_WAIT="PT2S"

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].pool.max-wait="PT2S"

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.authn.attribute-repository.jdbc[0].pool.maximum-lifetime=PT10M

This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].pool.maximum-lifetime=PT10M

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        pool: 
          maximum-lifetime: "PT10M"

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:

java -Dcas.authn.attribute-repository.jdbc[0].pool.maximum-lifetime="PT10M" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_POOL_MAXIMUM_LIFETIME="PT10M"

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].pool.maximum-lifetime="PT10M"

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.authn.attribute-repository.jdbc[0].pool.min-size=6

Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].pool.min-size=6

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        pool: 
          min-size: "6"

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:

java -Dcas.authn.attribute-repository.jdbc[0].pool.min-size="6" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_POOL_MIN_SIZE="6"

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].pool.min-size="6"

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.authn.attribute-repository.jdbc[0].pool.name=

Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].pool.name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        pool: 
          name: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].pool.name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_POOL_NAME="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].pool.name="..."

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.authn.attribute-repository.jdbc[0].pool.suspension=

Whether or not pool suspension is allowed.

There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].pool.suspension=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        pool: 
          suspension: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].pool.suspension="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_POOL_SUSPENSION="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].pool.suspension="..."

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.authn.attribute-repository.jdbc[0].pool.timeout-millis=1000

The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].pool.timeout-millis=1000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        pool: 
          timeout-millis: "1000"

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:

java -Dcas.authn.attribute-repository.jdbc[0].pool.timeout-millis="1000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_POOL_TIMEOUT_MILLIS="1000"

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].pool.timeout-millis="1000"

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.authn.attribute-repository.jdbc[0].attributes=

Map of attributes to fetch from the database. Attributes are defined using a key-value structure where CAS allows the attribute name/key to be renamed virtually to a different attribute. The key is the attribute fetched from the data source and the value is the attribute name CAS should use for virtual renames. Attributes may be allowed to be virtually renamed and remapped. The key in the attribute map is the original attribute, and the value should be the virtually-renamed attribute.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].attributes=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        attributes: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].attributes="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_ATTRIBUTES="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].attributes="..."

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.authn.attribute-repository.jdbc[0].autocommit=

The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].autocommit=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        autocommit: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].autocommit="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_AUTOCOMMIT="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].autocommit="..."

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.authn.attribute-repository.jdbc[0].batch-size=

A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].batch-size=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        batch-size: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].batch-size="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_BATCH_SIZE="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].batch-size="..."

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.authn.attribute-repository.jdbc[0].case-canonicalization=NONE

When constructing the final person object from the attribute repository, indicate how the username should be canonicalized. Accepted values are:

UPPER: Transform the final person id into uppercase characters.
LOWER: Transform the final person id into lowercase characters.
NONE: Do nothing.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].case-canonicalization=NONE

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        case-canonicalization: "NONE"

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:

java -Dcas.authn.attribute-repository.jdbc[0].case-canonicalization="NONE" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_CASE_CANONICALIZATION="NONE"

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].case-canonicalization="NONE"

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.authn.attribute-repository.jdbc[0].case-insensitive-query-attributes=

Collection of attributes, used to build the SQL query, that should go through a case canonicalization process defined as key->value. Note that the key is not the name of the attribute, but the query attribute that is used in generating the final query clause (i.e. username). The value can be NONE, LOWER, UPPER.

It's also possible to define a list of attributes without a case canonicalization override such as username, attribute2 in which case #caseCanonicalization will dictate the final outcome.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].case-insensitive-query-attributes=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        case-insensitive-query-attributes: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].case-insensitive-query-attributes="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_CASE_INSENSITIVE_QUERY_ATTRIBUTES="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].case-insensitive-query-attributes="..."

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.authn.attribute-repository.jdbc[0].column-mappings=

Used only when there is a mapping of many rows to one user. This is done using a key-value structure where the key is the name of the "attribute name" column the value is the name of the "attribute value" column. If the table structure is as such:

-----------------------------
uid | attr_name  | attr_value
-----------------------------
tom | first_name | Thomas

Then a column mapping must be specified to teach CAS to use attr_name and attr_value for attribute names and values.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].column-mappings=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        column-mappings: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].column-mappings="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_COLUMN_MAPPINGS="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].column-mappings="..."

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.authn.attribute-repository.jdbc[0].connection-timeout=

Indicates the maximum number of milliseconds that the service can wait to obtain a connection.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].connection-timeout=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        connection-timeout: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].connection-timeout="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_CONNECTION_TIMEOUT="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].connection-timeout="..."

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.authn.attribute-repository.jdbc[0].data-source-name=

Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].data-source-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        data-source-name: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].data-source-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_DATA_SOURCE_NAME="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].data-source-name="..."

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.authn.attribute-repository.jdbc[0].ddl-auto=

Hibernate feature to automatically validate and exports DDL to the schema. By default, creates and drops the schema automatically when a session is starts and ends. Setting the value to validate or none may be more desirable for production, but any of the following options can be used:

validate: Validate the schema, but make no changes to the database.
update: Update the schema.
create: Create the schema, destroying previous data.
create-drop: Drop the schema at the end of the session.
none: Do nothing.

Note that during a version migration where any schema has changed create-drop will result in the loss of all data as soon as CAS is started. For transient data like tickets this is probably not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe for data, is confirmed to result in invalid database state. validate or none settings are likely the only safe options for production use.

For more info, see this.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].ddl-auto=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        ddl-auto: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].ddl-auto="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_DDL_AUTO="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].ddl-auto="..."

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.authn.attribute-repository.jdbc[0].default-catalog=

Qualifies unqualified table names with the given catalog in generated SQL.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].default-catalog=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        default-catalog: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].default-catalog="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_DEFAULT_CATALOG="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].default-catalog="..."

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.authn.attribute-repository.jdbc[0].default-schema=

Qualify unqualified table names with the given schema/tablespace in generated SQL.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].default-schema=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        default-schema: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].default-schema="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_DEFAULT_SCHEMA="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].default-schema="..."

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.authn.attribute-repository.jdbc[0].dialect=

The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].dialect=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        dialect: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].dialect="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_DIALECT="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].dialect="..."

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.authn.attribute-repository.jdbc[0].fail-fast-timeout=

Set the pool initialization failure timeout.

Any value greater than zero will be treated as a timeout for pool initialization. The calling thread will be blocked from continuing until a successful connection to the database, or until the timeout is reached. If the timeout is reached, then a PoolInitializationException will be thrown.
A value of zero will not prevent the pool from starting in the case that a connection cannot be obtained. However, upon start the pool will attempt to obtain a connection and validate that the connectionTestQuery and connectionInitSql are valid. If those validations fail, an exception will be thrown. If a connection cannot be obtained, the validation is skipped and the pool will start and continue to try to obtain connections in the background. This can mean that callers to DataSource#getConnection() may encounter exceptions.
A value less than zero will not bypass any connection attempt and validation during startup, and therefore the pool will start immediately. The pool will continue to try to obtain connections in the background. This can mean that callers to DataSource#getConnection() may encounter exceptions.

Note that if this timeout value is greater than or equal to zero (0), and therefore an initial connection validation is performed, this timeout does not override the connectionTimeout or validationTimeout; they will be honored before this timeout is applied. The default value is one millisecond.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].fail-fast-timeout=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        fail-fast-timeout: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].fail-fast-timeout="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_FAIL_FAST_TIMEOUT="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].fail-fast-timeout="..."

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.authn.attribute-repository.jdbc[0].fetch-size=

Used to specify number of rows to be fetched in a select query.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].fetch-size=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        fetch-size: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].fetch-size="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_FETCH_SIZE="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].fetch-size="..."

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.authn.attribute-repository.jdbc[0].generate-statistics=

Allow hibernate to generate query statistics.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].generate-statistics=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        generate-statistics: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].generate-statistics="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_GENERATE_STATISTICS="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].generate-statistics="..."

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.authn.attribute-repository.jdbc[0].health-query=

The SQL query to be executed to test the validity of connections. This is for "legacy" databases that do not support the JDBC4 Connection.isValid() API.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].health-query=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        health-query: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].health-query="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_HEALTH_QUERY="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].health-query="..."

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.authn.attribute-repository.jdbc[0].id=

A value can be assigned to this field to uniquely identify this resolver.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].id=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        id: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].id="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_ID="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].id="..."

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.authn.attribute-repository.jdbc[0].idle-timeout=

Controls the maximum amount of time that a connection is allowed to sit idle in the pool.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].idle-timeout=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        idle-timeout: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].idle-timeout="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_IDLE_TIMEOUT="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].idle-timeout="..."

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.authn.attribute-repository.jdbc[0].isolate-internal-queries=

This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.

Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if #autocommit is disabled.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].isolate-internal-queries=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        isolate-internal-queries: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].isolate-internal-queries="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_ISOLATE_INTERNAL_QUERIES="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].isolate-internal-queries="..."

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.authn.attribute-repository.jdbc[0].isolation-level-name=

Defines the isolation level for transactions.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].isolation-level-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        isolation-level-name: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].isolation-level-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_ISOLATION_LEVEL_NAME="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].isolation-level-name="..."

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.authn.attribute-repository.jdbc[0].leak-threshold=

Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].leak-threshold=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        leak-threshold: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].leak-threshold="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_LEAK_THRESHOLD="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].leak-threshold="..."

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.authn.attribute-repository.jdbc[0].order=

The order of this attribute repository in the chain of repositories. Can be used to explicitly position this source in chain and affects merging strategies.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].order=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        order: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].order="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_ORDER="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].order="..."

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.authn.attribute-repository.jdbc[0].physical-naming-strategy-class-name=

Fully-qualified name of the class that can control the physical naming strategy of hibernate.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].physical-naming-strategy-class-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        physical-naming-strategy-class-name: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].physical-naming-strategy-class-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_PHYSICAL_NAMING_STRATEGY_CLASS_NAME="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].physical-naming-strategy-class-name="..."

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.authn.attribute-repository.jdbc[0].propagation-behavior-name=

Defines the propagation behavior for transactions.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].propagation-behavior-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        propagation-behavior-name: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].propagation-behavior-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_PROPAGATION_BEHAVIOR_NAME="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].propagation-behavior-name="..."

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.authn.attribute-repository.jdbc[0].properties=

Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].properties=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        properties: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].properties="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_PROPERTIES="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].properties="..."

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.authn.attribute-repository.jdbc[0].query-attributes=

Define a Map of query attribute names to data-layer attribute names to use when building the query. The key is always the name of the query attribute that is defined by CAS and passed internally, and the value is the database column that should map.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].query-attributes=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        query-attributes: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].query-attributes="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_QUERY_ATTRIBUTES="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].query-attributes="..."

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.authn.attribute-repository.jdbc[0].query-type=AND

Indicates how multiple attributes in a query should be concatenated together. Accepted values are: *

AND: Concatenate attributes in the query using an AND-clause.
OR: Concatenate attributes in the query using an OR-clause.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].query-type=AND

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        query-type: "AND"

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:

java -Dcas.authn.attribute-repository.jdbc[0].query-type="AND" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_QUERY_TYPE="AND"

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].query-type="AND"

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.authn.attribute-repository.jdbc[0].read-only=

Configures the Connections to be added to the pool as read-only Connections.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].read-only=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        read-only: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].read-only="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_READ_ONLY="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].read-only="..."

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.authn.attribute-repository.jdbc[0].require-all-attributes=true

If the SQL should only be run if all attributes listed in the mappings exist in the query.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].require-all-attributes=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        require-all-attributes: "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:

java -Dcas.authn.attribute-repository.jdbc[0].require-all-attributes="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_REQUIRE_ALL_ATTRIBUTES="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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].require-all-attributes="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.authn.attribute-repository.jdbc[0].single-row=true

Designed to work against a table where there is a mapping of one row to one user. The fields in the table structure is assumed to match username|name|lastname|address where there is only a single row per user. Setting this setting to false will force CAS to work against a table where there is a mapping of one row to one user. The fields in the table structure is assumed to match username|attr_name|attr_value where there is more than one row per username.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].single-row=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        single-row: "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:

java -Dcas.authn.attribute-repository.jdbc[0].single-row="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_SINGLE_ROW="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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].single-row="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.authn.attribute-repository.jdbc[0].sql=

The SQL statement to execute and fetch attributes. The syntax of the query must be SELECT * FROM table WHERE {0}. The WHERE clause is dynamically generated by CAS.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].sql=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        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:

java -Dcas.authn.attribute-repository.jdbc[0].sql="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].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.

cas.authn.attribute-repository.jdbc[0].state=ACTIVE

Whether attribute resolution based on this source is enabled. Available values are as follows:

ACTIVE: Active and enabled repository, and is invoked by default automatically.
DISABLED: Attribute repository is disabled and will not be used to resolve people and attributes.
STANDBY: Repository is in a semi-enabled state, waiting to be called only on-demand when explicitly asked for and will not be registered into the resolution plan.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].state=ACTIVE

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        state: "ACTIVE"

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:

java -Dcas.authn.attribute-repository.jdbc[0].state="ACTIVE" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_STATE="ACTIVE"

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].state="ACTIVE"

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.authn.attribute-repository.jdbc[0].username=

Username attribute(s) to use when running the SQL query.

org.apereo.cas.configuration.model.support.jdbc.JdbcPrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.jdbc[0].username=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      jdbc[0]: 
        username: "..."

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:

java -Dcas.authn.attribute-repository.jdbc[0].username="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_JDBC[0]_USERNAME="..."

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:

java -jar build/libs/cas.war --cas.authn.attribute-repository.jdbc[0].username="..."

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.

# Retrieve attributes from multiple JDBC repositories.
# cas.authn.attribute-repository.jdbc=

# This property controls the keepalive interval for a connection in the pool.
# cas.authn.attribute-repository.jdbc[0].pool.keep-alive-time=0

# Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.
# cas.authn.attribute-repository.jdbc[0].pool.max-size=18

# Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
# cas.authn.attribute-repository.jdbc[0].pool.max-wait=PT2S

# This property controls the maximum lifetime of a connection in the pool.
# cas.authn.attribute-repository.jdbc[0].pool.maximum-lifetime=PT10M

# Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.
# cas.authn.attribute-repository.jdbc[0].pool.min-size=6

# Set the name of the connection pool.
# cas.authn.attribute-repository.jdbc[0].pool.name=

# Whether or not pool suspension is allowed.
# cas.authn.attribute-repository.jdbc[0].pool.suspension=

# The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
# cas.authn.attribute-repository.jdbc[0].pool.timeout-millis=1000

# Map of attributes to fetch from the database.
# cas.authn.attribute-repository.jdbc[0].attributes=

# The default auto-commit behavior of connections in the pool.
# cas.authn.attribute-repository.jdbc[0].autocommit=

# A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
# cas.authn.attribute-repository.jdbc[0].batch-size=

# When constructing the final person object from the attribute repository, indicate how the username should be canonicalized.
# cas.authn.attribute-repository.jdbc[0].case-canonicalization=NONE

# Collection of attributes, used to build the SQL query, that should go through a case canonicalization process defined as {@code key->value}.
# cas.authn.attribute-repository.jdbc[0].case-insensitive-query-attributes=

# Used only when there is a mapping of many rows to one user.
# cas.authn.attribute-repository.jdbc[0].column-mappings=

# Indicates the maximum number of milliseconds that the service can wait to obtain a connection.
# cas.authn.attribute-repository.jdbc[0].connection-timeout=

# Attempts to do a JNDI data source look up for the data source name specified.
# cas.authn.attribute-repository.jdbc[0].data-source-name=

# Hibernate feature to automatically validate and exports DDL to the schema.
# cas.authn.attribute-repository.jdbc[0].ddl-auto=

# Qualifies unqualified table names with the given catalog in generated SQL.
# cas.authn.attribute-repository.jdbc[0].default-catalog=

# Qualify unqualified table names with the given schema/tablespace in generated SQL.
# cas.authn.attribute-repository.jdbc[0].default-schema=

# The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.
# cas.authn.attribute-repository.jdbc[0].dialect=

# Set the pool initialization failure timeout.
# cas.authn.attribute-repository.jdbc[0].fail-fast-timeout=

# Used to specify number of rows to be fetched in a select query.
# cas.authn.attribute-repository.jdbc[0].fetch-size=

# Allow hibernate to generate query statistics.
# cas.authn.attribute-repository.jdbc[0].generate-statistics=

# The SQL query to be executed to test the validity of connections.
# cas.authn.attribute-repository.jdbc[0].health-query=

# A value can be assigned to this field to uniquely identify this resolver.
# cas.authn.attribute-repository.jdbc[0].id=

# Controls the maximum amount of time that a connection is allowed to sit idle in the pool.
# cas.authn.attribute-repository.jdbc[0].idle-timeout=

# This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.
# cas.authn.attribute-repository.jdbc[0].isolate-internal-queries=

# Defines the isolation level for transactions.
# cas.authn.attribute-repository.jdbc[0].isolation-level-name=

# Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
# cas.authn.attribute-repository.jdbc[0].leak-threshold=

# The order of this attribute repository in the chain of repositories.
# cas.authn.attribute-repository.jdbc[0].order=

# Fully-qualified name of the class that can control the physical naming strategy of hibernate.
# cas.authn.attribute-repository.jdbc[0].physical-naming-strategy-class-name=

# Defines the propagation behavior for transactions.
# cas.authn.attribute-repository.jdbc[0].propagation-behavior-name=

# Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.
# cas.authn.attribute-repository.jdbc[0].properties=

# Define a {@code Map} of query attribute names to data-layer attribute names to use when building the query.
# cas.authn.attribute-repository.jdbc[0].query-attributes=

# Indicates how multiple attributes in a query should be concatenated together.
# cas.authn.attribute-repository.jdbc[0].query-type=AND

# Configures the Connections to be added to the pool as read-only Connections.
# cas.authn.attribute-repository.jdbc[0].read-only=

# If the SQL should only be run if all attributes listed in the mappings exist in the query.
# cas.authn.attribute-repository.jdbc[0].require-all-attributes=true

# Designed to work against a table where there is a mapping of one row to one user.
# cas.authn.attribute-repository.jdbc[0].single-row=true

# The SQL statement to execute and fetch attributes.
# cas.authn.attribute-repository.jdbc[0].sql=

# Whether attribute resolution based on this source is enabled.
# cas.authn.attribute-repository.jdbc[0].state=ACTIVE

# Username attribute(s) to use when running the SQL query.
# cas.authn.attribute-repository.jdbc[0].username=

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

cas.jdbc.case-insensitive=false

When choosing physical table names, determine whether names should be considered case-insensitive.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.jdbc.case-insensitive=...

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:

java -Dcas.jdbc.case-insensitive="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

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:

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?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.jdbc.gen-ddl=true

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:

java -Dcas.jdbc.gen-ddl="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

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:

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?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.jdbc.physical-table-names=...

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:

java -Dcas.jdbc.physical-table-names="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

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:

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?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.jdbc.show-sql=...

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:

java -Dcas.jdbc.show-sql="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

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:

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.

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.

Note

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, specially 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.

JDBC attribute sources can be defined based on the following mechanics.

Single Row

Designed to work against a table where there is a mapping of one row to one user. An example of this table format would be:

uid	first_name	last_name	email
`jsmith`	`John`	`Smith`	`jsmith@example.org`

Multi Row

Designed to work against a table where there is a mapping of one row to one user. An example of this table format would be:

uid	attr_name	attr_value
`jsmith`	`first_name`	`John`
`jsmith`	`last_name`	`Smith`
`jsmith`	`email`	`jsmith@example.org`

You will need to define column mappings in your configuration to map the attr_name column to the attr_value column

Examples

Suppose CAS is configured to authenticate against Active Directory. The account whose details are defined below authenticates via sAMAccountName.

Attribute	Value
`sAMAccountName`	`johnsmith`
`cn`	`John Smith`

Example #1

If the resolver is configured to use sAMAccoutName as the attribute for the principal id, then when authentication is complete the resolver attempts to construct attributes from attribute repository sources, it sees sAMAccoutName as the attribute and sees the principal id is to be created by sAMAccoutName. So it would remove the sAMAccoutName from the attributes. The final result is is a principal whose id is johnsmith who has a cn attribute of John Smith.

Example #2

If the resolver is configured to use cn as the attribute for the principal id, then when authentication is complete the resolver attempts to construct attributes from attribute repository sources. It then sees sAMAccoutName as the attribute and sees the principal id is to be created by cn. So it would remove the cn from the attributes. The final result is is a principal whose id is John Smith who has a sAMAccountName attribute of johnsmith.