login(User, String, SessionData) method

Syntax

public void login ( User user , String password , SessionData sessionData ) throws LoginException

Parameters

• user – The User object that identifies the client user. The user name can be read from this object.
• 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.

Exceptions

• LoginException class – if the login fails for any reason, or if the login succeeds but an exceptional condition exists (such as an expired or soon-to-be expired password).

Usage

This method is called when a user initially connects to the Agentry Server from a client application and the enableAuthentication option is set to true in the Java section of the Agentry.ini file. Override this method to implement logic to perform full validation of the user against a remote system.

This method should return normally if the authentication of the user succeeds. If login fails for any reason, the appropriate LoginException subclass should be thrown. An exception should also be thrown for other conditions such as expired or soon-to-be-expiring passwords. By default, this method throws LoginSkippedException, which means that this system connection is not responsible for authenticating the user (it is equivalent to setting enableAuthentication to false in Agentry.ini, except that it can be thrown on a per-user basis).

If you throw PasswordInvalidException or LoginBlockedException, then either loginFailed or loginBlocked, respectively, will be called. From those methods you can return a more detailed error message indicating why the login failed.