Method
Name |
Description |
public boolean
activate () |
This method is
called after the constructor. Subclasses should overwrite this method to
initialize any data needed to validate the userName and password.
This method should return true if the initialization was successful,
otherwise return false. If this method returns false, the
login will be considered invalid and Enterprise RTView will exit. |
public
boolean validateLogin (String userName, String password) |
This
method is called from the login dialog to validate the userName
and password. Subclasses should overwrite this method to return
true
if the userName and password are valid, otherwise return
false.
If there are no roles defined for the specified user, the login will fail,
even if this method returns true. |
public
void invalidateLogin () |
This
method is called if the user presses Reset in the login dialog.
The Reset button clears the fields so the user can set a new userName
and password. If subclasses stored the userName or password
from validateLogin() or the status of whether they were valid these
values should be cleared. |
public
boolean userHasMultipleRoles (String userName) |
This
method must return true if the specified user has multiple roles,
otherwise false. |
public
Vector getRoleNamesForUser (String userName) |
This
method must return a Vector containing the role names for the specified
user. This method will only be called if userHasMultipleRoles()
returns true for the specified user. Each user is required to have
at least one role. |
public String
getRole (String userName) |
This method is
only called if the login is valid and the user only has one role. If the
user has multiple roles, the role selected in the login dialog is used.
Users should overwrite this method to return the role for the specified
user. Each user is required to have at least one role. |
getSubstitutions
(String userName) |
This method should return
substitutions to set on the Enterprise RTView application when the specified
user is logged in. If this user does not have any associated substitutions,
this method should return null. Otherwise, return a pair of Vectors.
Both Vectors must be the same length, with the first Vector
containing the substitution strings and the second Vector containing
the corresponding substitution values. |
getPassword
(String userName) |
This method must return the password for the specified user, or null if
the user is not recognized.
This method is called for data sources that have the Use Client Credentials
option selected. If the Use Client Credentials feature is not used in
your application, this method can return null for all users.
NOTE: Some data sources do not support
this feature.
For information on Application Options for your data source, refer to the
Data Sources section of this
documentation.
|