Class GitHubAuthenticationOptions

java.lang.Object

org.springframework.vault.authentication.GitHubAuthenticationOptions

public class GitHubAuthenticationOptions
extends Object

Authentication options for GitHubAuthentication.

Authentication options provide the role and the token. GitHubAuthenticationOptions can be constructed using builder(). Instances of this class are immutable once constructed.

Since:

3.2

Author:

Nanne Baars

See Also:

• GitHubAuthentication
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubAuthenticationOptions.GithubAuthenticationOptionsBuilder	Builder for GitHubAuthenticationOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_GITHUB_AUTHENTICATION_PATH

Method Summary

Modifier and Type	Method	Description
static GitHubAuthenticationOptions.GithubAuthenticationOptionsBuilder	builder()
String	getPath()
Supplier<String>	getTokenSupplier()

Methods inherited from class Object

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

Field Details

DEFAULT_GITHUB_AUTHENTICATION_PATH

public static final String DEFAULT_GITHUB_AUTHENTICATION_PATH

See Also:

• Constant Field Values

Method Details

builder

public static GitHubAuthenticationOptions.GithubAuthenticationOptionsBuilder builder()

Returns:

a new GitHubAuthenticationOptions.

getTokenSupplier

public Supplier<String> getTokenSupplier()

Returns:

access token to use.

getPath

public String getPath()

Returns:

the path of the GitHub authentication backend mount.