Class LoginData


  • public final class LoginData
    extends java.lang.Object

    This object is passed to an ILoginAssistantPlugin at runtime, during the login process.

    The class holds all of the runtime data relative to the current login, including the client's Session object, all the fields loaded from the database, the client's incoming login parameter etc...

    See Also:
    ILoginAssistantPlugin
    • Field Summary

      Fields 
      Modifier and Type Field Description
      ISFSObject clientIncomingData
      The optional SFSObject sent by the client with his LoginRequest
      ISFSObject clientOutGoingData
      The optional outgoing SFSObject that will be sent to the client with the Login response
      ISFSObject extraFields
      The optional extra fields extracted from the database, if specified in the LoginAssistant configuration (might be null)
      boolean isActive
      Optional field that checks if the account has been activated
      java.lang.String nickName
      The optional nickname extracted from the database (might be null)
      java.lang.String password
      The password extracted from the database
      ISession session
      The client's session
      java.lang.String userName
      The user name extracted from the database
    • Constructor Summary

      Constructors 
      Constructor Description
      LoginData()  
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • session

        public ISession session
        The client's session
      • userName

        public java.lang.String userName
        The user name extracted from the database
      • password

        public java.lang.String password
        The password extracted from the database
      • nickName

        public java.lang.String nickName
        The optional nickname extracted from the database (might be null)
      • isActive

        public boolean isActive
        Optional field that checks if the account has been activated
      • extraFields

        public ISFSObject extraFields
        The optional extra fields extracted from the database, if specified in the LoginAssistant configuration (might be null)
      • clientIncomingData

        public ISFSObject clientIncomingData
        The optional SFSObject sent by the client with his LoginRequest
      • clientOutGoingData

        public ISFSObject clientOutGoingData
        The optional outgoing SFSObject that will be sent to the client with the Login response
    • Constructor Detail

      • LoginData

        public LoginData()