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

import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.security.authentication.Authentication;
import java.util.Optional;

/**
 * Extends the {@link OauthClient} with OpenID specific functionality.
 *
 * @see OauthClient
 * @author James Kleeh
 * @since 1.2.0
 */
public interface OpenIdClient extends OauthClient {

    /**
     * @return True if this client supports end session
     */
    boolean supportsEndSession();

    /**
     * Redirects to the end session endpoint of an OpenID
     * provider. Returns an empty optional if the provider
     * does not support end session or an {@link io.micronaut.security.oauth2.endpoint.endsession.request.EndSessionEndpoint}
     * could not be resolved for the provider.
     *
     * @param request The current request
     * @param authentication The current authentication
     * @return An optional response
     */
    Optional> endSessionRedirect(HttpRequest request, Authentication authentication);
}