io.micronaut.security.oauth2.endpoint.endsession.response.EndSessionCallbackUrlBuilder 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.response;

import io.micronaut.context.annotation.DefaultImplementation;
import io.micronaut.http.HttpRequest;

import java.net.URL;

/**
 * A contract for generating the URL used by OpenID
 * providers to redirect back to after logging the user out.
 *
 * @author James Kleeh
 * @since 1.2.0
 */
@DefaultImplementation(DefaultEndSessionCallbackUrlBuilder.class)
public interface EndSessionCallbackUrlBuilder {

    /**
     * Builds the URL to redirect back to
     *
     * @param originating The originating request
     * @return The URL
     */
    URL build(HttpRequest originating);
}