Package org.apereo.cas.configuration.model.support.pac4j

Class Pac4jBaseClientProperties

java.lang.Object
org.apereo.cas.configuration.model.support.pac4j.Pac4jBaseClientProperties
All Implemented Interfaces:
Serializable, CasFeatureModule
Direct Known Subclasses:
Pac4jCasClientProperties, Pac4jIdentifiableClientProperties, Pac4jSamlClientProperties
@RequiresModule(name="cas-server-support-pac4j-webflow") public class Pac4jBaseClientProperties extends Object implements CasFeatureModule, Serializable
This is Pac4jBaseClientProperties.
Since:
5.3.0
See Also:

  • Constructor Details

    • Pac4jBaseClientProperties

      public Pac4jBaseClientProperties()

  • Method Details

    • getClientName

      public String getClientName()
      Name of the client mostly for UI purposes and uniqueness. This name, with 'non-word' characters converted to '-' (e.g. "This Org (New)" becomes "This-Org--New-") is added to the "class" attribute of the redirect link on the login page, to allow for custom styling of individual IdPs (e.g. for an organization logo).

    • getAutoRedirectType

      public DelegationAutoRedirectTypes getAutoRedirectType()
      Auto-redirect to this client.

    • getPrincipalIdAttribute

      public String getPrincipalIdAttribute()
      The attribute found in the identity provider response that may be used to establish the authenticated user and build a profile for CAS.

    • isEnabled

      public boolean isEnabled()
      Whether the client/external identity provider should be considered active and enabled for integration purposes.

    • getCssClass

      public String getCssClass()
      CSS class that should be assigned to this client.

    • getDisplayName

      public String getDisplayName()
      Indicate the title or display name of the client for decoration and client presentation purposes. If left blank, the client original name would be used by default.

    • getCallbackUrlType

      public Pac4jBaseClientProperties.CallbackUrlTypes getCallbackUrlType()
      Determine how the callback url should be resolved. Default is Pac4jBaseClientProperties.CallbackUrlTypes.QUERY_PARAMETER.

    • getCallbackUrl

      public String getCallbackUrl()
      Callback URL to use to return the flow back to the CAS server one the identity provider is successfully done. This may be used at the discretion of the client and its type to build service parameters, redirect URIs, etc. If none is specified, the CAS server's login endpoint will be used as the basis of the final callback url.

    • setClientName

      public Pac4jBaseClientProperties setClientName(String clientName)
      Name of the client mostly for UI purposes and uniqueness. This name, with 'non-word' characters converted to '-' (e.g. "This Org (New)" becomes "This-Org--New-") is added to the "class" attribute of the redirect link on the login page, to allow for custom styling of individual IdPs (e.g. for an organization logo).
      Returns:
      this.

    • setAutoRedirectType

      public Pac4jBaseClientProperties setAutoRedirectType(DelegationAutoRedirectTypes autoRedirectType)
      Auto-redirect to this client.
      Returns:
      this.

    • setPrincipalIdAttribute

      public Pac4jBaseClientProperties setPrincipalIdAttribute(String principalIdAttribute)
      The attribute found in the identity provider response that may be used to establish the authenticated user and build a profile for CAS.
      Returns:
      this.

    • setEnabled

      public Pac4jBaseClientProperties setEnabled(boolean enabled)
      Whether the client/external identity provider should be considered active and enabled for integration purposes.
      Returns:
      this.

    • setCssClass

      public Pac4jBaseClientProperties setCssClass(String cssClass)
      CSS class that should be assigned to this client.
      Returns:
      this.

    • setDisplayName

      public Pac4jBaseClientProperties setDisplayName(String displayName)
      Indicate the title or display name of the client for decoration and client presentation purposes. If left blank, the client original name would be used by default.
      Returns:
      this.

    • setCallbackUrlType

      public Pac4jBaseClientProperties setCallbackUrlType(Pac4jBaseClientProperties.CallbackUrlTypes callbackUrlType)
      Determine how the callback url should be resolved. Default is Pac4jBaseClientProperties.CallbackUrlTypes.QUERY_PARAMETER.
      Returns:
      this.

    • setCallbackUrl

      public Pac4jBaseClientProperties setCallbackUrl(String callbackUrl)
      Callback URL to use to return the flow back to the CAS server one the identity provider is successfully done. This may be used at the discretion of the client and its type to build service parameters, redirect URIs, etc. If none is specified, the CAS server's login endpoint will be used as the basis of the final callback url.
      Returns:
      this.