com.caplin.motif.fx.ret.permissioning.permissions

Interface AuthenticationManager

All Known Implementing Classes:

FileBasedAuthenticationManager, XmlAuthenticationManager

public interface AuthenticationManager

An interface for querying user attributes from the single sign on authentication system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthenticationManager.Context

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAllUserGroups() Provides the set of all group names known to the authentication manager.
java.lang.String	getSsoPassword(java.lang.String ssoUsername) Returns the password for the provided single sign on (SSO) user name.
java.util.Set<java.lang.String>	getSsoUsernames() Returns the set of all SSO user names.
java.util.Set<java.lang.String>	getSsoUsersInGroup(java.lang.String group) Returns the set of single sign on (SSO) user names that belong to the given group.
void	initialise(AuthenticationManager.Context context) This notifies the authentication manager that it is about to be loaded.

Method Detail

initialise

void initialise(AuthenticationManager.Context context)
         throws AuthenticationManagerException

This notifies the authentication manager that it is about to be loaded. This method will be called by the system once.

You should use this method to perform any initialisation required before the AuthenticationManager is loaded by the system.

Throws:

AuthenticationManagerException - if for any reason initialisation fails.

getSsoUsernames

java.util.Set<java.lang.String> getSsoUsernames()
                                         throws AuthenticationManagerException

Returns the set of all SSO user names.

Throws:

AuthenticationManagerException - if no user is found.

getSsoPassword

java.lang.String getSsoPassword(java.lang.String ssoUsername)
                         throws AuthenticationManagerException

Returns the password for the provided single sign on (SSO) user name.

Throws:

AuthenticationManagerException - if no user is found.

getAllUserGroups

java.util.Set<java.lang.String> getAllUserGroups()
                                          throws AuthenticationManagerException

Provides the set of all group names known to the authentication manager.

Throws:

AuthenticationManagerException - if no user is found.

getSsoUsersInGroup

java.util.Set<java.lang.String> getSsoUsersInGroup(java.lang.String group)
                                            throws AuthenticationManagerException

Returns the set of single sign on (SSO) user names that belong to the given group.

Throws:

AuthenticationManagerException - if no user is found.