Package com.caplin.orders.barracuda.extension

Class UserManager

java.lang.Object

com.caplin.orders.barracuda.extension.UserManager

public class UserManager
extends Object

An interface for querying user attributes.

Examples in this documentation refer to the following user permissions and naming conventions

Term	Meaning
Single Sign On Username (SSO)	The username the user logs into a Motif application with
Trade On Behalf Of (TOBO)	An abstract username used to link traders and sales traders to their Client usernames
TOBO Usernames	The TOBO Usernames that are permitted when a user would like to perform an action on behalf of someone else. Typically only provided to Sales Traders.
Client Username	The TOBO Usernames that are permitted when a user would like to perform an action on behalf of someone else. Typically only provided to Sales Traders.

Constructor Summary

Constructors

Constructor	Description
UserManager(SalesUserMapping salesUserMapping, SSOUserMapping ssoUserMapping, ClientCodeMapping barracudaClientMapping, ClientTraderMapping barracudaClientTraderMapping)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getClientCodeForSalesSSOUsername(@NonNull String ssoUsername, @NonNull String toboUsername, @NonNull String account)
@Nullable String	getClientCodeForSSOUsername(@NonNull String ssoUsername, @NonNull String account)
@Nullable String	getClientCodeForTOBOUsername(@NonNull String toboUsername, @NonNull String account)
@Nullable String	getClientTraderForSalesSSOUsername(@NonNull String ssoUsername, @NonNull String toboUsername)
@Nullable String	getClientTraderForSSOUsername(@NonNull String ssoUsername)
@Nullable Set<String>	getSalesSSOUsernameForTOBOUsername(@NonNull String toboUsername)
@Nullable String	getSSOUsername(@NonNull String toboUsername)
@Nullable String	getTOBOUsername(@NonNull String ssoUsername)
@Nullable Set<String>	getTOBOUsernames(@NonNull String ssoUsername)
boolean	isSalesTrader(@NonNull String ssoUsername)

Methods inherited from class java.lang.Object

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

Constructor Details

UserManager

@Inject
public UserManager(SalesUserMapping salesUserMapping,
 SSOUserMapping ssoUserMapping,
 ClientCodeMapping barracudaClientMapping,
 ClientTraderMapping barracudaClientTraderMapping)

Method Details

getSalesSSOUsernameForTOBOUsername

public @Nullable Set<String> getSalesSSOUsernameForTOBOUsername(@NonNull String toboUsername)
                                                         throws UserManagerException

Throws:

UserManagerException

getTOBOUsernames

public @Nullable Set<String> getTOBOUsernames(@NonNull String ssoUsername)
                                       throws UserManagerException

Throws:

UserManagerException

getSSOUsername

public @Nullable String getSSOUsername(@NonNull String toboUsername)
                                throws UserManagerException

Throws:

UserManagerException

getTOBOUsername

public @Nullable String getTOBOUsername(@NonNull String ssoUsername)
                                 throws UserManagerException

Throws:

UserManagerException

getClientCodeForTOBOUsername

public @Nullable String getClientCodeForTOBOUsername(@NonNull String toboUsername,
 @NonNull String account)

getClientCodeForSSOUsername

public @Nullable String getClientCodeForSSOUsername(@NonNull String ssoUsername,
 @NonNull String account)
                                             throws UserManagerException

Throws:

UserManagerException

getClientCodeForSalesSSOUsername

public @Nullable String getClientCodeForSalesSSOUsername(@NonNull String ssoUsername,
 @NonNull String toboUsername,
 @NonNull String account)
                                                  throws UserManagerException

Throws:

UserManagerException

isSalesTrader

public boolean isSalesTrader(@NonNull String ssoUsername)

getClientTraderForSSOUsername

public @Nullable String getClientTraderForSSOUsername(@NonNull String ssoUsername)
                                               throws UserManagerException

Throws:

UserManagerException

getClientTraderForSalesSSOUsername

public @Nullable String getClientTraderForSalesSSOUsername(@NonNull String ssoUsername,
 @NonNull String toboUsername)
                                                    throws UserManagerException

Throws:

UserManagerException