Package com.caplin.motif.fx.ret.common.permission

Interface UserManager

All Known Implementing Classes:

FileBasedUserManager

public interface UserManager

An interface for querying user attributes.

Examples in this documentation refer to the following user permissions

<td

Single Sign On Name (SSO)	Trade On Behalf Of (TOBO)	RET Client
user1@caplin.com	client1	client1.ret.client.fx
client1	client1.ret.client.pm
user2@caplin.com	client2	client2.ret.client.fx
user3@caplin.com	client3	client3.ret.client.pm
salestrader1@caplin.com	salestrader	rates.ret.client.fx
	graham	graham.ret.client.fx
	john	john.ret.client.fx
	terry	terry.ret.client.fx
	eric	eric.ret.client.fx
	michael	michael.ret.client.fx

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UserManager.Context

Method Summary

Modifier and Type	Method	Description
String	getRetClientForSsoUsername(String assetClass, String ssoUsername)	Given an asset class and a Single Sign On (SSO) user name, returns the RET client name.
String	getRetClientForToboUsername(String assetClass, String toboUsername)	Given an asset class and a Trade On Behalf Of (TOBO) user name, returns the RET client name.
Set<String>	getRetClientsTradedBySsoUser(String ssoUsername)	Given a Single Sign On (SSO) user name, returns the set of RET clients which can be traded on behalf of.
Set<String>	getRetClientsTradedByToboUser(String toboUsername)	Given a Trade On Behalf Of (TOBO) user name, returns the set of RET clients which can be traded on behalf of.
String	getSsoUsername(String toboUsername)	Given a Trade On Behalf Of (TOBO) user name, returns a Single Sign On (SSO) user name.
Set<String>	getSsoUserNamesWhoCanTobo(String retClientName)	Given a RET client name, returns the set of all Single Sign On (SSO) users with permission to Trade On Behalf Of (TOBO) them.
String	getToboUsername(String retClientName)	Given a RET client name, returns the Trade On Behalf Of (TOBO) user name.
Set<String>	getToboUsers(String ssoUsername)	Given a Single Sign On (SSO) user name, returns the set of related Trade On Behalf Of (TOBO) users.
void	initialise(UserManager.Context context)	This notifies the UserManager that it is about to be loaded.

Method Details

initialise

void initialise(UserManager.Context context)
         throws UserManagerException

This notifies the UserManager 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 UserManager is loaded by the system.

Throws:

UserManagerException - if for any reason initialisation fails.

getRetClientForToboUsername

String getRetClientForToboUsername(String assetClass,
 String toboUsername)
                            throws UserManagerException

Given an asset class and a Trade On Behalf Of (TOBO) user name, returns the RET client name.

Asset Class	TOBO User Name	Returns
FX	client1	client1.ret.client.fx
Commodities	client1	client1.ret.client.pm

Throws:

UserManagerException - if no user is found.

getRetClientForSsoUsername

String getRetClientForSsoUsername(String assetClass,
 String ssoUsername)
                           throws UserManagerException

Given an asset class and a Single Sign On (SSO) user name, returns the RET client name.

Asset Class	SSOUser	Returns
FX	user1@caplin.com	user1.ret.client.fx
Commodities	user1@caplin.com	user1.ret.client.pm

Throws:

UserManagerException - if no user is found.

getSsoUsername

String getSsoUsername(String toboUsername)
               throws UserManagerException

Given a Trade On Behalf Of (TOBO) user name, returns a Single Sign On (SSO) user name.

TOBO User Name	Returns
client1	user1@caplin.com
client2	user2@caplin.com

Throws:

UserManagerException - if no user is found.

getToboUsername

String getToboUsername(String retClientName)
                throws UserManagerException

Given a RET client name, returns the Trade On Behalf Of (TOBO) user name.

RET Client Name	Returns
michael.ret.client.fx	michael
michael.ret.client.pm	michael
terry.ret.client.pm	terry

Throws:

UserManagerException - if no client is found.

getToboUsers

Set<String> getToboUsers(String ssoUsername)
                  throws UserManagerException

Given a Single Sign On (SSO) user name, returns the set of related Trade On Behalf Of (TOBO) users.

SSO User Name	Returns
salestrader1@caplin.com	(salestrader, graham, john, terry, eric, michael)
user1@caplin.com	(client1)

Throws:

UserManagerException - if no user is found.

getSsoUserNamesWhoCanTobo

Set<String> getSsoUserNamesWhoCanTobo(String retClientName)
                               throws UserManagerException

Given a RET client name, returns the set of all Single Sign On (SSO) users with permission to Trade On Behalf Of (TOBO) them.

RET Client Name	Returns
terry.ret.client.fx	(salestrader1@caplin.com)
client1.ret.client.fx	(user1@caplin.com)

Throws:

UserManagerException - if no client is found.

getRetClientsTradedBySsoUser

Set<String> getRetClientsTradedBySsoUser(String ssoUsername)
                                  throws UserManagerException

Given a Single Sign On (SSO) user name, returns the set of RET clients which can be traded on behalf of.

SSO User Name	Returns
salestrader1@caplin.com	(rates.ret.client.fx, graham.ret.client.fx, john.ret.client.fx, terry.ret.client.fx, eric.ret.client.fx, michael.ret.client.fx)
user1@caplin.com	(client1.ret.client.fx, client1.ret.client.pm)

Throws:

UserManagerException - if no user is found.

getRetClientsTradedByToboUser

Set<String> getRetClientsTradedByToboUser(String toboUsername)
                                   throws UserManagerException

Given a Trade On Behalf Of (TOBO) user name, returns the set of RET clients which can be traded on behalf of.

TOBO User Name	Returns
graham	(graham.ret.client.fx)
user1	(client1.ret.client.fx, client1.ret.client.pm)

Throws:

UserManagerException - if no user is found.