login(String, String, SessionData) method [deprecated]

Deprecated. Override login(User, String, SessionData) instead. This method is called when a user initially connects to the Agentry Server from a client application and that server's system connection's enableAuthentication option is set to true in the Agentry.ini file.

Syntax

public LoginEnumeration login ( String userId , String password , SessionData sessionData )

Parameters

userId – The user ID from the client application for the current user.
password – The password for the current user, as entered on the client application.
sessionData – Provides access to current session data, such as Agentry Server Data Markup Language (SDML) values.

Returns

One of the constants from Server.LoginEnumeration.

Usage

The return value of this function indicates whether or not the user ID and password are valid. By default, this method returns the enumerated value Login_Pass, which means that this system connection is not responsible for authenticating the user. Override this method to implement logic to perform full validation of the user against a remote system.