org.springframework.security.oauth2.client.OAuth2AuthorizedClientManager 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;
import org.springframework.lang.Nullable;
import org.springframework.security.oauth2.client.registration.ClientRegistration;
import org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository;
/**
* Implementations of this interface are responsible for the overall management of
* {@link OAuth2AuthorizedClient Authorized Client(s)}.
*
*
* The primary responsibilities include:
*
* - Authorizing (or re-authorizing) an OAuth 2.0 Client by leveraging an
* {@link OAuth2AuthorizedClientProvider}(s).
* - Delegating the persistence of an {@link OAuth2AuthorizedClient}, typically using an
* {@link OAuth2AuthorizedClientService} OR {@link OAuth2AuthorizedClientRepository}.
*
*
* @author Joe Grandja
* @since 5.2
* @see OAuth2AuthorizedClient
* @see OAuth2AuthorizedClientProvider
* @see OAuth2AuthorizedClientService
* @see OAuth2AuthorizedClientRepository
*/
@FunctionalInterface
public interface OAuth2AuthorizedClientManager {
/**
* Attempt to authorize or re-authorize (if required) the {@link ClientRegistration
* client} identified by the provided
* {@link OAuth2AuthorizeRequest#getClientRegistrationId() clientRegistrationId}.
* Implementations must return {@code null} if authorization is not supported for the
* specified client, e.g. the associated {@link OAuth2AuthorizedClientProvider}(s)
* does not support the {@link ClientRegistration#getAuthorizationGrantType()
* authorization grant} type configured for the client.
*
*
* In the case of re-authorization, implementations must return the provided
* {@link OAuth2AuthorizeRequest#getAuthorizedClient() authorized client} if
* re-authorization is not supported for the client OR is not required, e.g. a
* {@link OAuth2AuthorizedClient#getRefreshToken() refresh token} is not available OR
* the {@link OAuth2AuthorizedClient#getAccessToken() access token} is not expired.
* @param authorizeRequest the authorize request
* @return the {@link OAuth2AuthorizedClient} or {@code null} if authorization is not
* supported for the specified client
*/
@Nullable
OAuth2AuthorizedClient authorize(OAuth2AuthorizeRequest authorizeRequest);
}