Class Saml2Authentication
- java.lang.Object
-
- org.springframework.security.authentication.AbstractAuthenticationToken
-
- org.springframework.security.saml2.provider.service.authentication.Saml2Authentication
-
- All Implemented Interfaces:
java.io.Serializable
,java.security.Principal
,org.springframework.security.core.Authentication
,org.springframework.security.core.CredentialsContainer
public class Saml2Authentication extends org.springframework.security.authentication.AbstractAuthenticationToken
An implementation of anAbstractAuthenticationToken
that represents an authenticated SAML 2.0Authentication
.The
Authentication
associates valid SAML assertion data with a Spring Security authentication object The complete assertion is contained in the object in String format,getSaml2Response()
- Since:
- 5.2
- See Also:
AbstractAuthenticationToken
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Saml2Authentication(org.springframework.security.core.AuthenticatedPrincipal principal, java.lang.String saml2Response, java.util.Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)
Construct aSaml2Authentication
using the provided parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
getCredentials()
java.lang.Object
getPrincipal()
java.lang.String
getSaml2Response()
Returns the SAML response object, as decoded XML.-
Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString
-
-
-
-
Constructor Detail
-
Saml2Authentication
public Saml2Authentication(org.springframework.security.core.AuthenticatedPrincipal principal, java.lang.String saml2Response, java.util.Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)
Construct aSaml2Authentication
using the provided parameters- Parameters:
principal
- the logged in usersaml2Response
- the SAML 2.0 response used to authenticate the userauthorities
- the authorities for the logged in user
-
-
Method Detail
-
getPrincipal
public java.lang.Object getPrincipal()
-
getSaml2Response
public java.lang.String getSaml2Response()
Returns the SAML response object, as decoded XML. May contain encrypted elements- Returns:
- string representation of the SAML Response XML object
-
getCredentials
public java.lang.Object getCredentials()
-
-