Package org.pac4j.saml.profile
Class SAML2Profile
java.lang.Object
org.pac4j.core.profile.BasicUserProfile
org.pac4j.core.profile.CommonProfile
org.pac4j.saml.profile.SAML2Profile
- All Implemented Interfaces:
Externalizable
,Serializable
,org.pac4j.core.profile.UserProfile
public class SAML2Profile
extends org.pac4j.core.profile.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:
-
Field Summary
Fields inherited from class org.pac4j.core.profile.BasicUserProfile
logger
-
Constructor Summary
ConstructorDescriptionSAML2Profile
(boolean canMergeAttributes) Create a profile with possibility to merge attributes with the same name and collection-type values. -
Method Summary
Modifier and TypeMethodDescriptionvoid
setAuthnContexts
(List<String> authnContexts) void
setIssuerEntityID
(String issuerEntityID) void
setNotBefore
(ZonedDateTime notBefore) void
setNotOnOrAfter
(ZonedDateTime notOnOrAfter) void
setSamlNameIdFormat
(String samlNameIdFormat) void
setSamlNameIdNameQualifier
(String samlNameIdNameQualifier) void
setSamlNameIdSpNameQualifier
(String samlNameIdSpNameQualifier) void
setSamlNameIdSpProviderId
(String samlNameIdSpProviderId) void
setSessionIndex
(String sessionIndex) Methods inherited from class org.pac4j.core.profile.CommonProfile
getAttributeAsDate, getAttributeAsString, getAttributeAsType, getDisplayName, getEmail, getFamilyName, getFirstName, getGender, getLocale, getLocation, getPictureUrl, getProfileUrl, getUsername, isExpired, toString
Methods inherited from class org.pac4j.core.profile.BasicUserProfile
addAttribute, addAttributes, addAuthenticationAttribute, addAuthenticationAttributes, addRole, addRoles, asPrincipal, build, build, containsAttribute, containsAuthenicationAttribute, extractAttributeValues, getAttribute, getAttribute, getAttributes, getAuthenticationAttribute, getAuthenticationAttribute, getAuthenticationAttributes, getClientName, getId, getLinkedId, getRoles, getTypedId, isRemembered, readExternal, removeAttribute, removeAuthenticationAttribute, removeLoginData, setClientName, setId, setLinkedId, setRemembered, setRoles, writeExternal
-
Constructor Details
-
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 Details
-
getNotBefore
-
setNotBefore
-
getNotOnOrAfter
-
setNotOnOrAfter
-
getSessionIndex
-
setSessionIndex
-
getIssuerEntityID
-
setIssuerEntityID
-
getAuthnContexts
-
setAuthnContexts
-
getSamlNameIdFormat
-
setSamlNameIdFormat
-
getSamlNameIdNameQualifier
-
setSamlNameIdNameQualifier
-
getSamlNameIdSpNameQualifier
-
setSamlNameIdSpNameQualifier
-
getSamlNameIdSpProviderId
-
setSamlNameIdSpProviderId
-