io.buji.pac4j.subject

Class Pac4jPrincipal

java.lang.Object

io.buji.pac4j.subject.Pac4jPrincipal

All Implemented Interfaces:

Serializable, Principal

public class Pac4jPrincipal
extends Object
implements Principal, Serializable

A principal created by Pac4JRealm that wraps a CommonProfile.

Since:

2.0.0

Author:

Jerome Leleu

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Pac4jPrincipal(List<org.pac4j.core.profile.CommonProfile> profiles) Construct a Pac4jPrincipal.
Pac4jPrincipal(List<org.pac4j.core.profile.CommonProfile> profiles, String principalNameAttribute) Construct a Pac4jPrincipal and specify which attribute in the CommonProfile should be used for the principal name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getName() Returns a name for the principal based upon one of the attributes of the main CommonProfile.
org.pac4j.core.profile.CommonProfile	getProfile() Get the main profile of the authenticated user.
List<org.pac4j.core.profile.CommonProfile>	getProfiles() Get all the profiles of the authenticated user.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Constructor Detail

Pac4jPrincipal

public Pac4jPrincipal(List<org.pac4j.core.profile.CommonProfile> profiles)

Construct a Pac4jPrincipal. The principal name returned will be CommonProfile.getId().

Parameters:

profiles - A list containing all of the CommonProfiles created by Pac4j authorization.

Pac4jPrincipal

public Pac4jPrincipal(List<org.pac4j.core.profile.CommonProfile> profiles,
                      String principalNameAttribute)

Construct a Pac4jPrincipal and specify which attribute in the CommonProfile should be used for the principal name.

Parameters:

profiles - A list containing all of the CommonProfiles created by Pac4j authorization.

principalNameAttribute - The attribute name in the CommonProfile that holds the principal name. A null or blank value means that CommonProfile.getId() should be used as the principal name.

Method Detail

getProfile

public org.pac4j.core.profile.CommonProfile getProfile()

Get the main profile of the authenticated user.

Returns:

the main profile

getProfiles

public List<org.pac4j.core.profile.CommonProfile> getProfiles()

Get all the profiles of the authenticated user.

Returns:

the list of profiles

equals

public boolean equals(Object o)

Specified by:

equals in interface Principal

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

getName

public String getName()

Returns a name for the principal based upon one of the attributes of the main CommonProfile. The attribute name used to query the CommonProfile is specified in the constructor.

Specified by:

getName in interface Principal

Returns:

a name for the Principal or null if the attribute is not populated.

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object