org.springframework.security.oauth2.client.endpoint.AbstractOAuth2AuthorizationGrantRequest Maven / Gradle / Ivy
/*
* Copyright 2002-2021 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 org.springframework.security.oauth2.client.registration.ClientRegistration;
import org.springframework.security.oauth2.core.AuthorizationGrantType;
import org.springframework.util.Assert;
/**
* Base implementation of an OAuth 2.0 Authorization Grant request that holds an
* authorization grant credential and is used when initiating a request to the
* Authorization Server's Token Endpoint.
*
* @author Joe Grandja
* @since 5.0
* @see AuthorizationGrantType
* @see ClientRegistration
* @see Section
* 1.3 Authorization Grant
*/
public abstract class AbstractOAuth2AuthorizationGrantRequest {
private final AuthorizationGrantType authorizationGrantType;
private final ClientRegistration clientRegistration;
/**
* Sub-class constructor.
* @param authorizationGrantType the authorization grant type
* @deprecated Use
* {@link #AbstractOAuth2AuthorizationGrantRequest(AuthorizationGrantType, ClientRegistration)}
* instead
*/
@Deprecated
protected AbstractOAuth2AuthorizationGrantRequest(AuthorizationGrantType authorizationGrantType) {
Assert.notNull(authorizationGrantType, "authorizationGrantType cannot be null");
this.authorizationGrantType = authorizationGrantType;
this.clientRegistration = null;
}
/**
* Sub-class constructor.
* @param authorizationGrantType the authorization grant type
* @param clientRegistration the client registration
* @since 5.5
*/
protected AbstractOAuth2AuthorizationGrantRequest(AuthorizationGrantType authorizationGrantType,
ClientRegistration clientRegistration) {
Assert.notNull(authorizationGrantType, "authorizationGrantType cannot be null");
Assert.notNull(clientRegistration, "clientRegistration cannot be null");
this.authorizationGrantType = authorizationGrantType;
this.clientRegistration = clientRegistration;
}
/**
* Returns the authorization grant type.
* @return the authorization grant type
*/
public AuthorizationGrantType getGrantType() {
return this.authorizationGrantType;
}
/**
* Returns the {@link ClientRegistration client registration}.
* @return the {@link ClientRegistration}
* @since 5.5
*/
public ClientRegistration getClientRegistration() {
return this.clientRegistration;
}
}