org.apache.qpid.server.security.auth.sasl
Interface AuthenticationProviderInitialiser

All Known Implementing Classes:
AmqPlainInitialiser, AnonymousInitialiser, CRAMMD5HashedInitialiser, CRAMMD5HexInitialiser, CRAMMD5Initialiser, PlainInitialiser, UsernamePasswordInitialiser

public interface AuthenticationProviderInitialiser


Method Summary
 CallbackHandler getCallbackHandler()
           
 String getMechanismName()
           
 Map<String,?> getProperties()
          Get the properties that must be passed in to the Sasl.createSaslServer method.
 Class<? extends SaslServerFactory> getServerFactoryClassForJCARegistration()
          Get the class that is the server factory.
 void initialise(PrincipalDatabase db)
          Initialise the authentication provider.
 void initialise(String baseConfigPath, Configuration configuration, Map<String,PrincipalDatabase> principalDatabases)
          Initialise the authentication provider.
 

Method Detail

getMechanismName

String getMechanismName()
Returns:
the mechanism's name. This will be used in the list of mechanism's advertised to the client.

initialise

void initialise(String baseConfigPath,
                Configuration configuration,
                Map<String,PrincipalDatabase> principalDatabases)
                throws Exception
Initialise the authentication provider.

Parameters:
baseConfigPath - the path in the config file that points to any config options for this provider. Each provider can have its own set of configuration options
configuration - the Apache Commons Configuration instance used to configure this provider
principalDatabases - the set of principal databases that are available
Throws:
Exception - needs refined Exception is too broad.

initialise

void initialise(PrincipalDatabase db)
Initialise the authentication provider.

Parameters:
db - The principal database to initialise with

getCallbackHandler

CallbackHandler getCallbackHandler()
Returns:
the callback handler that should be used to process authentication requests for this mechanism. This will be called after initialise and will be stored by the authentication manager. The callback handler must be fully threadsafe.

getProperties

Map<String,?> getProperties()
Get the properties that must be passed in to the Sasl.createSaslServer method.

Returns:
the properties, which may be null

getServerFactoryClassForJCARegistration

Class<? extends SaslServerFactory> getServerFactoryClassForJCARegistration()
Get the class that is the server factory. This is used for the JCA registration.

Returns:
null if no JCA registration is required, otherwise return the class that will be used in JCA registration


Licensed to the Apache Software Foundation