org.apache.accumulo.server.security.handler

Interface Authenticator

All Known Implementing Classes:

InsecureAuthenticator, KerberosAuthenticator, ZKAuthenticator

public interface Authenticator

This interface is used for the system which will be used for authenticating a user. If the implementation does not support configuration through Accumulo, it should throw an AccumuloSecurityException with the error code UNSUPPORTED_OPERATION

Method Summary

Modifier and Type	Method and Description
boolean	authenticateUser(String principal, AuthenticationToken token)
void	changePassword(String principal, AuthenticationToken token)
void	createUser(String principal, AuthenticationToken token) Creates a user with no initial permissions whatsoever
void	dropUser(String user)
Set<Class<? extends AuthenticationToken>>	getSupportedTokenTypes()
void	initialize(String instanceId, boolean initialize)
void	initializeSecurity(TCredentials credentials, String principal, byte[] token)
Set<String>	listUsers()
boolean	userExists(String user) Checks if a user exists
boolean	validSecurityHandlers(Authorizor auth, PermissionHandler pm)
boolean	validTokenClass(String tokenClass) Returns true if the given token is appropriate for this Authenticator

Method Detail

initialize

void initialize(String instanceId,
                boolean initialize)

validSecurityHandlers

boolean validSecurityHandlers(Authorizor auth,
                              PermissionHandler pm)

initializeSecurity

void initializeSecurity(TCredentials credentials,
                        String principal,
                        byte[] token)
                 throws AccumuloSecurityException,
                        ThriftSecurityException

Throws:

AccumuloSecurityException

ThriftSecurityException

authenticateUser

boolean authenticateUser(String principal,
                         AuthenticationToken token)
                  throws AccumuloSecurityException

Throws:

AccumuloSecurityException

listUsers

Set<String> listUsers()
               throws AccumuloSecurityException

Throws:

AccumuloSecurityException

createUser

void createUser(String principal,
                AuthenticationToken token)
         throws AccumuloSecurityException

Creates a user with no initial permissions whatsoever

Throws:

AccumuloSecurityException

dropUser

void dropUser(String user)
       throws AccumuloSecurityException

Throws:

AccumuloSecurityException

changePassword

void changePassword(String principal,
                    AuthenticationToken token)
             throws AccumuloSecurityException

Throws:

AccumuloSecurityException

userExists

boolean userExists(String user)
            throws AccumuloSecurityException

Checks if a user exists

Throws:

AccumuloSecurityException

getSupportedTokenTypes

Set<Class<? extends AuthenticationToken>> getSupportedTokenTypes()

validTokenClass

boolean validTokenClass(String tokenClass)

Returns true if the given token is appropriate for this Authenticator