alluxio.security.authentication

Interface AuthenticationServer

All Superinterfaces:

AutoCloseable, io.grpc.BindableService, Closeable

All Known Implementing Classes:

DefaultAuthenticationServer

public interface AuthenticationServer
extends io.grpc.BindableService, Closeable

Interface for authentication server implementations.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the server, releases all authentication sessions.
SaslServerHandler	createSaslHandler(ChannelAuthenticationScheme scheme) Creates server-side Sasl handler for given scheme.
AuthenticatedUserInfo	getUserInfoForChannel(UUID channelId)
void	registerChannel(UUID channelId, AuthenticatedUserInfo userInfo, AuthenticatedChannelServerDriver saslDriver) Registers new user against given channel.
void	unregisterChannel(UUID channelId) Unregisters given channel.

Methods inherited from interface io.grpc.BindableService

bindService

Method Detail

registerChannel

void registerChannel(UUID channelId,
                     AuthenticatedUserInfo userInfo,
                     AuthenticatedChannelServerDriver saslDriver)

Registers new user against given channel.

Parameters:

channelId - channel id

userInfo - authanticated user info

saslDriver - sasl server driver

getUserInfoForChannel

AuthenticatedUserInfo getUserInfoForChannel(UUID channelId)
                                     throws UnauthenticatedException

Parameters:

channelId - channel id

Returns:

info of user that is authenticated with the given channel

Throws:

UnauthenticatedException - if given channel is not registered

unregisterChannel

void unregisterChannel(UUID channelId)

Unregisters given channel.

Parameters:

channelId - channel id

createSaslHandler

SaslServerHandler createSaslHandler(ChannelAuthenticationScheme scheme)
                             throws SaslException

Creates server-side Sasl handler for given scheme.

Parameters:

scheme - the authentication scheme

Returns:

the created SaslServerHandler instance

Throws:

SaslException

close

void close()
    throws IOException

Closes the server, releases all authentication sessions.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException