Package org.bremersee.security.authentication

Interface PasswordFlowProperties

All Superinterfaces:

AccessTokenRetrieverProperties, ClientCredentialsFlowProperties

All Known Implementing Classes:

AuthProperties.PasswordFlow

public interface PasswordFlowProperties
extends ClientCredentialsFlowProperties

The password flow properties.

Author:

Christian Bremer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PasswordFlowProperties.Builder	The builder implementation.

Method Summary

Modifier and Type	Method	Description
static PasswordFlowProperties.Builder	builder()	Returns a builder for password flow properties.
default org.springframework.util.MultiValueMap<String,String>	createBody()	Create http request body.
default String	createCacheKey()	Create cache key.
default Optional<BasicAuthProperties>	getBasicAuthProperties()	Gets basic auth properties.
String	getPassword()	Gets password.
String	getUsername()	Gets username.

Methods inherited from interface org.bremersee.security.authentication.AccessTokenRetrieverProperties

createCacheKeyHashed, getTokenEndpoint

Methods inherited from interface org.bremersee.security.authentication.ClientCredentialsFlowProperties

getAdditionalProperties, getClientId, getClientSecret

Method Detail

getUsername

String getUsername()

Gets username.

Returns:

the username

getPassword

String getPassword()

Gets password.

Returns:

the password

getBasicAuthProperties

default Optional<BasicAuthProperties> getBasicAuthProperties()

Description copied from interface: AccessTokenRetrieverProperties

Gets basic auth properties.

Specified by:

getBasicAuthProperties in interface AccessTokenRetrieverProperties

Specified by:

getBasicAuthProperties in interface ClientCredentialsFlowProperties

Returns:

the basic auth properties or Optional.empty(), if no basic auth is required

createCacheKey

default String createCacheKey()

Description copied from interface: AccessTokenRetrieverProperties

Create cache key.

Specified by:

createCacheKey in interface AccessTokenRetrieverProperties

Specified by:

createCacheKey in interface ClientCredentialsFlowProperties

Returns:

the cache key

createBody

default org.springframework.util.MultiValueMap<String,String> createBody()

Description copied from interface: AccessTokenRetrieverProperties

Create http request body.

Specified by:

createBody in interface AccessTokenRetrieverProperties

Specified by:

createBody in interface ClientCredentialsFlowProperties

Returns:

the multi value map

builder

static PasswordFlowProperties.Builder builder()

Returns a builder for password flow properties.

Returns:

the builder