org.pac4j.core.profile

Class ProfileHelper

java.lang.Object

org.pac4j.core.profile.ProfileHelper

public final class ProfileHelper
extends java.lang.Object

This class is an helper for profiles.

Since:

1.1.0

Author:

Jerome Leleu

Method Summary

Modifier and Type	Method and Description
static CommonProfile	buildUserProfileByClassCompleteName(java.lang.String completeName) Build a profile by its class name.
static <U extends CommonProfile> java.util.List<U>	flatIntoAProfileList(java.util.Map<java.lang.String,U> profiles) Flat the map of profiles into a list of profiles.
static <U extends CommonProfile> java.util.Optional<U>	flatIntoOneProfile(java.util.Collection<U> profiles) Flat the list of profiles into a single optional profile (skip any anonymous profile unless it's the only one).
static InternalAttributeHandler	getInternalAttributeHandler()
static boolean	isTypedIdOf(java.lang.String id, java.lang.Class<? extends CommonProfile> clazz) Indicate if the user identifier matches this kind of profile.
static CommonProfile	restoreOrBuildProfile(ProfileDefinition<? extends CommonProfile> profileDefinition, java.lang.String typedId, java.util.Map<java.lang.String,java.lang.Object> profileAttributes, java.util.Map<java.lang.String,java.lang.Object> authenticationAttributes, java.lang.Object... parameters) Restore or build a profile.
static java.lang.String	sanitizeIdentifier(UserProfile profile, java.lang.Object id) Sanitize into a string identifier.
static void	setInternalAttributeHandler(InternalAttributeHandler internalAttributeHandler)

Methods inherited from class java.lang.Object

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

Method Detail

isTypedIdOf

public static boolean isTypedIdOf(java.lang.String id,
                                  java.lang.Class<? extends CommonProfile> clazz)

Indicate if the user identifier matches this kind of profile.

Parameters:

id - user identifier

clazz - profile class

Returns:

if the user identifier matches this kind of profile

restoreOrBuildProfile

public static CommonProfile restoreOrBuildProfile(ProfileDefinition<? extends CommonProfile> profileDefinition,
                                                  java.lang.String typedId,
                                                  java.util.Map<java.lang.String,java.lang.Object> profileAttributes,
                                                  java.util.Map<java.lang.String,java.lang.Object> authenticationAttributes,
                                                  java.lang.Object... parameters)

Restore or build a profile.

Parameters:

profileDefinition - the profile definition

typedId - the typed identifier

profileAttributes - The profile attributes. May be null.

authenticationAttributes - The authentication attributes. May be null.

parameters - additional parameters for the profile definition

Returns:

the restored or built profile

buildUserProfileByClassCompleteName

public static CommonProfile buildUserProfileByClassCompleteName(java.lang.String completeName)

Build a profile by its class name.

Parameters:

completeName - the class name

Returns:

the built user profile

flatIntoOneProfile

public static <U extends CommonProfile> java.util.Optional<U> flatIntoOneProfile(java.util.Collection<U> profiles)

Flat the list of profiles into a single optional profile (skip any anonymous profile unless it's the only one).

Type Parameters:

U - the kind of profile

Parameters:

profiles - the list of profiles

Returns:

the (optional) profile

flatIntoAProfileList

public static <U extends CommonProfile> java.util.List<U> flatIntoAProfileList(java.util.Map<java.lang.String,U> profiles)

Flat the map of profiles into a list of profiles.

Type Parameters:

U - the kind of profile

Parameters:

profiles - the map of profiles

Returns:

the list of profiles

sanitizeIdentifier

public static java.lang.String sanitizeIdentifier(UserProfile profile,
                                                  java.lang.Object id)

Sanitize into a string identifier.

Parameters:

profile - the user profile

id - the identifier object

Returns:

the sanitized identifier

getInternalAttributeHandler

public static InternalAttributeHandler getInternalAttributeHandler()

setInternalAttributeHandler

public static void setInternalAttributeHandler(InternalAttributeHandler internalAttributeHandler)