atg.servlet.security
Class UserLoginManager

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.servlet.security.UserLoginManager

All Implemented Interfaces:

atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class UserLoginManager
extends GenericService

The UserLoginManager class maintains two separate objects:

• The User object, which acts as a wallet of Personae for security purposes.
• The FormSessionLogin object which represents a form login in process.
• In the default implementation these objects are maintained in the session scope. DPS/DCS may extend this class to store these objects elsewhere.

  This class has been superceded by the atg.security.IdentityManager class (also atg.security.ProfileIdentityManager), which performs many of the same functions with a simpler API. This class is retained for backwards compatibility and, additionally, implements the new IdentityManager API so it may be used in that role as well. If you are implementing new code that needs authentication, you should consider using the IdentityManager (normally found at /atg/dynamo/security/IdentityManager in Nucleus) directly.

  See Also:

  IdentityManager, ProfileIdentityManager

  Field Summary

  static java.lang.String

  CLASS_VERSION

  Fields inherited from class atg.nucleus.GenericService

  SERVICE_INFO_KEY

  Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

  DEFAULT_LOG_TRACE_STATUS

  Fields inherited from interface atg.nucleus.logging.ApplicationLogging

  DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

  Constructor Summary

  UserLoginManager()
  

  Method Summary

  void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
  void	doStopService() This is called when a Service is required to shut down.
  FormLoginSession	getCurrentFormLoginSession(DynamoHttpServletRequest pRequest) Return the current FormLoginSession object.
  User	getCurrentUser(DynamoHttpServletRequest pRequest) Return the current User object.
  java.lang.String	getFormLoginSessionPath() Returns The name in the nucleus hierarchy to look for a FormLoginSession
  IdentityManager	getIdentityManager(DynamoHttpServletRequest pRequest) Returns the IdentityManager object that can be used to perform various authentication jobs.
  java.lang.String	getIdentityManagerPath() Returns the identity manager used for authentication and user identity lookup.
  java.lang.String	getUserPath() Returns The path in the Nucleus hierarchy which stores the User object
  boolean	loginCurrentUser(java.security.cert.Certificate pCertificate, DynamoHttpServletRequest pRequest, CertificateUserAuthority pCertificateUserAuthority) Log in the current user object with a specific CertificateUserAuthority.
  boolean	loginCurrentUser(java.lang.String pUserName, java.lang.String pPasswordHash, java.lang.Object pHashKey, DynamoHttpServletRequest pRequest, LoginUserAuthority pLoginUserAuthority) Log in the current user object with a specific LoginUserAuthority.
  void	setFormLoginSessionPath(java.lang.String pFormLoginSessionPath) Sets The name in the nucleus hierarchy to look for a FormLoginSession
  void	setIdentityManagerPath(java.lang.String pIdentityManagerPath) Changes the identity manager used for authentication and user identity lookup.
  void	setUserPath(java.lang.String pUserPath) Sets The path in the Nucleus hierarchy which stores the User object

  Methods inherited from class atg.nucleus.GenericService

  addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

  Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

  vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

  Methods inherited from class java.lang.Object

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

  Field Detail

  CLASS_VERSION

  public static java.lang.String CLASS_VERSION

  Constructor Detail

  UserLoginManager

  public UserLoginManager()

  Method Detail

  setUserPath

  public void setUserPath(java.lang.String pUserPath)

  Sets The path in the Nucleus hierarchy which stores the User object

  getUserPath

  public java.lang.String getUserPath()

  Returns The path in the Nucleus hierarchy which stores the User object

  setFormLoginSessionPath

  public void setFormLoginSessionPath(java.lang.String pFormLoginSessionPath)

  Sets The name in the nucleus hierarchy to look for a FormLoginSession

  getFormLoginSessionPath

  public java.lang.String getFormLoginSessionPath()

  Returns The name in the nucleus hierarchy to look for a FormLoginSession

  setIdentityManagerPath

  public void setIdentityManagerPath(java.lang.String pIdentityManagerPath)

  Changes the identity manager used for authentication and user identity lookup.

  getIdentityManagerPath

  public java.lang.String getIdentityManagerPath()

  Returns the identity manager used for authentication and user identity lookup.

  getCurrentUser

  public User getCurrentUser(DynamoHttpServletRequest pRequest)

  Return the current User object. This must always return a User object even if the user has never logged on to a user authority.

  loginCurrentUser

  public boolean loginCurrentUser(java.lang.String pUserName,
                                  java.lang.String pPasswordHash,
                                  java.lang.Object pHashKey,
                                  DynamoHttpServletRequest pRequest,
                                  LoginUserAuthority pLoginUserAuthority)

  Log in the current user object with a specific LoginUserAuthority. Note that the password must have been previously hashed using the PasswordHasher returned by getPasswordHasher().

  loginCurrentUser

  public boolean loginCurrentUser(java.security.cert.Certificate pCertificate,
                                  DynamoHttpServletRequest pRequest,
                                  CertificateUserAuthority pCertificateUserAuthority)

  Log in the current user object with a specific CertificateUserAuthority. Note that the certificate must have been previously hashed using the CertificateParser returned by getCerticateParser().

  getCurrentFormLoginSession

  public FormLoginSession getCurrentFormLoginSession(DynamoHttpServletRequest pRequest)

  Return the current FormLoginSession object. This will always return a FormLoginSession object. If there is no form login currently taking place for the current user then then the destination property of the form will be

  getIdentityManager

  public IdentityManager getIdentityManager(DynamoHttpServletRequest pRequest)

  Returns the IdentityManager object that can be used to perform various authentication jobs.

  doStartService

  public void doStartService()
                      throws ServiceException

  This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. The Service should override this method to start any processes it requires.

  Overrides:

  doStartService in class GenericService

  Throws:

  ServiceException - if the Service had a problem starting up

  doStopService

  public void doStopService()
                     throws ServiceException

  This is called when a Service is required to shut down. The Service should respond by stopping any processes that it has started.

  Overrides:

  doStopService in class GenericService

  Throws:

  ServiceException - if the Service had a problem shutting down