Package com.smartfoxserver.components.login

Class LoginData

java.lang.Object
com.smartfoxserver.components.login.LoginData
public final class LoginData extends 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:

  • Field Details

    • session

      public ISession session
      The client's session

    • userName

      public String userName
      The user name extracted from the database

    • password

      public String password
      The password extracted from the database

    • nickName

      public 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 Details

    • LoginData

      public LoginData()