COM.FutureTense.Access
Class ValidateLogin

java.lang.Object
  COM.FutureTense.Access.ValidateLogin

All Implemented Interfaces:

Seed

public abstract class ValidateLogin
extends java.lang.Object
implements Seed

valIn must contain:

• String ftcmd command, ie addUser,modifyUser,delUser,login String:username required always

  IF login

  • String:password required for login and addUser String:system domain or host name to validate with (optional)

    this applogic can choose to cache login results if it wishes.

    IF logout

    • String:user user to logout (reference counting is this applogics problem)

      IF refreshACL

      • String:userId called to force a refresh acl's returned on login (will only happen if seperate resource priv code is not supplied)

      IF flushCache

      • means a forceable request was made to flush any user information cached by this applogic

      IF add/modify

      • String:acl acl's to apply on add/modify

      IF delete

      • String:user

      IF addACL

      • String:acl called to allow auth plugin to create group corresponding to an ACL

      PLUS Everything else in the input (cgi) and variables...

      valOut SHOULD contain:

      • String:results 'true' or 'false' (case matters) String:Reason (optional) message for user

      and if user is valid && ftcmd=login:

      • String:aclList (optional) a comma seperated list of groups or ACLs to which the user belongs String:userId a non-identifing unique id to use in semi-volatile session info

      Nested Class Summary

      protected class

      ValidateLogin.UserManagement

      Field Summary

      protected COM.FutureTense.Access.ISingleSignOn	m_SSO
      protected COM.FutureTense.Util.ftTimedHashtable	m_UserCache
      protected IUsers	m_UserManager
      protected static COM.FutureTense.Util.ftTimedHashtable	s_hUserManagers
      protected static java.lang.Integer	s_iUserManagerLock
      protected static COM.FutureTense.Cache.LinkedCache	userCache
      protected static COM.FutureTense.Cache.LinkedCache	userManagersCache

      Fields inherited from interface COM.FutureTense.XML.Template.Seed

      returnString

      Constructor Summary

      ValidateLogin()
      

      Method Summary

      protected abstract IUsers	CreateIUsers(java.util.Properties props)
      java.lang.String	Execute(FTValList valIn, FTValList valOut) Implements the Execute method in a manner similar to newRequest
      static java.lang.String	getAnonymousACLs() Deprecated.
      protected java.lang.String	getAnonymousACLs(ICS ics) In case of native install, we create DefaultReader user inside the database and we can assign exclusive ACLs to him.
      static java.lang.String	getAnonymousID()
      ICS	getICS(FTValList vIn) get ICS from FTValList
      protected ValidateLogin.UserManagement	GetUserManagement(FTValList valIn)
      static boolean	isAnonymousID(java.lang.String id)
      static boolean	isAnonymousLogin(java.lang.String user, java.lang.String password)

      Methods inherited from class java.lang.Object

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

      Field Detail

      userManagersCache

      protected static COM.FutureTense.Cache.LinkedCache userManagersCache

      userCache

      protected static COM.FutureTense.Cache.LinkedCache userCache

      s_hUserManagers

      protected static COM.FutureTense.Util.ftTimedHashtable s_hUserManagers

      s_iUserManagerLock

      protected static java.lang.Integer s_iUserManagerLock

      m_UserManager

      protected IUsers m_UserManager

      m_SSO

      protected COM.FutureTense.Access.ISingleSignOn m_SSO

      m_UserCache

      protected COM.FutureTense.Util.ftTimedHashtable m_UserCache

      Constructor Detail

      ValidateLogin

      public ValidateLogin()

      Method Detail

      Execute

      public java.lang.String Execute(FTValList valIn,
                                      FTValList valOut)

      Description copied from interface: Seed

      Implements the Execute method in a manner similar to newRequest

      Specified by:

      Execute in interface Seed

      Parameters:

      valIn - a FTValList with input variables.

      valOut - a FTValList output variables to to set within script engine scope. Note that the script engine returns errors as < 0 values.

      Returns:

      String value to stream back from within script engine scope (null is fine)

      getICS

      public ICS getICS(FTValList vIn)

      get ICS from FTValList

      isAnonymousLogin

      public static boolean isAnonymousLogin(java.lang.String user,
                                             java.lang.String password)

      isAnonymousID

      public static boolean isAnonymousID(java.lang.String id)

      getAnonymousID

      public static java.lang.String getAnonymousID()

      getAnonymousACLs

      public static java.lang.String getAnonymousACLs()

      Deprecated.

      This method is here for backward compactability

      Returns:

      The ACL list to be assigned to DefaultReader

      getAnonymousACLs

      protected java.lang.String getAnonymousACLs(ICS ics)

      In case of native install, we create DefaultReader user inside the database and we can assign exclusive ACLs to him. But when we use external user management system we don't create DefaultReader user in the external system, we will use this property to assign ACLs to DefaultReader. This method can be overloaded in login modules.

      Parameters:

      ics - ICS

      Returns:

      The ACL list to be assigned to DefaultReader

      GetUserManagement

      protected ValidateLogin.UserManagement GetUserManagement(FTValList valIn)
                                                        throws UserError

      Throws:

      UserError

      CreateIUsers

      protected abstract IUsers CreateIUsers(java.util.Properties props)
                                      throws UserError

      Throws:

      UserError