io.micronaut.security.oauth2.endpoint.token.request.context.ClientCredentialsTokenRequestContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-security-oauth2 Show documentation
Official Security Solution for Micronaut
There is a newer version: 4.11.1
Show newest version
/*
 * Copyright 2017-2023 original 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 io.micronaut.security.oauth2.endpoint.token.request.context;

import io.micronaut.core.type.Argument;
import io.micronaut.http.MediaType;
import io.micronaut.security.oauth2.client.clientcredentials.ClientCredentialsConfiguration;
import io.micronaut.security.oauth2.configuration.OauthClientConfiguration;
import io.micronaut.security.oauth2.endpoint.SecureEndpoint;
import io.micronaut.security.oauth2.endpoint.token.response.TokenErrorResponse;
import io.micronaut.security.oauth2.endpoint.token.response.TokenResponse;
import io.micronaut.security.oauth2.grants.ClientCredentialsGrant;
import java.util.Collections;
import java.util.Map;

/**
 * A token request context for sending a client credentials request to an OAuth 2.0 provider.
 *
 * @author Sergio del Amo
 * @version 2.1.0
 */
public class ClientCredentialsTokenRequestContext extends AbstractTokenRequestContext, TokenResponse> {
    private final ClientCredentialsGrant grant;
    private final Map additionalRequestParams;

    /**
     * @param scope requested scopes
     * @param tokenEndpoint The token endpoint
     * @param clientConfiguration The client configuration
     */
    public ClientCredentialsTokenRequestContext(String scope,
                                                SecureEndpoint tokenEndpoint,
                                                OauthClientConfiguration clientConfiguration) {
        super(MediaType.APPLICATION_FORM_URLENCODED_TYPE, tokenEndpoint, clientConfiguration);
        ClientCredentialsGrant clientCredentialsGrant = new ClientCredentialsGrant();
        clientCredentialsGrant.setScope(scope);
        this.grant = clientCredentialsGrant;
        this.additionalRequestParams = clientConfiguration.getClientCredentials().map(ClientCredentialsConfiguration::getAdditionalRequestParams).orElseGet(Collections::emptyMap);
    }

    /**
     * @param clientConfiguration The client configuration
     */
    public ClientCredentialsTokenRequestContext(OauthClientConfiguration clientConfiguration) {
        super(MediaType.APPLICATION_FORM_URLENCODED_TYPE, clientConfiguration.getTokenEndpoint(), clientConfiguration);
        this.grant = new ClientCredentialsGrant();
        this.additionalRequestParams = clientConfiguration.getClientCredentials().map(ClientCredentialsConfiguration::getAdditionalRequestParams).orElseGet(Collections::emptyMap);
    }

    /**
     * @param scope requested scopes
     * @param clientConfiguration The client configuration
     */
    public ClientCredentialsTokenRequestContext(String scope, OauthClientConfiguration clientConfiguration) {
        super(MediaType.APPLICATION_FORM_URLENCODED_TYPE, clientConfiguration.getTokenEndpoint(), clientConfiguration);
        this.grant = new ClientCredentialsGrant();
        this.grant.setScope(scope);
        this.additionalRequestParams = clientConfiguration.getClientCredentials().map(ClientCredentialsConfiguration::getAdditionalRequestParams).orElseGet(Collections::emptyMap);
    }

    @Override
    public Map getGrant() {
        Map grantMap = grant.toMap();
        grantMap.putAll(additionalRequestParams);
        return grantMap;
    }

    @Override
    public Argument getResponseType() {
        return Argument.of(TokenResponse.class);
    }

    @Override
    public Argument getErrorResponseType() {
        return Argument.of(TokenErrorResponse.class);
    }
}