Package org.apache.bookkeeper.tls

Class BookieAuthZFactory

java.lang.Object

org.apache.bookkeeper.tls.BookieAuthZFactory

All Implemented Interfaces:

BookieAuthProvider.Factory

public class BookieAuthZFactory
extends java.lang.Object
implements BookieAuthProvider.Factory

Authorization factory class.

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String[]	allowedRoles

Constructor Summary

Constructors

Constructor	Description
BookieAuthZFactory()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getPluginName()	Get Auth provider plugin name.
void	init(ServerConfiguration conf)	Initialize the factory with the server configuration and protobuf message registry.
BookieAuthProvider	newProvider(BookieConnectionPeer addr, AuthCallbacks.GenericCallback<java.lang.Void> completeCb)	Create a new instance of a bookie auth provider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.bookkeeper.auth.BookieAuthProvider.Factory

close

Field Detail

allowedRoles

public java.lang.String[] allowedRoles

Constructor Detail

BookieAuthZFactory

public BookieAuthZFactory()

Method Detail

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

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.