io.micronaut.security.oauth2.client.clientcredentials.ClientCredentialsClient 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.client.clientcredentials;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.security.oauth2.endpoint.token.response.TokenResponse;
import org.reactivestreams.Publisher;

/**
 * @author Sergio del Amo
 * @since 2.2.0
 */
public interface ClientCredentialsClient {

    /**
     *
     * @param scope Requested scope values for the access token.
     * @return Response of an authorization server to a valid client credentials request.
     */
    @NonNull
    Publisher requestToken(@Nullable String scope);

    /**
     *
     * @param scope Requested scope values for the access token.
     * @param force true to invalidate the cached token response and fetch a new one
     * @return Response of an authorization server to a valid client credentials request.
     */
    @NonNull
    Publisher requestToken(@Nullable String scope, boolean force);

    /**
     *
     * @return Response of an authorization server to a valid client credentials request.
     */
    @NonNull
    default Publisher requestToken() {
        return requestToken(null);
    }

    /**
     * @param force true to invalidate the cached token response and fetch a new one
     * @return Response of an authorization server to a valid client credentials request.
     */
    @NonNull
    default Publisher requestToken(boolean force) {
        return requestToken(null, force);
    }
}