• Home
• org.eclipse.edc
• auth-spi
• 0.9.0
• source code
• AuthenticationService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.eclipse.edc.api.auth.spi.AuthenticationService Maven / Gradle / Ivy

/*
 *  Copyright (c) 2020 - 2022 Microsoft Corporation
 *
 *  This program and the accompanying materials are made available under the
 *  terms of the Apache License, Version 2.0 which is available at
 *  https://www.apache.org/licenses/LICENSE-2.0
 *
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Contributors:
 *       Microsoft Corporation - initial API and implementation
 *
 */

package org.eclipse.edc.api.auth.spi;

import org.eclipse.edc.runtime.metamodel.annotation.ExtensionPoint;
import org.eclipse.edc.web.spi.exception.AuthenticationFailedException;

import java.util.List;
import java.util.Map;

@FunctionalInterface
@ExtensionPoint
public interface AuthenticationService {

    /**
     * Checks whether a particular request can be authenticated.
     *
     * @param headers The headers, that contain the credential to be used, e.g. a token, Basic-Auth header, etc.
     * @throws AuthenticationFailedException when the credential passed was not acceptable (e.g. null, empty, invalid base64)
     */
    boolean isAuthenticated(Map> headers);
}