Class UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder

java.lang.Object

org.springframework.vault.authentication.UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder

Enclosing class:

UsernamePasswordAuthenticationOptions

public static class UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder
extends Object

Builder for UsernamePasswordAuthenticationOptions.

Since:

2.4

Author:

Mikhael Sokolov, Mark Paluch

Method Summary

Modifier and Type	Method	Description
UsernamePasswordAuthenticationOptions	build()	Build a new UsernamePasswordAuthenticationOptions instance.
UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder	password(CharSequence password)	Configure a password for userpass authentication.
UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder	path(String path)	Configure the mount path.
UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder	totp(CharSequence totp)	Configure an optional totp (time-based one-time token) for userpass/Okta authentication.
UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder	username(String username)	Configure a username for userpass authentication.

Methods inherited from class Object

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

Method Details

username

public UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder username(String username)

Configure a username for userpass authentication.

Parameters:

username - must not be empty or null.

Returns:

this UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder.

password

public UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder password(CharSequence password)

Configure a password for userpass authentication.

Parameters:

password - must not be null.

Returns:

this UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder.

totp

public UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder totp(CharSequence totp)

Configure an optional totp (time-based one-time token) for userpass/Okta authentication.

Parameters:

totp - must not be null.

Returns:

this UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder.

path

public UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder path(String path)

Configure the mount path.

Parameters:

path - must not be null or empty.

Returns:

this UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder.

build

public UsernamePasswordAuthenticationOptions build()

Build a new UsernamePasswordAuthenticationOptions instance.

Returns:

a new UsernamePasswordAuthenticationOptions.