org.opendaylight.aaa.web.WebContextSecurer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of web-api Show documentation

There is a newer version: 0.20.4

/*
 * Copyright (c) 2018 Red Hat, Inc. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.aaa.web;

/**
 * Secures a {@link WebContextBuilder}.
 *
 * @author Michael Vorburger.ch
 */
public interface WebContextSecurer {
    /**
     * Configures the WebContext in an implementation specific manner so that it requires authentication to access the
     * given URL Patterns. Typically, this will be done by adding a {@code javax.servlet.Filter} (or several, and
     * whatever else they need).
     *
     * @param webContextBuilder builder to secure
     * @param asyncSupported true if asynchronous communication should also be supported
     * @param urlPatterns URL patterns that require authentication
     */
    void requireAuthentication(WebContextBuilder webContextBuilder, boolean asyncSupported, String... urlPatterns);

    /**
     * Configures the WebContext in an implementation specific manner so that it requires authentication to access the
     * given URL Patterns. Typically, this will be done by adding a {@code javax.servlet.Filter} (or several, and
     * whatever else they need).
     *
     * 
     * This method is equivalent to {@code requireAuthentication(webContextBuilder, false, urlPatterns}.
     */
    default void requireAuthentication(final WebContextBuilder webContextBuilder, final String... urlPatterns) {
        requireAuthentication(webContextBuilder, false, urlPatterns);
    }

    /**
     * Configures the WebContext so that all its URL patterns ({@code/**}) require authentication.
     * @see #requireAuthentication(WebContextBuilder, String...)
     */
    default void requireAuthentication(final WebContextBuilder webContextBuilder) {
        requireAuthentication(webContextBuilder, "/*");
    }
}