io.micronaut.security.oauth2.client.clientcredentials.ClientCredentialsConfiguration 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.util.Toggleable;
import io.micronaut.http.util.OutgoingRequestProcessorMatcher;
import io.micronaut.security.oauth2.client.clientcredentials.propagation.ClientCredentialsHeaderTokenPropagatorConfiguration;
import java.time.Duration;
import java.util.Map;
import java.util.Optional;

/**
 * Client credentials configuration.
 *
 * @author Sergio del Amo
 * @since 2.2.0
 */
public interface ClientCredentialsConfiguration extends Toggleable, OutgoingRequestProcessorMatcher {

    /**
     *
     * @return Scope to be requested in the client credentials request.
     */
    @NonNull
    Optional getScope();

    /**
     *
     * @return The amount of time for a token obtained via client credentials grant to
     * be considered expired prior to its expiration date.
     */
    @NonNull
    Duration getAdvancedExpiration();

    @NonNull
    Optional getHeaderPropagation();

    @NonNull
    Map getAdditionalRequestParams();
}