loginBlocked(User, String, StringBuffer, SessionData) method
This method is called by the Agentry Server when authentication of a client user is blocked, either because this class threw LoginBlockedException from the login, loginPreviousUser, or loginFailed methods, or because another system connection blocked the login.
Syntax
public
void
loginBlocked
(
User
user
,
String
userId
,
StringBuffer
error
,
SessionData
sessionData
)
Parameters
-
user –
The User object for the user whose login attempt has blocked. This can be null, if the login was blocked by another system connection before the createUser and login methods of this system connection were called.
-
userId –
The user name of the user that was logging in. This parameter might be useful if user is null, but you still need to take some sort of action for the user for some reason. If user is not null, then this parameter will be equal to the user name contained in user.
-
error –
A StringBuffer that contains the error message that was returned by the system connection that blocked the login. This message will ultimately be logged on the server and displayed on the client. The error message can be changed by modifying the contents of this buffer.
-
sessionData –
The session data. In addition to its usual contents, this data will contain additional information about which system connection blocked the login. This information will be available as the values for the SDML keys failed.backend.id (the system connection number) and failed.backend.name (the system connection name, as configured in Agentry.ini ).
Usage
It should clean up any user-related resources.