org.apache.drill.exec.rpc.user.security

Interface UserAuthenticator

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

HtpasswdFileUserAuthenticator, Pam4jUserAuthenticator, PamUserAuthenticator, VaultUserAuthenticator

public interface UserAuthenticator
extends Closeable

Interface to provide various username/password based implementations for authentication.

Method Summary

Modifier and Type	Method and Description
void	authenticate(String user, String password) Authenticate the given user and password combination.
void	close() Close the authenticator.
void	setup(DrillConfig drillConfig) Setup for authenticating user credentials.

Method Detail

setup

void setup(DrillConfig drillConfig)
    throws DrillbitStartupException

Setup for authenticating user credentials.

Throws:

DrillbitStartupException

authenticate

void authenticate(String user,
                  String password)
           throws UserAuthenticationException

Authenticate the given user and password combination.

Parameters:

user -

password -

Throws:

UserAuthenticationException - if authentication fails for given user and password.

close

void close()
    throws IOException

Close the authenticator. Used to release resources. Ex. LDAP authenticator opens connections to LDAP server, such connections resources are released in a safe manner as part of close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException