Package com.caplin.motif.fx.ret.permissioning.extension.authentication

Class FileBasedAuthenticationManager

java.lang.Object

com.caplin.motif.fx.ret.permissioning.extension.authentication.FileBasedAuthenticationManager

All Implemented Interfaces:

AuthenticationManager

public class FileBasedAuthenticationManager
extends java.lang.Object
implements AuthenticationManager

An AuthenticationManager which reads permissions from a file.

Nested Class Summary

Nested classes/interfaces inherited from interface com.caplin.motif.fx.ret.permissioning.permissions.AuthenticationManager

AuthenticationManager.Context

Constructor Summary

Constructors

Constructor	Description
FileBasedAuthenticationManager()

Method Summary

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBasedAuthenticationManager

public FileBasedAuthenticationManager()

Method Detail

initialise

public void initialise(AuthenticationManager.Context context)
                throws AuthenticationManagerException

Description copied from interface: AuthenticationManager

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.

Specified by:

initialise in interface AuthenticationManager

Throws:

AuthenticationManagerException - if for any reason initialisation fails.

getSsoUsernames

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

Description copied from interface: AuthenticationManager

Returns the set of all SSO user names.

Specified by:

getSsoUsernames in interface AuthenticationManager

Throws:

AuthenticationManagerException - if no user is found.

getSsoPassword

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

Description copied from interface: AuthenticationManager

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

Specified by:

getSsoPassword in interface AuthenticationManager

Throws:

AuthenticationManagerException - if no user is found.

getAllUserGroups

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

Description copied from interface: AuthenticationManager

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

Specified by:

getAllUserGroups in interface AuthenticationManager

Throws:

AuthenticationManagerException - if no user is found.

getSsoUsersInGroup

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

Description copied from interface: AuthenticationManager

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

Specified by:

getSsoUsersInGroup in interface AuthenticationManager

Throws:

AuthenticationManagerException - if no user is found.