Package org.pac4j.saml.profile

Class SAML2Profile

java.lang.Object

org.pac4j.core.profile.UserProfile

org.pac4j.core.profile.CommonProfile

org.pac4j.saml.profile.SAML2Profile

All Implemented Interfaces:

Externalizable, Serializable

public class SAML2Profile
extends CommonProfile

This class is the user profile for sites using SAML2 protocol.

It is returned by the SAML2Client.

Version:

1.5.0

Author:

Michael Remond, Misagh Moayyed, Ruochao Zheng

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pac4j.core.profile.UserProfile

logger, SEPARATOR

Constructor Summary

Constructors

Constructor	Description
SAML2Profile()
SAML2Profile(boolean canMergeAttributes)	Create a profile with possibility to merge attributes with the same name and collection-type values.

Method Summary

Modifier and Type	Method	Description
List<String>	getAuthnContexts()
String	getIssuerEntityID()
org.joda.time.DateTime	getNotBefore()
org.joda.time.DateTime	getNotOnOrAfter()
String	getSamlNameIdFormat()
String	getSamlNameIdNameQualifier()
String	getSamlNameIdSpNameQualifier()
String	getSamlNameIdSpProviderId()
String	getSessionIndex()

Methods inherited from class org.pac4j.core.profile.CommonProfile

asPrincipal, getDisplayName, getEmail, getFamilyName, getFirstName, getGender, getLocale, getLocation, getPictureUrl, getProfileUrl, getUsername, isExpired

Methods inherited from class org.pac4j.core.profile.UserProfile

addAttribute, addAttributes, addAuthenticationAttribute, addAuthenticationAttributes, addPermission, addPermissions, addRole, addRoles, addRoles, build, build, clearSensitiveData, containsAttribute, containsAuthenicationAttribute, getAttribute, getAttribute, getAttributes, getAuthenticationAttribute, getAuthenticationAttribute, getAuthenticationAttributes, getClientName, getId, getLinkedId, getPermissions, getRoles, getTypedId, isRemembered, readExternal, removeAttribute, removeAuthenticationAttribute, setClientName, setId, setLinkedId, setPermissions, setRemembered, setRoles, toString, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

SAML2Profile

public SAML2Profile()

SAML2Profile

public SAML2Profile(boolean canMergeAttributes)

Create a profile with possibility to merge attributes with the same name and collection-type values. In SAML2 it's very important to get full collection of roles which are received in separate single-element collections.

In order to use it you may initialize the client in the following way:

 SAML2Client client = new SAML2Client();
 SAML2ClientConfiguration config = new SAML2ClientConfiguration();
 SAML2Authenticator authenticator = new SAML2Authenticator(config.getAttributeAsId());
 boolean canMergeAttributes = true;
 authenticator.setProfileDefinition(new CommonProfileDefinition<>(x → new SAML2Profile(canMergeAttributes)));
 client.setAuthenticator(authenticator);
 

Parameters:

canMergeAttributes - if true - merge attributes with the same name and collection-type values, if false - overwrite them.

Since:

3.1.0

Method Detail

getNotBefore

public org.joda.time.DateTime getNotBefore()

getNotOnOrAfter

public org.joda.time.DateTime getNotOnOrAfter()

getSessionIndex

public String getSessionIndex()

getIssuerEntityID

public String getIssuerEntityID()

getAuthnContexts

public List<String> getAuthnContexts()

getSamlNameIdFormat

public String getSamlNameIdFormat()

getSamlNameIdNameQualifier

public String getSamlNameIdNameQualifier()

getSamlNameIdSpNameQualifier

public String getSamlNameIdSpNameQualifier()

getSamlNameIdSpProviderId

public String getSamlNameIdSpProviderId()