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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
The callback url types.Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule
CasFeatureModule.FeatureCatalog
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAuto-redirect to this client.Callback URL to use to return the flow back to the CAS server one the identity provider is successfully done.Determine how the callback url should be resolved.Name of the client mostly for UI purposes and uniqueness.CSS class that should be assigned to this client.Indicate the title or display name of the client for decoration and client presentation purposes.The attribute found in the identity provider response that may be used to establish the authenticated user and build a profile for CAS.boolean
Whether the client/external identity provider should be considered active and enabled for integration purposes.setAutoRedirectType
(DelegationAutoRedirectTypes autoRedirectType) Auto-redirect to this client.setCallbackUrl
(String callbackUrl) Callback URL to use to return the flow back to the CAS server one the identity provider is successfully done.setCallbackUrlType
(Pac4jBaseClientProperties.CallbackUrlTypes callbackUrlType) Determine how the callback url should be resolved.setClientName
(String clientName) Name of the client mostly for UI purposes and uniqueness.setCssClass
(String cssClass) CSS class that should be assigned to this client.setDisplayName
(String displayName) Indicate the title or display name of the client for decoration and client presentation purposes.setEnabled
(boolean enabled) Whether the client/external identity provider should be considered active and enabled for integration purposes.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.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apereo.cas.configuration.features.CasFeatureModule
isDefined, isUndefined
-
Constructor Details
-
Pac4jBaseClientProperties
public Pac4jBaseClientProperties()
-
-
Method Details
-
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
Auto-redirect to this client. -
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
CSS class that should be assigned to this client. -
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
Determine how the callback url should be resolved. Default isPac4jBaseClientProperties.CallbackUrlTypes.QUERY_PARAMETER
. -
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
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
Auto-redirect to this client.- Returns:
this
.
-
setPrincipalIdAttribute
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
Whether the client/external identity provider should be considered active and enabled for integration purposes.- Returns:
this
.
-
setCssClass
CSS class that should be assigned to this client.- Returns:
this
.
-
setDisplayName
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 isPac4jBaseClientProperties.CallbackUrlTypes.QUERY_PARAMETER
.- Returns:
this
.
-
setCallbackUrl
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
.
-