org.cloudfoundry.reactor.tokenprovider

Class AbstractUaaTokenProvider

java.lang.Object

org.cloudfoundry.reactor.tokenprovider.AbstractUaaTokenProvider

All Implemented Interfaces:

TokenProvider

Direct Known Subclasses:

ClientCredentialsGrantTokenProvider, OneTimePasscodeTokenProvider, PasswordGrantTokenProvider, RefreshTokenGrantTokenProvider

public abstract class AbstractUaaTokenProvider
extends Object
implements TokenProvider

An abstract base class for all token providers that interact with the UAA. It encapsulates the logic to refresh the token before expiration.

Constructor Summary

Constructors

Constructor and Description
AbstractUaaTokenProvider()

Method Summary

Modifier and Type	Method and Description
String	getClientId() The client id.
String	getClientSecret() The client secret.
Flux<String>	getRefreshTokens(ConnectionContext connectionContext) Returns a Flux of refresh tokens for a connection
Mono<String>	getToken(ConnectionContext connectionContext) Provides an OAuth token to be used by requests
void	invalidate(ConnectionContext connectionContext) Called when a 401 UNAUTHORIZED is received as part of a request.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUaaTokenProvider

public AbstractUaaTokenProvider()

Method Detail

getClientId

@Value.Default
public String getClientId()

The client id. Defaults to cf.

getClientSecret

@Value.Default
public String getClientSecret()

The client secret. Defaults to "".

getRefreshTokens

public Flux<String> getRefreshTokens(ConnectionContext connectionContext)

Returns a Flux of refresh tokens for a connection

Parameters:

connectionContext - A ConnectionContext to be used to identity which connection the refresh tokens be retrieved for

Returns:

a Flux that emits the last token on subscribe and new refresh tokens as they are negotiated

getToken

public final Mono<String> getToken(ConnectionContext connectionContext)

Description copied from interface: TokenProvider

Provides an OAuth token to be used by requests

Specified by:

getToken in interface TokenProvider

Parameters:

connectionContext - A ConnectionContext to be used if a token needs to be retrieved via a network request

Returns:

an OAuth token

invalidate

public void invalidate(ConnectionContext connectionContext)

Description copied from interface: TokenProvider

Called when a 401 UNAUTHORIZED is received as part of a request. Since not all TokenProviders care about this possibility, the default implementation does nothing. Implementations are free to manage internal state with this call if they choose to.

Specified by:

invalidate in interface TokenProvider

Parameters:

connectionContext - A ConnectionContext to be used to identity which connection the tokens should be invalidated for