Interface PrincipalProviderRegistry
- 
- All Known Implementing Classes:
 ProviderRegistryImpl
public interface PrincipalProviderRegistryRegistry used to store and retrievePrincipalProviders.- See Also:
 PrincipalProvider
 
- 
- 
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PrincipalProvidergetDefault()PrincipalProvidergetProvider(String className)PrincipalProvider[]getProviders()Returns all registered providers.PrincipalProviderregisterProvider(Properties configuration)Registers a new provider by means of a configuration. 
 - 
 
- 
- 
Method Detail
- 
registerProvider
PrincipalProvider registerProvider(Properties configuration) throws RepositoryException
Registers a new provider by means of a configuration. The registry expects the properties to contain aLoginModuleConfig.PARAM_PRINCIPAL_PROVIDER_CLASSto be able to create a instance of PrincipalProvider.The Properties will be passed to the instantiated Provider via
PrincipalProvider.init(Properties)- Parameters:
 configuration- Properties for the Provider- Returns:
 - the newly added Provider or 
nullif the configuration was incomplete. - Throws:
 RepositoryException- if an error occurs while creating the provider instance.
 
- 
getDefault
PrincipalProvider getDefault()
- Returns:
 - the default principal provider
 
 
- 
getProvider
PrincipalProvider getProvider(String className)
- Parameters:
 className- Name of the principal provider class.- Returns:
 - PrincipalProvider or 
nullif no provider with the given class name was registered. 
 
- 
getProviders
PrincipalProvider[] getProviders()
Returns all registered providers.- Returns:
 - all registered providers.
 
 
 - 
 
 -