io.micronaut.security.oauth2.endpoint.endsession.request.EndSessionEndpoint Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2019 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
 *
 * http://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.endsession.request;

import io.micronaut.http.HttpRequest;
import io.micronaut.security.authentication.Authentication;

import javax.annotation.Nullable;

/**
 * Represents the end session endpoint of an OpenID provider.
 *
 * @author Sergio del Amo
 * @since 1.2.0
 */
public interface EndSessionEndpoint {

    /**
     * @param originating The Originating HTTP Request
     * @param authentication The authentication.
     * @return The OpenID provider end session URL.
     */
    @Nullable
    String getUrl(HttpRequest originating, Authentication authentication);
}