By rjacobs on
Change record status:
Published (View all published change records)
Project:
Introduced in branch:
7.x-2.x
Introduced in version:
7.x-2.1
Issue links:
Description:
New removeUser(), updateUserPassword() and validateConnection() methods have been added to the CrowdServiceInterface:
/**
* Remove an existing user from Crowd
*
* @param string $username
* The username to remove.
* @return boolean
* TRUE on successful removal.
* @throws CrowdException
* If a specific response cannot be confirmed via the Crowd connection or
* there is an error deleting the user a CrowdException error is thrown.
*/
public function removeUser($username);
/**
* Update an existing user's password in Crowd.
*
* @param string $username
* The username to update.
* @param array $password
* A new password value to set for the user.
* @return boolean
* TRUE on successful update.
* @throws CrowdException
* If a specific response cannot be confirmed via the Crowd connection or
* there is an error updating the password a CrowdException error is thrown.
*/
public function updateUserPassword($username, $password);
/**
* Validate a Crowd REST connection.
*
* Most REST methods throw errors when there is a connection issue, but it is
* occasionally useful to directly check the status of the connection. In
* addition some methods may recieve a "valid" response that won't result in
* an exception but can be ambiguous (e.g. a 404 could mean a valid set of
* empty results, but could also result from a misconfigured endpoint). So
* this method can also be used as a confirmation in such cases.
*
* @return boolean
* Returns TRUE if the connection can be validated or FALSE if not.
*/
public function validateConnection();
Anyone directly implementing CrowdServiceInterface (as opposed to extending it or the native CrowdRestClient class) will need to implement these methods to ensure compatibility with the public interface. This is likely a very edge-case need however.
Impacts:
Module developers