org.pac4j.core.profile.definition

Class ProfileDefinition<P extends CommonProfile>

java.lang.Object

org.pac4j.core.profile.definition.ProfileDefinition<P>

Direct Known Subclasses:

CommonProfileDefinition

public abstract class ProfileDefinition<P extends CommonProfile>
extends java.lang.Object

Define a profile (its class and attributes).

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
protected java.util.function.Function<java.lang.Object[],P>	newProfile

Constructor Summary

Constructors

Constructor and Description
ProfileDefinition()

Method Summary

Modifier and Type	Method and Description
void	convertAndAdd(CommonProfile profile, AttributeLocation attributeLocation, java.lang.String name, java.lang.Object value) Convert a profile or authentication attribute, if necessary, and add it to the profile.
void	convertAndAdd(CommonProfile profile, java.util.Map<java.lang.String,java.lang.Object> attributes) Deprecated. Use convertAndAdd(CommonProfile, Map, Map) instead.
void	convertAndAdd(CommonProfile profile, java.util.Map<java.lang.String,java.lang.Object> profileAttributes, java.util.Map<java.lang.String,java.lang.Object> authenticationAttributes) Convert the profile and authentication attributes, if necessary, and add them to the profile.
void	convertAndAdd(CommonProfile profile, java.lang.String name, java.lang.Object value) Deprecated. Use convertAndAdd(CommonProfile, AttributeLocation, String, Object) instead.
protected java.util.Map<java.lang.String,AttributeConverter<? extends java.lang.Object>>	getConverters()
java.util.List<java.lang.String>	getPrimaryAttributes()
java.util.List<java.lang.String>	getSecondaryAttributes()
P	newProfile(java.lang.Object... parameters) Return the new built profile.
protected void	primary(java.lang.String name, AttributeConverter<? extends java.lang.Object> converter) Add an attribute as a primary one and its converter.
protected void	secondary(java.lang.String name, AttributeConverter<? extends java.lang.Object> converter) Add an attribute as a secondary one and its converter.
protected void	setProfileFactory(java.util.function.Function<java.lang.Object[],P> profileFactory) Define the way to build the profile.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

newProfile

protected java.util.function.Function<java.lang.Object[],P extends CommonProfile> newProfile

Constructor Detail

ProfileDefinition

public ProfileDefinition()

Method Detail

newProfile

public P newProfile(java.lang.Object... parameters)

Return the new built profile.

Parameters:

parameters - some optional input parameters

Returns:

the new built profile

convertAndAdd

@Deprecated
public void convertAndAdd(CommonProfile profile,
                                      java.lang.String name,
                                      java.lang.Object value)

Deprecated. Use convertAndAdd(CommonProfile, AttributeLocation, String, Object) instead.

Convert a profile attribute, if necessary, and add it to the profile.

Parameters:

profile - the profile

name - the attribute name

value - the attribute value

convertAndAdd

public void convertAndAdd(CommonProfile profile,
                          AttributeLocation attributeLocation,
                          java.lang.String name,
                          java.lang.Object value)

Convert a profile or authentication attribute, if necessary, and add it to the profile.

Parameters:

profile - The profile.

attributeLocation - Location of the attribute inside the profile: classic profile attribute, authentication attribute, ...

name - The attribute name.

value - The attribute value.

convertAndAdd

@Deprecated
public void convertAndAdd(CommonProfile profile,
                                      java.util.Map<java.lang.String,java.lang.Object> attributes)

Deprecated. Use convertAndAdd(CommonProfile, Map, Map) instead.

Convert the profile attributes, if necessary, and add them to the profile. You may want to use convertAndAdd(CommonProfile, Map, Map) which supports adding authentication attributes.

Parameters:

profile - The profile.

attributes - The profile attributes. May be null.

convertAndAdd

public void convertAndAdd(CommonProfile profile,
                          java.util.Map<java.lang.String,java.lang.Object> profileAttributes,
                          java.util.Map<java.lang.String,java.lang.Object> authenticationAttributes)

Convert the profile and authentication attributes, if necessary, and add them to the profile.

Parameters:

profile - The profile.

profileAttributes - The profile attributes. May be null.

authenticationAttributes - The authentication attributes. May be null.

setProfileFactory

protected void setProfileFactory(java.util.function.Function<java.lang.Object[],P> profileFactory)

Define the way to build the profile.

Parameters:

profileFactory - the way to build the profile

primary

protected void primary(java.lang.String name,
                       AttributeConverter<? extends java.lang.Object> converter)

Add an attribute as a primary one and its converter.

Parameters:

name - name of the attribute

converter - converter

secondary

protected void secondary(java.lang.String name,
                         AttributeConverter<? extends java.lang.Object> converter)

Add an attribute as a secondary one and its converter.

Parameters:

name - name of the attribute

converter - converter

getPrimaryAttributes

public java.util.List<java.lang.String> getPrimaryAttributes()

getSecondaryAttributes

public java.util.List<java.lang.String> getSecondaryAttributes()

getConverters

protected java.util.Map<java.lang.String,AttributeConverter<? extends java.lang.Object>> getConverters()