Package org.springframework.security.cas.authentication

Class CasAuthenticationToken.Builder<B extends CasAuthenticationToken.Builder<B>>

java.lang.Object

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

org.springframework.security.cas.authentication.CasAuthenticationToken.Builder<B>

All Implemented Interfaces:

Authentication.Builder<B>

Enclosing class:

CasAuthenticationToken

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

A builder of CasAuthenticationToken instances

Since:

7.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(CasAuthenticationToken token)

Method Summary

Modifier and Type	Method	Description
B	assertion(org.apereo.cas.client.validation.Assertion assertion)	Use this Assertion
CasAuthenticationToken	build()	Build an Authentication instance
B	credentials(@Nullable Object credentials)	Use this credential.
B	key(String key)	Use this key
B	principal(@Nullable Object principal)	Use this principal.
B	userDetails(UserDetails userDetails)	Use this UserDetails

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(CasAuthenticationToken token)

Method Details

key

public B key(String key)

Use this key

Parameters:

key - the key to use

Returns:

the CasAuthenticationToken.Builder for further configurations

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()

credentials

public B credentials(@Nullable Object credentials)

Description copied from interface: Authentication.Builder

Use this credential.

Note that since some credentials are insecure to store, this method is implemented as unsupported by default. Only implement or use this method if you support secure storage of the credential or if your implementation also implements CredentialsContainer and the credentials are thereby erased.

Parameters:

credentials - the credentials to use

Returns:

the Authentication.Builder for additional configuration

See Also:

• Authentication.getCredentials()

userDetails

public B userDetails(UserDetails userDetails)

Use this UserDetails

Parameters:

userDetails - the UserDetails to use

Returns:

the CasAuthenticationToken.Builder for further configurations

assertion

public B assertion(org.apereo.cas.client.validation.Assertion assertion)

Use this Assertion

Parameters:

assertion - the Assertion to use

Returns:

the CasAuthenticationToken.Builder for further configurations

build

public CasAuthenticationToken build()

Description copied from interface: Authentication.Builder

Build an Authentication instance

Returns:

the Authentication instance