Package google.registry.request.auth

Class RequestAuthenticator

java.lang.Object

google.registry.request.auth.RequestAuthenticator

public class RequestAuthenticator
extends Object

Top-level authentication/authorization class; calls authentication mechanisms as needed.

Constructor Summary

Constructors

Constructor	Description
RequestAuthenticator(com.google.common.collect.ImmutableList<AuthenticationMechanism> apiAuthenticationMechanisms, LegacyAuthenticationMechanism legacyAuthenticationMechanism)

Method Summary

Modifier and Type	Method	Description
Optional<AuthResult>	authorize(AuthSettings auth, jakarta.servlet.http.HttpServletRequest req)	Attempts to authenticate and authorize the user, according to the settings of the action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RequestAuthenticator

@Inject
public RequestAuthenticator(com.google.common.collect.ImmutableList<AuthenticationMechanism> apiAuthenticationMechanisms,
 LegacyAuthenticationMechanism legacyAuthenticationMechanism)

Method Details

authorize

public Optional<AuthResult> authorize(AuthSettings auth,
 jakarta.servlet.http.HttpServletRequest req)

Attempts to authenticate and authorize the user, according to the settings of the action.

Parameters:

auth - the auth settings of the action, which determine what authentication and authorization are allowed

req - the HttpServletRequest; some authentication mechanisms use HTTP headers

Returns:

an authentication result if authentication/authorization was successful, or absent() if not; authentication can be "successful" even without any authentication if the action's auth settings are set to NONE -- in this case, NOT_AUTHENTICATED is returned