Package org.apache.sling.jackrabbit.usermanager.impl.post

Class ChangeUserPasswordServlet

java.lang.Object

jakarta.servlet.GenericServlet

org.apache.sling.api.servlets.SlingJakartaSafeMethodsServlet

org.apache.sling.api.servlets.SlingJakartaAllMethodsServlet

org.apache.sling.jackrabbit.usermanager.impl.post.AbstractPostServlet

org.apache.sling.jackrabbit.usermanager.impl.post.AbstractAuthorizablePostServlet

org.apache.sling.jackrabbit.usermanager.impl.post.ChangeUserPasswordServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, ChangeUserPassword

public class ChangeUserPasswordServlet
extends AbstractAuthorizablePostServlet
implements ChangeUserPassword

Changes the password associated with a user.

Maps on to nodes of resourceType sling/user like /rep:system/rep:userManager/rep:users/ae/fd/3e/ieb mapped to a resource url /system/userManager/user/ieb. This servlet responds at /system/userManager/user/ieb.changePassword.html

Methods

• POST

Post Parameters

oldPwd

The current password for the user (required for non-administrators)

newPwd

The new password for the user (required)

newPwdConfirm

The confirm new password for the user (required)

Response

200

Success sent with no body

404

If the user was not found.

500

Failure, including password validation errors. HTML explains the failure.

Example

curl -FoldPwd=oldpassword -FnewPwd=newpassword -FnewPwdConfirm=newpassword http://localhost:8080/system/userManager/user/ieb.changePassword.html

Notes

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	ChangeUserPasswordServlet.Config

Field Summary

Fields inherited from class org.apache.sling.jackrabbit.usermanager.impl.post.AbstractAuthorizablePostServlet

principalNameFilter, principalNameGenerators, PROP_DATE_FORMAT, RP_NODE_NAME_HINT_VALUE_FROM, RP_NODE_NAME_VALUE_FROM, systemUserManagerPaths

Constructor Summary

Constructors

Constructor	Description
ChangeUserPasswordServlet()

Method Summary

Modifier and Type	Method	Description
protected void	activate(Map<String,Object> props)	Activates this component.
protected void	bindPostResponseCreator(org.apache.sling.servlets.post.JakartaPostResponseCreator creator, Map<String,Object> properties)	Overridden since the @Reference annotation is not inherited from the super method
org.apache.jackrabbit.api.security.user.User	changePassword(javax.jcr.Session jcrSession, String name, String oldPassword, String newPassword, String newPasswordConfirm, List<org.apache.sling.servlets.post.Modification> changes)	Update the password of a user in the repository
protected void	deactivate()
protected void	handleOperation(org.apache.sling.api.SlingJakartaHttpServletRequest request, org.apache.sling.servlets.post.JakartaPostResponse response, List<org.apache.sling.servlets.post.Modification> changes)	Extending Servlet should implement this operation to do the work
protected void	unbindPostResponseCreator(org.apache.sling.servlets.post.JakartaPostResponseCreator creator, Map<String,Object> properties)	Unbind a post response creator

Methods inherited from class org.apache.sling.jackrabbit.usermanager.impl.post.AbstractAuthorizablePostServlet

bindPrincipalNameFilter, bindPrincipalNameGenerator, bindSystemUserManagerPaths, collectContentMap, concatPath, convertToRequestParameterArray, convertToString, convertToStringArray, getOrGeneratePrincipalName, hasItemPathPrefix, processCreate, processDeletes, requireItemPathPrefix, unbindPrincipalNameFilter, unbindPrincipalNameGenerator, writeContent

Methods inherited from class org.apache.sling.jackrabbit.usermanager.impl.post.AbstractPostServlet

doPost, externalizePath, getItemPath, getRanking, getRedirectUrl, isSetStatus

Methods inherited from class org.apache.sling.api.servlets.SlingJakartaAllMethodsServlet

doDelete, doPut, getAllowedRequestMethods, isMethodValid, mayService

Methods inherited from class org.apache.sling.api.servlets.SlingJakartaSafeMethodsServlet

doGeneric, doGet, doHead, doOptions, doTrace, getServletInfo, handleMethodNotImplemented, service, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ChangeUserPasswordServlet

public ChangeUserPasswordServlet()

Method Details

activate

protected void activate(Map<String,Object> props)

Activates this component.

Overrides:

activate in class AbstractAuthorizablePostServlet

Parameters:

props - The component properties

deactivate

protected void deactivate()

Overrides:

deactivate in class AbstractAuthorizablePostServlet

bindPostResponseCreator

protected void bindPostResponseCreator(org.apache.sling.servlets.post.JakartaPostResponseCreator creator,
 Map<String,Object> properties)

Overridden since the @Reference annotation is not inherited from the super method

Overrides:

bindPostResponseCreator in class AbstractPostServlet

See Also:

• AbstractPostServlet.bindPostResponseCreator(org.apache.sling.servlets.post.JakartaPostResponseCreator, java.util.Map)

unbindPostResponseCreator

protected void unbindPostResponseCreator(org.apache.sling.servlets.post.JakartaPostResponseCreator creator,
 Map<String,Object> properties)

Description copied from class: AbstractPostServlet

Unbind a post response creator

Overrides:

unbindPostResponseCreator in class AbstractPostServlet

handleOperation

protected void handleOperation(org.apache.sling.api.SlingJakartaHttpServletRequest request,
 org.apache.sling.servlets.post.JakartaPostResponse response,
 List<org.apache.sling.servlets.post.Modification> changes)
                        throws javax.jcr.RepositoryException

Description copied from class: AbstractPostServlet

Extending Servlet should implement this operation to do the work

Specified by:

handleOperation in class AbstractPostServlet

Parameters:

request - the sling http request to process

response - the response

changes - the changes to report

Throws:

javax.jcr.RepositoryException - in case of exceptions during the operation

changePassword

public org.apache.jackrabbit.api.security.user.User changePassword(javax.jcr.Session jcrSession,
 String name,
 String oldPassword,
 String newPassword,
 String newPasswordConfirm,
 List<org.apache.sling.servlets.post.Modification> changes)
                                                            throws javax.jcr.RepositoryException

Description copied from interface: ChangeUserPassword

Update the password of a user in the repository

Specified by:

changePassword in interface ChangeUserPassword

Parameters:

jcrSession - the JCR session of the user updating the user

name - The name of the user to update (required)

oldPassword - The current password of the user (required for non-admin users)

newPassword - The password value to apply (required)

newPasswordConfirm - The password value to apply again (required)

changes - The list of changes for this operation (optional)

Returns:

the user whose password was changed

Throws:

javax.jcr.RepositoryException - if password can't be changed for some reason