org.springframework.security.oauth2.client.endpoint.ReactiveOAuth2AccessTokenResponseClient Maven / Gradle / Ivy
/*
* Copyright 2002-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.oauth2.client.endpoint;
import reactor.core.publisher.Mono;
import org.springframework.security.oauth2.core.AuthorizationGrantType;
import org.springframework.security.oauth2.core.OAuth2AuthorizationException;
import org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse;
/**
* A reactive strategy for "exchanging" an authorization grant credential (e.g.
* an Authorization Code) for an access token credential at the Authorization Server's
* Token Endpoint.
*
* @author Rob Winch
* @since 5.1
* @see AbstractOAuth2AuthorizationGrantRequest
* @see OAuth2AccessTokenResponse
* @see AuthorizationGrantType
* @see Section
* 1.3 Authorization Grant
* @see Section 4.1.3 Access Token Request
* (Authorization Code Grant)
* @see Section 4.1.4 Access Token Response
* (Authorization Code Grant)
*/
@FunctionalInterface
public interface ReactiveOAuth2AccessTokenResponseClient {
/**
* Exchanges the authorization grant credential, provided in the authorization grant
* request, for an access token credential at the Authorization Server's Token
* Endpoint.
* @param authorizationGrantRequest the authorization grant request that contains the
* authorization grant credential
* @return an {@link OAuth2AccessTokenResponse} that contains the
* {@link OAuth2AccessTokenResponse#getAccessToken() access token} credential
* @throws OAuth2AuthorizationException if an error occurs while attempting to
* exchange for the access token credential
*/
Mono getTokenResponse(T authorizationGrantRequest);
}