Package org.apereo.cas.services

Class BaseRegisteredServiceUsernameAttributeProvider

java.lang.Object

org.apereo.cas.services.BaseRegisteredServiceUsernameAttributeProvider

All Implemented Interfaces:

Serializable, org.apereo.cas.services.RegisteredServiceUsernameAttributeProvider

Direct Known Subclasses:

AnonymousRegisteredServiceUsernameAttributeProvider, DefaultRegisteredServiceUsernameProvider, GroovyRegisteredServiceUsernameProvider, PrincipalAttributeRegisteredServiceUsernameProvider, StaticRegisteredServiceUsernameProvider

public abstract class BaseRegisteredServiceUsernameAttributeProvider
extends 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 String	encryptResolvedUsername(org.apereo.cas.services.RegisteredServiceUsernameProviderContext context, String username)	Encrypt resolved username.
void	initialize()	Initializes the registered service with default values for fields that are unspecified.
protected String	removePatternFromUsernameIfNecessary(String username)
final String	resolveUsername(org.apereo.cas.services.RegisteredServiceUsernameProviderContext context)
protected abstract String	resolveUsernameInternal(org.apereo.cas.services.RegisteredServiceUsernameProviderContext context)	Resolve username internal string.
protected String	scopeUsernameIfNecessary(String resolved)

Methods inherited from class java.lang.Object

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

Constructor Details

BaseRegisteredServiceUsernameAttributeProvider

public BaseRegisteredServiceUsernameAttributeProvider()

Method Details

resolveUsername

public final String resolveUsername(org.apereo.cas.services.RegisteredServiceUsernameProviderContext context)

Specified by:

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

initialize

public void initialize()

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

removePatternFromUsernameIfNecessary

protected String removePatternFromUsernameIfNecessary(String username)

scopeUsernameIfNecessary

protected String scopeUsernameIfNecessary(String resolved)

encryptResolvedUsername

protected String encryptResolvedUsername(org.apereo.cas.services.RegisteredServiceUsernameProviderContext context,
 String username)

Encrypt resolved username.

Parameters:

context - the context

username - the username

Returns:

the encrypted username or null

resolveUsernameInternal

protected abstract String resolveUsernameInternal(org.apereo.cas.services.RegisteredServiceUsernameProviderContext context)

Resolve username internal string.

Parameters:

context - the context

Returns:

the string