• Home
• com.sap.cloud.security
• java-api
• 3.5.5
• source code
• TokenAuthenticator.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.

com.sap.cloud.security.servlet.TokenAuthenticator Maven / Gradle / Ivy

/**
 * SPDX-FileCopyrightText: 2018-2023 SAP SE or an SAP affiliate company and Cloud Security Client Java contributors
 * 

 * SPDX-License-Identifier: Apache-2.0
 */
package com.sap.cloud.security.servlet;

import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;

/**
 * TokenAuthenticator is used to authenticate a user sending servlet requests to a service via token. It produces a
 * {@link TokenAuthenticationResult}. The result contains the necessary information to perform container specific
 * authentication. 

 *
 * See {@code JettyTokenAuthenticator} in the java-security-test library on how this is used with jetty to perform
 * authentication.
 */
public interface TokenAuthenticator {

	/**
	 * Performs the authentication for the given request.
	 *
	 * @param request
	 * 		servlet request.
	 * @param response
	 * 		servlet response.
	 * @return a {@link TokenAuthenticationResult}.
	 */
	TokenAuthenticationResult validateRequest(ServletRequest request, ServletResponse response);
}