| java.lang.Object
 org.apache.turbine.services.security.ldap.LDAPUserManager
| Method Summary | |
| public boolean | accountExists(User user)
Check wether a specified user's account exists.
The login name is used for looking up the account.
Parameters:
user - The user to be checked. | | public boolean | accountExists(String username)
Check wether a specified user's account exists.
The login name is used for looking up the account.
Parameters:
username - The name of the user to be checked. | | public void | authenticate(User user, String password)
Authenticate a User with the specified password. | | public static DirContext | bind(String username, String password)
Creates an initial context.
Parameters:
username - admin username supplied in TRP.
Parameters:
password - admin password supplied in TRP
throws:
NamingException - when an error occurs with the named server. | | public static DirContext | bindAsAdmin()
Bind as the admin user.
throws:
NamingException - when an error occurs with the named server. | | public void | changePassword(User user, String oldPass, String newPass)
This method is not yet implemented
Change the password for an User. | | public void | createAccount(User user, String initialPassword)
Creates new user account with specified attributes. | | public void | forcePassword(User user, String password)
This method is not yet implemented
Forcibly sets new password for an User.
This is supposed to be used by the administrator to change the forgotten
or compromised passwords. | | public void | init(Configuration conf)
| | public void | removeAccount(User user)
Removes an user account from the system. | | public User | retrieve(String username)
Retrieve a user from persistent storage using username as the
key.
Parameters:
username - the name of the user. | | public User[] | retrieve(Criteria criteria)
This is currently not implemented to behave as expected. | | public User | retrieve(String username, String password)
Retrieve a user from persistent storage using username as the
key, and authenticate the user. | | public User | retrieveById(Object key)
| | public List | retrieveList(Criteria criteria)
Retrieve a list of users that meet the specified criteria.
As the keys for the criteria, you should use the constants that
are defined in
User interface, plus the names
of the custom attributes you added to your user representation
in the data storage. | | public void | saveOnSessionUnbind(User user)
This method is not yet implemented.
Saves User data when the session is unbound. | | public void | store(User user)
Save a User object to persistent storage. |
| accountExists | | public boolean accountExists(User user) throws DataBackendException(Code) | | Check wether a specified user's account exists.
The login name is used for looking up the account.
Parameters:
user - The user to be checked. true if the specified account exists
throws:
DataBackendException - Error accessing the data backend. |
| accountExists | | public boolean accountExists(String username) throws DataBackendException(Code) | | Check wether a specified user's account exists.
The login name is used for looking up the account.
Parameters:
username - The name of the user to be checked. true if the specified account exists
throws:
DataBackendException - Error accessing the data backend. |
| bind | | public static DirContext bind(String username, String password) throws NamingException(Code) | | Creates an initial context.
Parameters:
username - admin username supplied in TRP.
Parameters:
password - admin password supplied in TRP
throws:
NamingException - when an error occurs with the named server. a new DirContext. |
| forcePassword | | public void forcePassword(User user, String password) throws UnknownEntityException, DataBackendException(Code) | | This method is not yet implemented
Forcibly sets new password for an User.
This is supposed to be used by the administrator to change the forgotten
or compromised passwords. Certain implementatations of this feature
would require adminstrative level access to the authenticating
server / program.
Parameters:
user - an User to change password for.
Parameters:
password - the new password.
exception:
UnknownEntityException - if the user's record does notexist in the database.
exception:
DataBackendException - Error accessing the data backend. |
| init | | public void init(Configuration conf)(Code) | | Initializes the UserManager
Parameters:
conf - A Configuration object to init this Manager |
| retrieve | | public User[] retrieve(Criteria criteria) throws DataBackendException(Code) | | This is currently not implemented to behave as expected. It
ignores the Criteria argument and returns all the users.
Retrieve a set of users that meet the specified criteria.
As the keys for the criteria, you should use the constants that
are defined in
User interface, plus the the names
of the custom attributes you added to your user representation
in the data storage. Use verbatim names of the attributes -
without table name prefix in case of DB implementation.
Parameters:
criteria - The criteria of selection. a List of users meeting the criteria.
throws:
DataBackendException - Error accessing the data backend. |
| retrieveList | | public List retrieveList(Criteria criteria) throws DataBackendException(Code) | | Retrieve a list of users that meet the specified criteria.
As the keys for the criteria, you should use the constants that
are defined in
User interface, plus the names
of the custom attributes you added to your user representation
in the data storage. Use verbatim names of the attributes -
without table name prefix in case of Torque implementation.
Parameters:
criteria - The criteria of selection. a List of users meeting the criteria.
throws:
DataBackendException - if there is a problem accessing thestorage. |
| saveOnSessionUnbind | | public void saveOnSessionUnbind(User user) throws UnknownEntityException, DataBackendException(Code) | | This method is not yet implemented.
Saves User data when the session is unbound. The user account is required
to exist in the storage.
LastLogin, AccessCounter, persistent pull tools, and any data stored
in the permData hashtable that is not mapped to a column will be saved.
exception:
UnknownEntityException - if the user's account does notexist in the database.
exception:
DataBackendException - if there is a problem accessing thestorage. |
|
|