org.apereo.cas.integration.pac4j.authentication.handler.support

Class AbstractPac4jAuthenticationHandler

java.lang.Object

org.apereo.cas.authentication.AbstractAuthenticationHandler

org.apereo.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

org.apereo.cas.integration.pac4j.authentication.handler.support.AbstractPac4jAuthenticationHandler

All Implemented Interfaces:

org.apereo.cas.authentication.AuthenticationHandler, org.apereo.cas.authentication.PrePostAuthenticationHandler, org.springframework.core.Ordered

Direct Known Subclasses:

AbstractWrapperAuthenticationHandler

public abstract class AbstractPac4jAuthenticationHandler
extends org.apereo.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

Abstract pac4j authentication handler which builds the CAS handler result from the pac4j user profile.

Since:

4.1.0

Field Summary

Fields inherited from class org.apereo.cas.authentication.AbstractAuthenticationHandler

credentialSelectionPredicate, principalFactory, servicesManager

Fields inherited from interface org.apereo.cas.authentication.AuthenticationHandler

SUCCESSFUL_AUTHENTICATION_HANDLERS

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractPac4jAuthenticationHandler(java.lang.String name, org.apereo.cas.services.ServicesManager servicesManager, org.apereo.cas.authentication.principal.PrincipalFactory principalFactory, java.lang.Integer order)

Method Summary

Modifier and Type	Method and Description
protected org.apereo.cas.authentication.AuthenticationHandlerExecutionResult	createResult(org.apereo.cas.authentication.principal.ClientCredential credentials, org.pac4j.core.profile.UserProfile profile, org.pac4j.core.client.BaseClient client) Build the handler result.
protected java.lang.String	determinePrincipalIdFrom(org.pac4j.core.profile.UserProfile profile, org.pac4j.core.client.BaseClient client) Determine principal id from profile.
protected void	storeUserProfile(org.pac4j.core.context.WebContext webContext, org.pac4j.core.profile.CommonProfile profile) Store user profile.

Methods inherited from class org.apereo.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

authenticate, createHandlerResult, createHandlerResult, doAuthentication

Methods inherited from class org.apereo.cas.authentication.AbstractAuthenticationHandler

getCredentialSelectionPredicate, getName, getOrder, getPrincipalFactory, getServicesManager, setCredentialSelectionPredicate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apereo.cas.authentication.PrePostAuthenticationHandler

postAuthenticate, preAuthenticate

Methods inherited from interface org.apereo.cas.authentication.AuthenticationHandler

getName, getOrder, supports

Constructor Detail

AbstractPac4jAuthenticationHandler

public AbstractPac4jAuthenticationHandler(java.lang.String name,
                                          org.apereo.cas.services.ServicesManager servicesManager,
                                          org.apereo.cas.authentication.principal.PrincipalFactory principalFactory,
                                          java.lang.Integer order)

Method Detail

createResult

protected org.apereo.cas.authentication.AuthenticationHandlerExecutionResult createResult(org.apereo.cas.authentication.principal.ClientCredential credentials,
                                                                                          org.pac4j.core.profile.UserProfile profile,
                                                                                          org.pac4j.core.client.BaseClient client)
                                                                                   throws java.security.GeneralSecurityException

Build the handler result.

Parameters:

credentials - the provided credentials

profile - the retrieved user profile

client - the client

Returns:

the built handler result

Throws:

java.security.GeneralSecurityException - On authentication failure.

determinePrincipalIdFrom

protected java.lang.String determinePrincipalIdFrom(org.pac4j.core.profile.UserProfile profile,
                                                    org.pac4j.core.client.BaseClient client)

Determine principal id from profile.

Parameters:

profile - the profile

client - the client

Returns:

the id

storeUserProfile

protected void storeUserProfile(org.pac4j.core.context.WebContext webContext,
                                org.pac4j.core.profile.CommonProfile profile)

Store user profile.

Parameters:

webContext - the web context

profile - the profile