Package org.apereo.cas.configuration.model.core.web.view

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:

  • Constructor Details

    • ViewProperties

      public ViewProperties()

  • Method Details

    • isAuthorizedServicesOnSuccessfulLogin

      public boolean isAuthorizedServicesOnSuccessfulLogin()
      When set to true, attempts to calculate and display the list of authorized services for the authenticated user on successful authentication attempts.

    • getDefaultRedirectUrl

      public String 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 requires LogoutProperties.isFollowServiceRedirects(). This URL must be registered i the CAS server's service registry.

    • getCustomLoginFormFields

      public Map<String,CustomLoginFieldViewProperties> 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

      public List<String> getTemplatePrefixes()
      Comma separated paths to where CAS templates may be found. Example might be classpath:templates,file:/templates.

    • getThemeSourceType

      public ViewProperties.ThemeSourceTypes getThemeSourceType()
      How to search for theme resource bundles and how to deal with multiple property files found for a given theme. The ViewProperties.ThemeSourceTypes.DEFAULT type uses the first theme resource bundle found across the template prefixes. The ViewProperties.ThemeSourceTypes.AGGREGATE type combines all the bundles found across template prefixes with the last prefix overriding the first.

    • getCas1

      public Cas10ViewProperties getCas1()
      CAS1 views and locations.

    • getCas2

      public Cas20ViewProperties getCas2()
      CAS2 views and locations.

    • getCas3

      public Cas30ViewProperties getCas3()
      CAS3 views and locations.

    • getRest

      public RestfulViewProperties getRest()
      Resolve CAS views via REST.

    • setAuthorizedServicesOnSuccessfulLogin

      public ViewProperties setAuthorizedServicesOnSuccessfulLogin(boolean authorizedServicesOnSuccessfulLogin)
      When set to true, attempts to calculate and display the list of authorized services for the authenticated user on successful authentication attempts.
      Returns:
      this.

    • setDefaultRedirectUrl

      public ViewProperties setDefaultRedirectUrl(String defaultRedirectUrl)
      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 requires LogoutProperties.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

      public ViewProperties setTemplatePrefixes(List<String> templatePrefixes)
      Comma separated paths to where CAS templates may be found. Example might be classpath:templates,file:/templates.
      Returns:
      this.

    • setThemeSourceType

      public ViewProperties setThemeSourceType(ViewProperties.ThemeSourceTypes themeSourceType)
      How to search for theme resource bundles and how to deal with multiple property files found for a given theme. The ViewProperties.ThemeSourceTypes.DEFAULT type uses the first theme resource bundle found across the template prefixes. The ViewProperties.ThemeSourceTypes.AGGREGATE type combines all the bundles found across template prefixes with the last prefix overriding the first.
      Returns:
      this.

    • setCas1

      public ViewProperties setCas1(Cas10ViewProperties cas1)
      CAS1 views and locations.
      Returns:
      this.

    • setCas2

      public ViewProperties setCas2(Cas20ViewProperties cas2)
      CAS2 views and locations.
      Returns:
      this.

    • setCas3

      public ViewProperties setCas3(Cas30ViewProperties cas3)
      CAS3 views and locations.
      Returns:
      this.

    • setRest

      public ViewProperties setRest(RestfulViewProperties rest)
      Resolve CAS views via REST.
      Returns:
      this.