User Interface - Thymeleaf
CAS uses Thymeleaf for its markup rendering engine. Each template is
decorated by layout.html template file, which provides a layout structure for the template’s content. Individual
components optimized for reuse among multiple templates are stored in the src/main/resources/templates/fragments
folder, and referenced by the templates in src/main/resources/templates.
Refer to the Thymeleaf documentation for more information on its use and syntax.
The following settings and properties are available from the CAS configuration catalog:
spring.thymeleaf.cacheWhether to enable template caching.
trueWhether to enable template caching.
spring.thymeleaf.check-templateWhether to check that the template exists before rendering it.
trueWhether to check that the template exists before rendering it.
spring.thymeleaf.check-template-locationWhether to check that the templates location exists.
trueWhether to check that the templates location exists.
spring.thymeleaf.enable-spring-el-compilerEnable the SpringEL compiler in SpringEL expressions.
falseEnable the SpringEL compiler in SpringEL expressions.
spring.thymeleaf.enabled
spring.thymeleaf.encodingTemplate files encoding.
UTF-8Template files encoding.
spring.thymeleaf.excluded-view-namesList of view names (patterns allowed) that should be excluded from resolution.
List of view names (patterns allowed) that should be excluded from resolution.
spring.thymeleaf.modeTemplate mode to be applied to templates.
HTMLTemplate mode to be applied to templates. See also Thymeleaf's TemplateMode enum.
spring.thymeleaf.prefixPrefix that gets prepended to view names when building a URL.
classpath:/templates/Prefix that gets prepended to view names when building a URL.
spring.thymeleaf.reactive.chunked-mode-view-namesComma-separated list of view names (patterns allowed) that should be the only ones executed in CHUNKED mode when a max chunk size is set.
Comma-separated list of view names (patterns allowed) that should be the only ones executed in CHUNKED mode when a max chunk size is set.
spring.thymeleaf.reactive.full-mode-view-namesComma-separated list of view names (patterns allowed) that should be executed in FULL mode even if a max chunk size is set.
Comma-separated list of view names (patterns allowed) that should be executed in FULL mode even if a max chunk size is set.
spring.thymeleaf.reactive.max-chunk-sizeMaximum size of data buffers used for writing to the response.
0BMaximum size of data buffers used for writing to the response. Templates will execute in CHUNKED mode by default if this is set.
spring.thymeleaf.reactive.media-typesMedia types supported by the view technology.
["text/html", "application/xhtml+xml", "application/xml", "text/xml", "application/rss+xml", "application/atom+xml", "application/javascript", "application/ecmascript", "text/javascript", "text/ecmascript", "application/json", "text/css", "text/plain", "text/event-stream"]Media types supported by the view technology.
spring.thymeleaf.render-hidden-markers-before-checkboxesWhether hidden form inputs acting as markers for checkboxes should be rendered before the checkbox element itself.
falseWhether hidden form inputs acting as markers for checkboxes should be rendered before the checkbox element itself.
spring.thymeleaf.servlet.content-typeContent-Type value written to HTTP responses.
text/htmlContent-Type value written to HTTP responses.
spring.thymeleaf.servlet.produce-partial-output-while-processingWhether Thymeleaf should start writing partial output as soon as possible or buffer until template processing is finished.
trueWhether Thymeleaf should start writing partial output as soon as possible or buffer until template processing is finished.
spring.thymeleaf.suffixSuffix that gets appended to view names when building a URL.
.htmlSuffix that gets appended to view names when building a URL.
spring.thymeleaf.template-resolver-orderOrder of the template resolver in the chain.
Order of the template resolver in the chain. By default, the template resolver is first in the chain. Order start at 1 and should only be set if you have defined additional "TemplateResolver" beans.
spring.thymeleaf.view-namesList of view names (patterns allowed) that can be resolved.
List of view names (patterns allowed) that can be resolved.
Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Notes on configuration
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
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.