com.google.gerrit.server.auth.ldap

Class LdapAuthBackend

java.lang.Object

com.google.gerrit.server.auth.ldap.LdapAuthBackend

All Implemented Interfaces:

AuthBackend

public class LdapAuthBackend
extends java.lang.Object
implements AuthBackend

Implementation of AuthBackend for the LDAP authentication system.

Constructor Summary

Constructors

Constructor and Description
LdapAuthBackend(com.google.gerrit.server.auth.ldap.Helper helper, AuthConfig authConfig, org.eclipse.jgit.lib.Config config)

Method Summary

Modifier and Type	Method and Description
AuthUser	authenticate(AuthRequest req) Authenticate inspects the AuthRequest and returns authenticated user.
java.lang.String	getDomain()

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapAuthBackend

@Inject
public LdapAuthBackend(com.google.gerrit.server.auth.ldap.Helper helper,
                               AuthConfig authConfig,
                               org.eclipse.jgit.lib.Config config)

Method Detail

getDomain

public java.lang.String getDomain()

Specified by:

getDomain in interface AuthBackend

Returns:

an identifier that uniquely describes the backend.

authenticate

public AuthUser authenticate(AuthRequest req)
                      throws MissingCredentialsException,
                             InvalidCredentialsException,
                             UnknownUserException,
                             UserNotAllowedException,
                             AuthException

Description copied from interface: AuthBackend

Authenticate inspects the AuthRequest and returns authenticated user. If the request is unable to be authenticated, an exception will be thrown. The MissingCredentialsException must be thrown when there are no credentials for the request. It is expected that at most one AuthBackend will either return an AuthUser or throw a non-MissingCredentialsException.

Specified by:

authenticate in interface AuthBackend

Parameters:

req - the object describing the request.

Returns:

the successfully authenticated user.

Throws:

MissingCredentialsException - when there are no credentials.

InvalidCredentialsException - when the credentials are present and invalid.

UnknownUserException - when the credentials are valid but there is no matching user.

UserNotAllowedException - when the credentials are valid but the user is not allowed.

AuthException - when any other error occurs.