org.springframework.security.oauth2.client.endpoint

Class DefaultClientCredentialsTokenResponseClient

java.lang.Object

org.springframework.security.oauth2.client.endpoint.DefaultClientCredentialsTokenResponseClient

All Implemented Interfaces:

OAuth2AccessTokenResponseClient<OAuth2ClientCredentialsGrantRequest>

public class DefaultClientCredentialsTokenResponseClient
extends java.lang.Object
implements OAuth2AccessTokenResponseClient<OAuth2ClientCredentialsGrantRequest>

The default implementation of an OAuth2AccessTokenResponseClient for the client_credentials grant. This implementation uses a RestOperations when requesting an access token credential at the Authorization Server's Token Endpoint.

Since:

5.1

See Also:

OAuth2AccessTokenResponseClient, OAuth2ClientCredentialsGrantRequest, OAuth2AccessTokenResponse, Section 4.4.2 Access Token Request (Client Credentials Grant), Section 4.4.3 Access Token Response (Client Credentials Grant)

Constructor Summary

Constructors

Constructor and Description
DefaultClientCredentialsTokenResponseClient()

Method Summary

Modifier and Type	Method and Description
OAuth2AccessTokenResponse	getTokenResponse(OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest) Exchanges the authorization grant credential, provided in the authorization grant request, for an access token credential at the Authorization Server's Token Endpoint.
void	setRestOperations(org.springframework.web.client.RestOperations restOperations) Sets the RestOperations used when requesting the access token response.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultClientCredentialsTokenResponseClient

public DefaultClientCredentialsTokenResponseClient()

Method Detail

getTokenResponse

public OAuth2AccessTokenResponse getTokenResponse(OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest)
                                           throws OAuth2AuthenticationException

Description copied from interface: OAuth2AccessTokenResponseClient

Exchanges the authorization grant credential, provided in the authorization grant request, for an access token credential at the Authorization Server's Token Endpoint.

Specified by:

getTokenResponse in interface OAuth2AccessTokenResponseClient<OAuth2ClientCredentialsGrantRequest>

Parameters:

clientCredentialsGrantRequest - the authorization grant request that contains the authorization grant credential

Returns:

an OAuth2AccessTokenResponse that contains the access token credential

Throws:

OAuth2AuthenticationException - if an error occurs while attempting to exchange for the access token credential

setRestOperations

public final void setRestOperations(org.springframework.web.client.RestOperations restOperations)

Sets the RestOperations used when requesting the access token response.

Parameters:

restOperations - the RestOperations used when requesting the access token response