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

Class Saml2AssertionAuthentication.Builder<B extends Saml2AssertionAuthentication.Builder<B>>

java.lang.Object

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

org.springframework.security.saml2.provider.service.authentication.Saml2AssertionAuthentication.Builder<B>

All Implemented Interfaces:

Authentication.Builder<B>

Enclosing class:

Saml2AssertionAuthentication

public static class Saml2AssertionAuthentication.Builder<B extends Saml2AssertionAuthentication.Builder<B>>
extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>

A builder of Saml2AssertionAuthentication instances

Since:

7.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(Saml2AssertionAuthentication token)

Method Summary

Modifier and Type	Method	Description
Saml2AssertionAuthentication	build()	Build an Authentication instance
B	credentials(@Nullable Object credentials)	Use these credentials.
B	principal(@Nullable Object principal)	Use this principal.
B	relyingPartyRegistrationId(String relyingPartyRegistrationId)	Use this registration id

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken.AbstractAuthenticationBuilder

authenticated, authorities, details

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(Saml2AssertionAuthentication token)

Method Details

credentials

public B credentials(@Nullable Object credentials)

Use these credentials. They must be of type Saml2ResponseAssertionAccessor.

Parameters:

credentials - the credentials to use

Returns:

the Saml2AssertionAuthentication.Builder for further configurations

See Also:

• Authentication.getCredentials()

relyingPartyRegistrationId

public B relyingPartyRegistrationId(String relyingPartyRegistrationId)

Use this registration id

Parameters:

relyingPartyRegistrationId - the RelyingPartyRegistration.getRegistrationId() to use

Returns:

the Saml2AssertionAuthentication.Builder for further configurations

build

public Saml2AssertionAuthentication build()

Description copied from interface: Authentication.Builder

Build an Authentication instance

Returns:

the Authentication instance

principal

public B principal(@Nullable Object principal)

Description copied from interface: Authentication.Builder

Use this principal.

Note that in many cases, the principal is strongly-typed. Implementations may choose to do a type check and are not necessarily expected to allow any object as a principal.

Implementations may choose to use this principal in combination with any principal from the pre-existing Authentication instance.

Parameters:

principal - the principal to use

Returns:

the Authentication.Builder for additional configuration

See Also:

• Authentication.getPrincipal()