com.atlassian.asap.api.server.http.RequestAuthenticator Maven / Gradle / Ivy

Go to download
package com.atlassian.asap.api.server.http;

import com.atlassian.asap.api.Jwt;
import com.atlassian.asap.api.exception.AuthenticationFailedException;

/**
 * HTTP servers can use this service to authenticate incoming HTTP requests that include a JWT bearer token in the
 * Authorization header, conforming to the specification of ASAP protocol.
 *
 * @see ASAP Authentication
 */
public interface RequestAuthenticator
{
    /**
     * Authenticates a request by validating the given authorizationHeader according to the conventions.
     * defined in ASAP Specification
     *
     * @param authorizationHeader the value of the 'Authorization' header of the request to validate. This 'Authorization' header
     *                            should contain a JWT with the necessary authentication information
     * @return a valid JWT object corresponding to the claims body of the validated token
     * @throws AuthenticationFailedException if there is a problem validating the token in the header
     */
    Jwt authenticateRequest(String authorizationHeader) throws AuthenticationFailedException;
}