com.day.cq.security

Interface AccountManager

public interface AccountManager

Simple Utility for User-Account Selfservices. Allows basicly for creation and password handling. The Profile can be read and stored via its API

Method Summary

Methods

Modifier and Type	Method and Description
User	createAccount(String uid, String pwd, String group, Map<String,RequestParameter[]> properties) Convenience to create a new User together with setting properties in one method call.
User	findAccount(String fragment)
User	getOrCreateAccount(String id, String pwd, String group, Map<String,RequestParameter[]> properties) Convenenience to either search and update an existing account or create it
boolean	requestAccount(String email, URL requestUrl) Request for creating a new account.
boolean	requestPasswordReset(User user, URL requestUrl) Request a password rest.
String	resetPassword(User user) Reset the Password of the Account to a randomly generated
String	resetPassword(User user, String key) Reset the Password of the Account to a randomly generated, requires a key in order to verify, that the reset has been requested by the key owner.
boolean	sendMail(User user, String from, String subject, String body, Map<String,String> replace) Simple utility to send a mail to a given user account.
boolean	setPassword(User user, String key, String pwd) Set the Password of the Account to a given password.
void	updateAccount(User user, Map<String,RequestParameter[]> properties) Convenience update an Account with a set of properties with setting properties in one method call.

Method Detail

findAccount

User findAccount(String fragment)

Parameters:

fragment - of the id / name

Returns:

User or null if no User is related to the fragment

createAccount

User createAccount(String uid,
                 String pwd,
                 String group,
                 Map<String,RequestParameter[]> properties)
                   throws AccessDeniedException,
                          RepositoryException

Convenience to create a new User together with setting properties in one method call. Where the keys are the propertie names and the value the

Parameters:

uid - to create account for

pwd - to set on the new user account

group - to assign membership to the new group

properties - to set

Returns:

User or null if no User is related to the fragment

Throws:

javax.jcr.RepositoryException - in case of error creating the user

javax.jcr.AccessDeniedException - in case of missing privileges to create accounts

AccessDeniedException

RepositoryException

See Also:

UserManager.createUser(String, String, String, String)

updateAccount

void updateAccount(User user,
                 Map<String,RequestParameter[]> properties)
                   throws RepositoryException

Convenience update an Account with a set of properties with setting properties in one method call.

Parameters:

user - to update

properties - to set

Throws:

RepositoryException - in case of error updateing the account

getOrCreateAccount

User getOrCreateAccount(String id,
                      String pwd,
                      String group,
                      Map<String,RequestParameter[]> properties)
                        throws AccessDeniedException,
                               RepositoryException

Convenenience to either search and update an existing account or create it

Parameters:

id - of the account to update or to use for creation

pwd - in case the acoount should be created

group - to assign to a newly created user

properties - to set to the user

Returns:

account modified

Throws:

javax.jcr.RepositoryException - in case of error creating the user

javax.jcr.AccessDeniedException - in case of missing privileges to create accounts

AccessDeniedException

RepositoryException

See Also:

findAccount(String), createAccount(String, String, String, Map), updateAccount(User, Map)

resetPassword

String resetPassword(User user)
                     throws AccessDeniedException,
                            RepositoryException

Reset the Password of the Account to a randomly generated

Parameters:

user - to reset the password for

Returns:

the newly generated password

Throws:

javax.jcr.RepositoryException - in case of error creating the user

javax.jcr.AccessDeniedException - in case of missing privileges to create accounts

AccessDeniedException

RepositoryException

resetPassword

String resetPassword(User user,
                   String key)
                     throws AccessDeniedException,
                            RepositoryException

Reset the Password of the Account to a randomly generated, requires a key in order to verify, that the reset has been requested by the key owner. The key is the result of the call to request o password reset requestPasswordReset(User, URL)

Parameters:

user - to reset the password for

key - required to reset the password

Returns:

the newly generated password or null on failure

Throws:

javax.jcr.RepositoryException - in case of error creating the user

javax.jcr.AccessDeniedException - in case of missing privileges to create accounts

AccessDeniedException

RepositoryException

See Also:

requestPasswordReset(User, URL)

setPassword

boolean setPassword(User user,
                  String key,
                  String pwd)
                    throws AccessDeniedException,
                           RepositoryException

Set the Password of the Account to a given password. Requires a key in order to verify, that the reset has been requested by the key owner. The key is the result of the call to request o password reset requestPasswordReset(User, URL)

Parameters:

user - to reset the password for

key - required to set the password

pwd - new password

Returns:

true on success, false on failure

Throws:

javax.jcr.RepositoryException - in case of error creating the user

javax.jcr.AccessDeniedException - in case of missing privileges to create accounts

AccessDeniedException

RepositoryException

See Also:

requestPasswordReset(User, URL)

requestPasswordReset

boolean requestPasswordReset(User user,
                           URL requestUrl)
                             throws RepositoryException

Request a password rest. Results in a key that has to be presented in order to finally set the Password to some new value.

Parameters:

user - to reset the password for

requestUrl - the url called to request the reset

Returns:

a key that allows to reset the password

Throws:

javax.jcr.RepositoryException - in case of error creating the user

javax.jcr.AccessDeniedException - in case of missing privileges to create accounts

RepositoryException

See Also:

resetPassword(User, String)

requestAccount

boolean requestAccount(String email,
                     URL requestUrl)
                       throws RepositoryException

Request for creating a new account. Results in a mail being sent to the requester which contains further information how to complete account generation.

Parameters:

email - email address of requester

requestUrl - the url called to request the reset

Returns:

true if account request succeeded, false otherwise

Throws:

RepositoryException

sendMail

boolean sendMail(User user,
               String from,
               String subject,
               String body,
               Map<String,String> replace)
                 throws RepositoryException

Simple utility to send a mail to a given user account. Adds the ability to replace variables within the mail body with properties from the User. This Properties can be addressed by useing their name as variabl name.

Parameters:

user - to receive the mail

from - the from e-mail address

subject - of the mail to send

body - of the mail to send

replace - map of replacements for variables, with variable name as key and value as value

Returns:

true if the mail could be send

Throws:

RepositoryException - in case of error accessing the repository