Package org.apache.bookkeeper.sasl

Class SASLBookieAuthProviderFactory

java.lang.Object

org.apache.bookkeeper.sasl.SASLBookieAuthProviderFactory

All Implemented Interfaces:

BookieAuthProvider.Factory, JAASCredentialsContainer

public class SASLBookieAuthProviderFactory
extends java.lang.Object
implements BookieAuthProvider.Factory, JAASCredentialsContainer

BookieAuthProvider which uses JDK-bundled SASL.

Constructor Summary

Constructors

Constructor	Description
SASLBookieAuthProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	Release resources.
AbstractConfiguration	getConfiguration()
javax.security.auth.login.LoginContext	getLogin()
java.lang.String	getLoginContextName()
java.lang.String	getPluginName()	Get Auth provider plugin name.
java.lang.String	getPrincipal()
javax.security.auth.Subject	getSubject()
void	init(ServerConfiguration conf)	Initialize the factory with the server configuration and protobuf message registry.
boolean	isUsingTicketCache()
BookieAuthProvider	newProvider(BookieConnectionPeer addr, AuthCallbacks.GenericCallback<java.lang.Void> completeCb)	Create a new instance of a bookie auth provider.
void	setLogin(javax.security.auth.login.LoginContext login)

Methods inherited from class java.lang.Object

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

Constructor Detail

SASLBookieAuthProviderFactory

public SASLBookieAuthProviderFactory()

Method Detail

init

public void init(ServerConfiguration conf)
          throws java.io.IOException

Description copied from interface: BookieAuthProvider.Factory

Initialize the factory with the server configuration and protobuf message registry. Implementors must add any extension messages which contain the auth payload, so that the server can decode auth messages it receives from the client.

Specified by:

init in interface BookieAuthProvider.Factory

Throws:

java.io.IOException

newProvider

public BookieAuthProvider newProvider(BookieConnectionPeer addr,
                                      AuthCallbacks.GenericCallback<java.lang.Void> completeCb)

Description copied from interface: BookieAuthProvider.Factory

Create a new instance of a bookie auth provider. Each connection should get its own instance, as they can hold connection specific state. The completeCb is used to notify the server that the authentication handshake is complete. CompleteCb should be called only once. If the authentication was successful, BKException.Code.OK should be passed as the return code. Otherwise, another error code should be passed. If authentication fails, the server will close the connection.

Specified by:

newProvider in interface BookieAuthProvider.Factory

Parameters:

addr - an handle to the connection

completeCb - callback to be notified when authentication is complete.

getPluginName

public java.lang.String getPluginName()

Description copied from interface: BookieAuthProvider.Factory

Get Auth provider plugin name. Used as a sanity check to ensure that the bookie and the client. are using the same auth provider.

Specified by:

getPluginName in interface BookieAuthProvider.Factory

close

public void close()

Description copied from interface: BookieAuthProvider.Factory

Release resources.

Specified by:

close in interface BookieAuthProvider.Factory

getSubject

public javax.security.auth.Subject getSubject()

Specified by:

getSubject in interface JAASCredentialsContainer

getLogin

public javax.security.auth.login.LoginContext getLogin()

Specified by:

getLogin in interface JAASCredentialsContainer

setLogin

public void setLogin(javax.security.auth.login.LoginContext login)

Specified by:

setLogin in interface JAASCredentialsContainer

isUsingTicketCache

public boolean isUsingTicketCache()

Specified by:

isUsingTicketCache in interface JAASCredentialsContainer

getPrincipal

public java.lang.String getPrincipal()

Specified by:

getPrincipal in interface JAASCredentialsContainer

getConfiguration

public AbstractConfiguration getConfiguration()

Specified by:

getConfiguration in interface JAASCredentialsContainer

getLoginContextName

public java.lang.String getLoginContextName()

Specified by:

getLoginContextName in interface JAASCredentialsContainer