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.

Server-side Sessions

In the event that you wish to use server-side session storage for managing the webflow session, you will need to enable this behavior via CAS properties.

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.webflow.session.storage=false

Controls whether spring webflow sessions are to be stored server-side or client side. By default state is managed on the client side, that is also signed and encrypted.

org.apereo.cas.configuration.model.core.web.flow.WebflowSessionManagementProperties.

_{Copy Configuration Property

Copied!} _{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.webflow.session.storage=...

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: 
  webflow: 
    session: 
      storage: "..."

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.webflow.session.storage="..." -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_WEBFLOW_SESSION_STORAGE="..."

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.webflow.session.storage="..."

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.webflow.session.pin-to-session=false

Controls whether the webflow session is pinned to the client's IP address and user-agent.

org.apereo.cas.configuration.model.core.web.flow.WebflowSessionManagementProperties.

_{Copy Configuration Property

Copied!} _{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.webflow.session.pin-to-session=...

CAS properties can be specified using the YAML syntax:

cas: 
  webflow: 
    session: 
      pin-to-session: "..."

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.webflow.session.pin-to-session="..." -jar build/libs/cas.war

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

export CAS_WEBFLOW_SESSION_PIN_TO_SESSION="..."

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.webflow.session.pin-to-session="..."

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.webflow.session.server.compress=false

Whether or not the snapshots should be compressed. Only relevant if session storage is done on the server.

org.apereo.cas.configuration.model.core.web.flow.WebflowServerSessionsProperties.

_{Copy Configuration Property

Copied!} _{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.webflow.session.server.compress=...

CAS properties can be specified using the YAML syntax:

cas: 
  webflow: 
    session: 
      server: 
        compress: "..."

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.webflow.session.server.compress="..." -jar build/libs/cas.war

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

export CAS_WEBFLOW_SESSION_SERVER_COMPRESS="..."

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.webflow.session.server.compress="..."

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.webflow.session.server.lock-timeout=PT30S

Sets the time period that can elapse before a timeout occurs on an attempt to acquire a conversation lock. The default is 30 seconds. Only relevant if session storage is done on the server.

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

org.apereo.cas.configuration.model.core.web.flow.WebflowServerSessionsProperties.

_{Copy Configuration Property

Copied!} _{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.webflow.session.server.lock-timeout=PT30S

CAS properties can be specified using the YAML syntax:

cas: 
  webflow: 
    session: 
      server: 
        lock-timeout: "PT30S"

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.webflow.session.server.lock-timeout="PT30S" -jar build/libs/cas.war

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

export CAS_WEBFLOW_SESSION_SERVER_LOCK_TIMEOUT="PT30S"

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.webflow.session.server.lock-timeout="PT30S"

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.webflow.session.server.max-conversations=5

Using the maxConversations property, you can limit the number of concurrently active conversations allowed in a single session. If the maximum is exceeded, the conversation manager will automatically end the oldest conversation. The default is 5, which should be fine for most situations. Set it to -1 for no limit. Setting maxConversations to 1 allows easy resource cleanup in situations where there should only be one active conversation per session. Only relevant if session storage is done on the server.

org.apereo.cas.configuration.model.core.web.flow.WebflowServerSessionsProperties.

_{Copy Configuration Property

Copied!} _{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.webflow.session.server.max-conversations=5

CAS properties can be specified using the YAML syntax:

cas: 
  webflow: 
    session: 
      server: 
        max-conversations: "5"

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.webflow.session.server.max-conversations="5" -jar build/libs/cas.war

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

export CAS_WEBFLOW_SESSION_SERVER_MAX_CONVERSATIONS="5"

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.webflow.session.server.max-conversations="5"

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 Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.}

spring.session.data.redis.cleanup-cron=0 * * * * *

Cron expression for expired session cleanup job. Only supported when repository-type is set to indexed. Not supported with a reactive session repository.

org.springframework.boot.session.data.redis.autoconfigure.SessionDataRedisProperties.

_{Copy Configuration Property

Copied!} _{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:

spring.session.data.redis.cleanup-cron=0 * * * * *

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    data: 
      redis: 
        cleanup-cron: "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 -Dspring.session.data.redis.cleanup-cron="0 * * * * *" -jar build/libs/cas.war

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

export SPRING_SESSION_DATA_REDIS_CLEANUP_CRON="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 --spring.session.data.redis.cleanup-cron="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.

spring.session.data.redis.configure-action=notify-keyspace-events

The configure action to apply when no user-defined ConfigureRedisAction or ConfigureReactiveRedisAction bean is present.

org.springframework.boot.session.data.redis.autoconfigure.SessionDataRedisProperties.

_{Copy Configuration Property

Copied!} _{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:

spring.session.data.redis.configure-action=notify-keyspace-events

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    data: 
      redis: 
        configure-action: "notify-keyspace-events"

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 -Dspring.session.data.redis.configure-action="notify-keyspace-events" -jar build/libs/cas.war

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

export SPRING_SESSION_DATA_REDIS_CONFIGURE_ACTION="notify-keyspace-events"

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 --spring.session.data.redis.configure-action="notify-keyspace-events"

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.

spring.session.data.redis.flush-mode=on-save

Sessions flush mode. Determines when session changes are written to the session store. Not supported with a reactive session repository.

org.springframework.boot.session.data.redis.autoconfigure.SessionDataRedisProperties.

_{Copy Configuration Property

Copied!} _{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:

spring.session.data.redis.flush-mode=on-save

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    data: 
      redis: 
        flush-mode: "on-save"

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 -Dspring.session.data.redis.flush-mode="on-save" -jar build/libs/cas.war

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

export SPRING_SESSION_DATA_REDIS_FLUSH_MODE="on-save"

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 --spring.session.data.redis.flush-mode="on-save"

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.

spring.session.data.redis.namespace=spring:session

Namespace for keys used to store sessions.

org.springframework.boot.session.data.redis.autoconfigure.SessionDataRedisProperties.

_{Copy Configuration Property

Copied!} _{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:

spring.session.data.redis.namespace=spring:session

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    data: 
      redis: 
        namespace: "spring:session"

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 -Dspring.session.data.redis.namespace="spring:session" -jar build/libs/cas.war

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

export SPRING_SESSION_DATA_REDIS_NAMESPACE="spring:session"

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 --spring.session.data.redis.namespace="spring:session"

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.

spring.session.data.redis.repository-type=default

Type of Redis session repository to configure.

org.springframework.boot.session.data.redis.autoconfigure.SessionDataRedisProperties.

_{Copy Configuration Property

Copied!} _{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:

spring.session.data.redis.repository-type=default

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    data: 
      redis: 
        repository-type: "default"

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 -Dspring.session.data.redis.repository-type="default" -jar build/libs/cas.war

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

export SPRING_SESSION_DATA_REDIS_REPOSITORY_TYPE="default"

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 --spring.session.data.redis.repository-type="default"

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.

spring.session.data.redis.save-mode=on-set-attribute

Sessions save mode. Determines how session changes are tracked and saved to the session store.

org.springframework.boot.session.data.redis.autoconfigure.SessionDataRedisProperties.

_{Copy Configuration Property

Copied!} _{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:

spring.session.data.redis.save-mode=on-set-attribute

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    data: 
      redis: 
        save-mode: "on-set-attribute"

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 -Dspring.session.data.redis.save-mode="on-set-attribute" -jar build/libs/cas.war

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

export SPRING_SESSION_DATA_REDIS_SAVE_MODE="on-set-attribute"

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 --spring.session.data.redis.save-mode="on-set-attribute"

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.

spring.session.jdbc.cleanup-cron=0 * * * * *

Cron expression for expired session cleanup job.

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

_{Copy Configuration Property

Copied!} _{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:

spring.session.jdbc.cleanup-cron=0 * * * * *

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    jdbc: 
      cleanup-cron: "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 -Dspring.session.jdbc.cleanup-cron="0 * * * * *" -jar build/libs/cas.war

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

export SPRING_SESSION_JDBC_CLEANUP_CRON="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 --spring.session.jdbc.cleanup-cron="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.

spring.session.jdbc.continue-on-error=true

Whether initialization should continue when an error occurs when applying a schema script.

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

_{Copy Configuration Property

Copied!} _{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:

spring.session.jdbc.continue-on-error=true

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    jdbc: 
      continue-on-error: "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 -Dspring.session.jdbc.continue-on-error="true" -jar build/libs/cas.war

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

export SPRING_SESSION_JDBC_CONTINUE_ON_ERROR="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 --spring.session.jdbc.continue-on-error="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.

spring.session.jdbc.flush-mode=on-save

Sessions flush mode. Determines when session changes are written to the session store.

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

_{Copy Configuration Property

Copied!} _{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:

spring.session.jdbc.flush-mode=on-save

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    jdbc: 
      flush-mode: "on-save"

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 -Dspring.session.jdbc.flush-mode="on-save" -jar build/libs/cas.war

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

export SPRING_SESSION_JDBC_FLUSH_MODE="on-save"

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 --spring.session.jdbc.flush-mode="on-save"

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.

spring.session.jdbc.initialize-schema=embedded

Database schema initialization mode.

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

_{Copy Configuration Property

Copied!} _{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:

spring.session.jdbc.initialize-schema=embedded

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    jdbc: 
      initialize-schema: "embedded"

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 -Dspring.session.jdbc.initialize-schema="embedded" -jar build/libs/cas.war

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

export SPRING_SESSION_JDBC_INITIALIZE_SCHEMA="embedded"

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 --spring.session.jdbc.initialize-schema="embedded"

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.

spring.session.jdbc.platform=

Platform to use in initialization scripts if the @@platform@@ placeholder is used. Auto-detected by default.

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

_{Copy Configuration Property

Copied!} _{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:

spring.session.jdbc.platform=...

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    jdbc: 
      platform: "..."

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 -Dspring.session.jdbc.platform="..." -jar build/libs/cas.war

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

export SPRING_SESSION_JDBC_PLATFORM="..."

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 --spring.session.jdbc.platform="..."

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.

spring.session.jdbc.save-mode=on-set-attribute

Sessions save mode. Determines how session changes are tracked and saved to the session store.

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

_{Copy Configuration Property

Copied!} _{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:

spring.session.jdbc.save-mode=on-set-attribute

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    jdbc: 
      save-mode: "on-set-attribute"

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 -Dspring.session.jdbc.save-mode="on-set-attribute" -jar build/libs/cas.war

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

export SPRING_SESSION_JDBC_SAVE_MODE="on-set-attribute"

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 --spring.session.jdbc.save-mode="on-set-attribute"

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.

spring.session.jdbc.schema=

Path to the SQL file to use to initialize the database schema.

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

_{Copy Configuration Property

Copied!} _{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:

spring.session.jdbc.schema=...

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    jdbc: 
      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 -Dspring.session.jdbc.schema="..." -jar build/libs/cas.war

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

export SPRING_SESSION_JDBC_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 --spring.session.jdbc.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.

spring.session.jdbc.table-name=SPRING_SESSION

Name of the database table used to store sessions.

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

_{Copy Configuration Property

Copied!} _{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:

spring.session.jdbc.table-name=SPRING_SESSION

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    jdbc: 
      table-name: "SPRING_SESSION"

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 -Dspring.session.jdbc.table-name="SPRING_SESSION" -jar build/libs/cas.war

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

export SPRING_SESSION_JDBC_TABLE_NAME="SPRING_SESSION"

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 --spring.session.jdbc.table-name="SPRING_SESSION"

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.

spring.session.redis.cleanup-cron=

Cron expression for expired session cleanup job. Only supported when repository-type is set to indexed. Not supported with a reactive session repository.

_{Copy Configuration Property

Copied!} _{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:

spring.session.redis.cleanup-cron=...

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    redis: 
      cleanup-cron: "..."

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 -Dspring.session.redis.cleanup-cron="..." -jar build/libs/cas.war

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

export SPRING_SESSION_REDIS_CLEANUP_CRON="..."

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 --spring.session.redis.cleanup-cron="..."

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.

Deprecation status is ERRORwith a replacement setting: spring.session.data.redis.cleanup-cron.

spring.session.redis.configure-action=

The configure action to apply when no user-defined ConfigureRedisAction or ConfigureReactiveRedisAction bean is present.

_{Copy Configuration Property

Copied!} _{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:

spring.session.redis.configure-action=...

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    redis: 
      configure-action: "..."

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 -Dspring.session.redis.configure-action="..." -jar build/libs/cas.war

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

export SPRING_SESSION_REDIS_CONFIGURE_ACTION="..."

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 --spring.session.redis.configure-action="..."

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.

Deprecation status is ERRORwith a replacement setting: spring.session.data.redis.configure-action.

spring.session.redis.flush-mode=

Sessions flush mode. Determines when session changes are written to the session store. Not supported with a reactive session repository.

_{Copy Configuration Property

Copied!} _{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:

spring.session.redis.flush-mode=...

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    redis: 
      flush-mode: "..."

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 -Dspring.session.redis.flush-mode="..." -jar build/libs/cas.war

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

export SPRING_SESSION_REDIS_FLUSH_MODE="..."

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 --spring.session.redis.flush-mode="..."

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.

Deprecation status is ERRORwith a replacement setting: spring.session.data.redis.flush-mode.

spring.session.redis.namespace=

Namespace for keys used to store sessions.

_{Copy Configuration Property

Copied!} _{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:

spring.session.redis.namespace=...

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    redis: 
      namespace: "..."

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 -Dspring.session.redis.namespace="..." -jar build/libs/cas.war

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

export SPRING_SESSION_REDIS_NAMESPACE="..."

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 --spring.session.redis.namespace="..."

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.

Deprecation status is ERRORwith a replacement setting: spring.session.data.redis.namespace.

spring.session.redis.repository-type=

Type of Redis session repository to configure.

_{Copy Configuration Property

Copied!} _{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:

spring.session.redis.repository-type=...

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    redis: 
      repository-type: "..."

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 -Dspring.session.redis.repository-type="..." -jar build/libs/cas.war

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

export SPRING_SESSION_REDIS_REPOSITORY_TYPE="..."

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 --spring.session.redis.repository-type="..."

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.

Deprecation status is ERRORwith a replacement setting: spring.session.data.redis.repository-type.

spring.session.redis.save-mode=

Sessions save mode. Determines how session changes are tracked and saved to the session store.

_{Copy Configuration Property

Copied!} _{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:

spring.session.redis.save-mode=...

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    redis: 
      save-mode: "..."

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 -Dspring.session.redis.save-mode="..." -jar build/libs/cas.war

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

export SPRING_SESSION_REDIS_SAVE_MODE="..."

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 --spring.session.redis.save-mode="..."

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.

Deprecation status is ERRORwith a replacement setting: spring.session.data.redis.save-mode.

spring.session.servlet.filter-dispatcher-types=asyncerrorrequest

Session repository filter dispatcher types.

org.springframework.boot.session.autoconfigure.SessionProperties$Servlet.

_{Copy Configuration Property

Copied!} _{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:

spring.session.servlet.filter-dispatcher-types=asyncerrorrequest

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    servlet: 
      filter-dispatcher-types: "["async", "error", "request"]"

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 -Dspring.session.servlet.filter-dispatcher-types="["async", "error", "request"]" -jar build/libs/cas.war

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

export SPRING_SESSION_SERVLET_FILTER_DISPATCHER_TYPES="["async", "error", "request"]"

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 --spring.session.servlet.filter-dispatcher-types="["async", "error", "request"]"

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.

spring.session.servlet.filter-order=

Session repository filter order.

org.springframework.boot.session.autoconfigure.SessionProperties$Servlet.

_{Copy Configuration Property

Copied!} _{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:

spring.session.servlet.filter-order=...

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    servlet: 
      filter-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 -Dspring.session.servlet.filter-order="..." -jar build/libs/cas.war

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

export SPRING_SESSION_SERVLET_FILTER_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 --spring.session.servlet.filter-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.

spring.session.timeout=

Session timeout. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.session.autoconfigure.SessionProperties.

_{Copy Configuration Property

Copied!} _{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:

spring.session.timeout=...

CAS properties can be specified using the YAML syntax:

spring: 
  session: 
    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 -Dspring.session.timeout="..." -jar build/libs/cas.war

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

export SPRING_SESSION_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 --spring.session.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.

# Cron expression for expired session cleanup job.
# spring.session.data.redis.cleanup-cron=0 * * * * *

# The configure action to apply when no user-defined ConfigureRedisAction or ConfigureReactiveRedisAction bean is present.
# spring.session.data.redis.configure-action=notify-keyspace-events

# Sessions flush mode.
# spring.session.data.redis.flush-mode=on-save

# Namespace for keys used to store sessions.
# spring.session.data.redis.namespace=spring:session

# Type of Redis session repository to configure.
# spring.session.data.redis.repository-type=default

# Sessions save mode.
# spring.session.data.redis.save-mode=on-set-attribute

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

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

# Sessions flush mode.
# spring.session.jdbc.flush-mode=on-save

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

# Platform to use in initialization scripts if the @@platform@@ placeholder is used.
# spring.session.jdbc.platform=

# Sessions save mode.
# spring.session.jdbc.save-mode=on-set-attribute

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

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

# Cron expression for expired session cleanup job.
# spring.session.redis.cleanup-cron=

# The configure action to apply when no user-defined ConfigureRedisAction or ConfigureReactiveRedisAction bean is present.
# spring.session.redis.configure-action=

# Sessions flush mode.
# spring.session.redis.flush-mode=

# Namespace for keys used to store sessions.
# spring.session.redis.namespace=

# Type of Redis session repository to configure.
# spring.session.redis.repository-type=

# Sessions save mode.
# spring.session.redis.save-mode=

# Session repository filter dispatcher types.
# spring.session.servlet.filter-dispatcher-types=["async", "error", "request"]

# Session repository filter order.
# spring.session.servlet.filter-order=

# Session timeout.
# spring.session.timeout=

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, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

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

Doing so will likely require you to also enable sticky sessions and/or session replication in a clustered deployment of CAS.

Usage Warning!

Generally speaking, you do not need to enable server-side sessions unless you have a rather specialized deployment or are in need of features that store bits and pieces of data into a sever-backed session object. It is recommended that you stick with the default client-side session storage and only switch if and when mandated by a specific CAS behavior.

Storage Options

If you do wish to use server-side session storage, CAS supports the following options for storing webflow sessions:

Topic	Description
Hazelcast	See this guide.
JDBC	See this guide.
MongoDb	See this guide.
Redis	See this guide.
Ticket Registry	See this guide.