Package org.apereo.cas.services

Class BaseRegisteredServiceUsernameAttributeProvider

java.lang.Object

org.apereo.cas.services.BaseRegisteredServiceUsernameAttributeProvider

All Implemented Interfaces:

java.io.Serializable, org.apereo.cas.services.RegisteredServiceUsernameAttributeProvider

Direct Known Subclasses:

AnonymousRegisteredServiceUsernameAttributeProvider, DefaultRegisteredServiceUsernameProvider, GroovyRegisteredServiceUsernameProvider, PrincipalAttributeRegisteredServiceUsernameProvider, ScriptedRegisteredServiceUsernameProvider

public abstract class BaseRegisteredServiceUsernameAttributeProvider
extends java.lang.Object
implements org.apereo.cas.services.RegisteredServiceUsernameAttributeProvider

This is BaseRegisteredServiceUsernameAttributeProvider.

Since:

5.1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BaseRegisteredServiceUsernameAttributeProvider()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	encryptResolvedUsername(org.apereo.cas.authentication.principal.Principal principal, org.apereo.cas.authentication.principal.Service service, org.apereo.cas.services.RegisteredService registeredService, java.lang.String username)	Encrypt resolved username.
void	initialize()	Initializes the registered service with default values for fields that are unspecified.
java.lang.String	resolveUsername(org.apereo.cas.authentication.principal.Principal principal, org.apereo.cas.authentication.principal.Service service, org.apereo.cas.services.RegisteredService registeredService)
protected abstract java.lang.String	resolveUsernameInternal(org.apereo.cas.authentication.principal.Principal principal, org.apereo.cas.authentication.principal.Service service, org.apereo.cas.services.RegisteredService registeredService)	Resolve username internal string.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRegisteredServiceUsernameAttributeProvider

public BaseRegisteredServiceUsernameAttributeProvider()

Method Detail

resolveUsername

public final java.lang.String resolveUsername(org.apereo.cas.authentication.principal.Principal principal,
                                              org.apereo.cas.authentication.principal.Service service,
                                              org.apereo.cas.services.RegisteredService registeredService)

Specified by:

resolveUsername in interface org.apereo.cas.services.RegisteredServiceUsernameAttributeProvider

encryptResolvedUsername

protected java.lang.String encryptResolvedUsername(org.apereo.cas.authentication.principal.Principal principal,
                                                   org.apereo.cas.authentication.principal.Service service,
                                                   org.apereo.cas.services.RegisteredService registeredService,
                                                   java.lang.String username)

Encrypt resolved username.

Parameters:

principal - the principal

service - the service

registeredService - the registered service

username - the username

Returns:

the encrypted username or null

initialize

public void initialize()

Initializes the registered service with default values for fields that are unspecified. Only triggered by JPA.

resolveUsernameInternal

protected abstract java.lang.String resolveUsernameInternal(org.apereo.cas.authentication.principal.Principal principal,
                                                            org.apereo.cas.authentication.principal.Service service,
                                                            org.apereo.cas.services.RegisteredService registeredService)

Resolve username internal string.

Parameters:

principal - the principal

service - the service

registeredService - the registered service

Returns:

the string