Interface UserManager

  • All Known Implementing Classes:
    DirectorUserManager, FileBasedUserManager

    public interface UserManager
    An interface for querying user attributes.

    Examples in this documentation refer to the following user permissions

    Single Sign On Name (SSO)Trade On Behalf Of (TOBO)RET Client
    user1@caplin.comclient1client1.ret.client.fx
    client1client1.ret.client.pm
    user2@caplin.comclient2client2.ret.client.fx
    user3@caplin.comclient3client3.ret.client.pm
    salestrader1@caplin.comsalestraderrates.ret.client.fx
    grahamgraham.ret.client.fx
    johnjohn.ret.client.fx
    terryterry.ret.client.fx
    ericeric.ret.client.fx
    michaelmichael.ret.client.fx
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  UserManager.Context  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getRetClientForSsoUsername​(java.lang.String assetClass, java.lang.String ssoUsername)
      Given an asset class and a Single Sign On (SSO) user name, returns the RET client name.
      java.lang.String getRetClientForToboUsername​(java.lang.String assetClass, java.lang.String toboUsername)
      Given an asset class and a Trade On Behalf Of (TOBO) user name, returns the RET client name.
      java.util.Set<java.lang.String> getRetClientsTradedBySsoUser​(java.lang.String ssoUsername)
      Given a Single Sign On (SSO) user name, returns the set of RET clients which can be traded on behalf of.
      java.util.Set<java.lang.String> getRetClientsTradedByToboUser​(java.lang.String toboUsername)
      Given a Trade On Behalf Of (TOBO) user name, returns the set of RET clients which can be traded on behalf of.
      java.lang.String getSsoUsername​(java.lang.String toboUsername)
      Given a Trade On Behalf Of (TOBO) user name, returns a Single Sign On (SSO) user name.
      java.util.Set<java.lang.String> getSsoUserNamesWhoCanTobo​(java.lang.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.
      java.lang.String getToboUsername​(java.lang.String retClientName)
      Given a RET client name, returns the Trade On Behalf Of (TOBO) user name.
      java.util.Set<java.lang.String> getToboUsers​(java.lang.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 Detail

      • 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

        java.lang.String getRetClientForToboUsername​(java.lang.String assetClass,
                                                     java.lang.String toboUsername)
                                              throws UserManagerException
        Given an asset class and a Trade On Behalf Of (TOBO) user name, returns the RET client name.
        Asset ClassTOBO User NameReturns
        FXclient1client1.ret.client.fx
        Commoditiesclient1client1.ret.client.pm
        Throws:
        UserManagerException - if no user is found.
      • getRetClientForSsoUsername

        java.lang.String getRetClientForSsoUsername​(java.lang.String assetClass,
                                                    java.lang.String ssoUsername)
                                             throws UserManagerException
        Given an asset class and a Single Sign On (SSO) user name, returns the RET client name.
        Asset ClassSSOUserReturns
        FXuser1@caplin.comuser1.ret.client.fx
        Commoditiesuser1@caplin.comuser1.ret.client.pm
        Throws:
        UserManagerException - if no user is found.
      • getSsoUsername

        java.lang.String getSsoUsername​(java.lang.String toboUsername)
                                 throws UserManagerException
        Given a Trade On Behalf Of (TOBO) user name, returns a Single Sign On (SSO) user name.
        TOBO User NameReturns
        client1user1@caplin.com
        client2user2@caplin.com
        Throws:
        UserManagerException - if no user is found.
      • getToboUsername

        java.lang.String getToboUsername​(java.lang.String retClientName)
                                  throws UserManagerException
        Given a RET client name, returns the Trade On Behalf Of (TOBO) user name.
        RET Client NameReturns
        michael.ret.client.fxmichael
        michael.ret.client.pmmichael
        terry.ret.client.pmterry
        Throws:
        UserManagerException - if no client is found.
      • getToboUsers

        java.util.Set<java.lang.String> getToboUsers​(java.lang.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 NameReturns
        salestrader1@caplin.com(salestrader, graham, john, terry, eric, michael)
        user1@caplin.com(client1)
        Throws:
        UserManagerException - if no user is found.
      • getSsoUserNamesWhoCanTobo

        java.util.Set<java.lang.String> getSsoUserNamesWhoCanTobo​(java.lang.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 NameReturns
        terry.ret.client.fx(salestrader1@caplin.com)
        client1.ret.client.fx(user1@caplin.com)
        Throws:
        UserManagerException - if no client is found.
      • getRetClientsTradedBySsoUser

        java.util.Set<java.lang.String> getRetClientsTradedBySsoUser​(java.lang.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 NameReturns
        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

        java.util.Set<java.lang.String> getRetClientsTradedByToboUser​(java.lang.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 NameReturns
        graham(graham.ret.client.fx)
        user1(client1.ret.client.fx, client1.ret.client.pm)
        Throws:
        UserManagerException - if no user is found.