Class ViewProperties
java.lang.Object
org.apereo.cas.configuration.model.core.web.view.ViewProperties
- All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-core-web",
automated=true)
public class ViewProperties
extends Object
implements Serializable
This is
ViewProperties
.- Since:
- 5.0.0
- See Also:
-
Nested Class Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetCas1()
CAS1 views and locations.getCas2()
CAS2 views and locations.getCas3()
CAS3 views and locations.Additional custom fields that should be displayed on the login form and would be bound to the authentication credential during form-authentication to carry additional metadata and tags.The default redirect URL if none is specified after a successful login or logout event.getRest()
Resolve CAS views via REST.Comma separated paths to where CAS templates may be found.How to search for theme resource bundles and how to deal with multiple property files found for a given theme.boolean
When set totrue
, attempts to calculate and display the list of authorized services for the authenticated user on successful authentication attempts.setAuthorizedServicesOnSuccessfulLogin
(boolean authorizedServicesOnSuccessfulLogin) When set totrue
, attempts to calculate and display the list of authorized services for the authenticated user on successful authentication attempts.setCas1
(Cas10ViewProperties cas1) CAS1 views and locations.setCas2
(Cas20ViewProperties cas2) CAS2 views and locations.setCas3
(Cas30ViewProperties cas3) CAS3 views and locations.setCustomLoginFormFields
(Map<String, CustomLoginFieldViewProperties> customLoginFormFields) Additional custom fields that should be displayed on the login form and would be bound to the authentication credential during form-authentication to carry additional metadata and tags.setDefaultRedirectUrl
(String defaultRedirectUrl) The default redirect URL if none is specified after a successful login or logout event.setRest
(RestfulViewProperties rest) Resolve CAS views via REST.setTemplatePrefixes
(List<String> templatePrefixes) Comma separated paths to where CAS templates may be found.setThemeSourceType
(ViewProperties.ThemeSourceTypes themeSourceType) How to search for theme resource bundles and how to deal with multiple property files found for a given theme.
-
Constructor Details
-
ViewProperties
public ViewProperties()
-
-
Method Details
-
isAuthorizedServicesOnSuccessfulLogin
public boolean isAuthorizedServicesOnSuccessfulLogin()When set totrue
, attempts to calculate and display the list of authorized services for the authenticated user on successful authentication attempts. -
getDefaultRedirectUrl
The default redirect URL if none is specified after a successful login or logout event. For logout redirects, this setting is closely related to and requiresLogoutProperties.isFollowServiceRedirects()
. This URL must be registered i the CAS server's service registry. -
getCustomLoginFormFields
Additional custom fields that should be displayed on the login form and would be bound to the authentication credential during form-authentication to carry additional metadata and tags. Key is the name of the custom field. -
getTemplatePrefixes
Comma separated paths to where CAS templates may be found. Example might beclasspath:templates,file:/templates
. -
getThemeSourceType
How to search for theme resource bundles and how to deal with multiple property files found for a given theme. TheViewProperties.ThemeSourceTypes.DEFAULT
type uses the first theme resource bundle found across the template prefixes. TheViewProperties.ThemeSourceTypes.AGGREGATE
type combines all the bundles found across template prefixes with the last prefix overriding the first. -
getCas1
CAS1 views and locations. -
getCas2
CAS2 views and locations. -
getCas3
CAS3 views and locations. -
getRest
Resolve CAS views via REST. -
setAuthorizedServicesOnSuccessfulLogin
public ViewProperties setAuthorizedServicesOnSuccessfulLogin(boolean authorizedServicesOnSuccessfulLogin) When set totrue
, attempts to calculate and display the list of authorized services for the authenticated user on successful authentication attempts.- Returns:
this
.
-
setDefaultRedirectUrl
The default redirect URL if none is specified after a successful login or logout event. For logout redirects, this setting is closely related to and requiresLogoutProperties.isFollowServiceRedirects()
. This URL must be registered i the CAS server's service registry.- Returns:
this
.
-
setCustomLoginFormFields
public ViewProperties setCustomLoginFormFields(Map<String, CustomLoginFieldViewProperties> customLoginFormFields) Additional custom fields that should be displayed on the login form and would be bound to the authentication credential during form-authentication to carry additional metadata and tags. Key is the name of the custom field.- Returns:
this
.
-
setTemplatePrefixes
Comma separated paths to where CAS templates may be found. Example might beclasspath:templates,file:/templates
.- Returns:
this
.
-
setThemeSourceType
How to search for theme resource bundles and how to deal with multiple property files found for a given theme. TheViewProperties.ThemeSourceTypes.DEFAULT
type uses the first theme resource bundle found across the template prefixes. TheViewProperties.ThemeSourceTypes.AGGREGATE
type combines all the bundles found across template prefixes with the last prefix overriding the first.- Returns:
this
.
-
setCas1
CAS1 views and locations.- Returns:
this
.
-
setCas2
CAS2 views and locations.- Returns:
this
.
-
setCas3
CAS3 views and locations.- Returns:
this
.
-
setRest
Resolve CAS views via REST.- Returns:
this
.
-