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

Class XmlAuthenticationManager

java.lang.Object

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

All Implemented Interfaces:

AuthenticationManager

Deprecated.

Use FileBasedAuthenticationManager instead. This class is due for removal in December 2015.

@Deprecated
public class XmlAuthenticationManager
extends java.lang.Object
implements AuthenticationManager

An AuthenticationManager which reads permissions from an XML permissions file.

Nested Class Summary

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

AuthenticationManager.Context

Constructor Summary

Constructors

Constructor and Description
XmlAuthenticationManager() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAllUserGroups() Deprecated. Provides the set of all group names known to the authentication manager.
java.lang.String	getSsoPassword(java.lang.String ssoUsername) Deprecated. Returns the password for the provided single sign on (SSO) user name.
java.util.Set<java.lang.String>	getSsoUsernames() Deprecated. Returns the set of all SSO user names.
java.util.Set<java.lang.String>	getSsoUsersInGroup(java.lang.String group) Deprecated. Returns the set of single sign on (SSO) user names that belong to the given group.
void	initialise(AuthenticationManager.Context context) Deprecated. 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

XmlAuthenticationManager

public XmlAuthenticationManager()

Deprecated.

Method Detail

initialise

public void initialise(AuthenticationManager.Context context)
                throws AuthenticationManagerException

Deprecated.

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()

Deprecated.

Description copied from interface: AuthenticationManager

Returns the set of all SSO user names.

Specified by:

getSsoUsernames in interface AuthenticationManager

getSsoPassword

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

Deprecated.

Description copied from interface: AuthenticationManager

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

Specified by:

getSsoPassword in interface AuthenticationManager

getAllUserGroups

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

Deprecated.

Provides the set of all group names known to the authentication manager. Given the following configuration with two users:

 

 <users>
         <SingleSignOnUserName id="user1@caplin.com" tradesOnBehalfOf="user1@caplin.com" userGroups="Global, AllTenors, OrdersFX, TwoWayPricing"/>
         <SingleSignOnUserName id="user2@caplin.com" tradesOnBehalfOf="user2@caplin.com" userGroups="Global, AllTenors"/>
 	  ...
 </users>
 	
        

getAllUserGroups() will return the set (Global, AllTenors, OrdersFX, TwoWayPricing).

Specified by:

getAllUserGroups in interface AuthenticationManager

Returns:

the set of all group names known to the authentication manager, or an empty set if no groups are found.

getSsoUsersInGroup

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

Deprecated.

Returns the set of single sign on (SSO) user names that belong to the given group. Given the following configuration with two users:

 

 <users>
         <SingleSignOnUserName id="user1@caplin.com" tradesOnBehalfOf="user1@caplin.com" userGroups="Global, AllTenors, OrdersFX, TwoWayPricing"/>
         <SingleSignOnUserName id="user2@caplin.com" tradesOnBehalfOf="user2@caplin.com" userGroups="Global, AllTenors"/>
 	  ...
 </users>
 	
        

getSsoUsersInGroup("AllTenors") will return the set (user1@caplin.com, user2@caplin.com).

Specified by:

getSsoUsersInGroup in interface AuthenticationManager

Parameters:

group - the group name for which to retrieve members.

Returns:

the set of SSO user names belonging to the given group, or an empty set if no group is found.