Package org.springframework.security.saml2.provider.service.authentication

Class Saml2Authentication

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.saml2.provider.service.authentication.Saml2Authentication

All Implemented Interfaces:

Serializable, Principal, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer

Direct Known Subclasses:

Saml2AssertionAuthentication

public class Saml2Authentication
extends org.springframework.security.authentication.AbstractAuthenticationToken

An implementation of an AbstractAuthenticationToken that represents an authenticated SAML 2.0 Authentication.

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

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.authentication.AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends org.springframework.security.authentication.AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

Constructor Summary

Constructors

Constructor	Description
Saml2Authentication(Object principal, String saml2Response, Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)
Saml2Authentication(org.springframework.security.core.AuthenticatedPrincipal principal, String saml2Response, Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)	Construct a Saml2Authentication using the provided parameters

Method Summary

Modifier and Type	Method	Description
Object	getCredentials()
Object	getPrincipal()
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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.security.core.Authentication

toBuilder

Methods inherited from interface java.security.Principal

implies

Constructor Details

Saml2Authentication

public Saml2Authentication(org.springframework.security.core.AuthenticatedPrincipal principal,
 String saml2Response,
 Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

Construct a Saml2Authentication using the provided parameters

Parameters:

principal - the logged in user

saml2Response - the SAML 2.0 response used to authenticate the user

authorities - the authorities for the logged in user

Saml2Authentication

public Saml2Authentication(Object principal,
 String saml2Response,
 Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

Method Details

getPrincipal

public Object getPrincipal()

getSaml2Response

public 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 Object getCredentials()