com.broadleafcommerce.auth.resource.web.endpoint

Class UserEndpoint

java.lang.Object

com.broadleafcommerce.auth.resource.web.endpoint.UserEndpoint

@FrameworkRestController
 @FrameworkMapping(value="/users")
public class UserEndpoint
extends Object

Endpoints for CRUD operations on User.

Author:

Samarth Dhruva (samarthd)

Constructor Summary

Constructors

Constructor and Description
UserEndpoint(UserService<User> userSvc, UserPasswordService<PasswordToken,User> userPasswordService, AuthorizedClientService<AuthorizedClient> clientService)

Method Summary

Modifier and Type	Method and Description
User	createUser(User user, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteUser(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected AuthorizedClientService<AuthorizedClient>	getClientService()
User	getUser(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected UserPasswordService<PasswordToken,User>	getUserPasswordService()
protected UserService<User>	getUserSvc()
org.springframework.data.domain.Page<User>	readAllUsers(org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
User	replaceUser(String id, User user, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	resetPassword(String username, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserEndpoint

public UserEndpoint(UserService<User> userSvc,
                    UserPasswordService<PasswordToken,User> userPasswordService,
                    AuthorizedClientService<AuthorizedClient> clientService)

Method Detail

readAllUsers

@FrameworkGetMapping
 @Policy(permissionRoots="AUTH_USER")
public org.springframework.data.domain.Page<User> readAllUsers(@PageableDefault(size=50)
                                                                                                                          org.springframework.data.domain.Pageable page,
                                                                                                                          @ContextOperation(value=READ)
                                                                                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getUser

@FrameworkGetMapping(value="/{id}")
 @Policy(permissionRoots="AUTH_USER")
public User getUser(@PathVariable(value="id")
                                                                                              String id,
                                                                                              @ContextOperation(value=READ)
                                                                                              com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

createUser

@FrameworkPostMapping
 @Policy(permissionRoots="AUTH_USER")
public User createUser(@RequestBody
                                                                                   User user,
                                                                                   @ContextOperation(value=CREATE)
                                                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

replaceUser

@FrameworkPutMapping(value="/{id}")
 @Policy(permissionRoots="AUTH_USER")
public User replaceUser(@PathVariable(value="id")
                                                                                                  String id,
                                                                                                  @RequestBody
                                                                                                  User user,
                                                                                                  @ContextOperation(value=UPDATE)
                                                                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteUser

@FrameworkDeleteMapping(value="/{id}")
 @Policy(permissionRoots="AUTH_USER")
public void deleteUser(@PathVariable(value="id")
                                                                                                    String id,
                                                                                                    @ContextOperation(value=DELETE)
                                                                                                    com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

resetPassword

@FrameworkGetMapping(value="/{username}/reset-password")
 @Policy(permissionRoots="AUTH_USER")
public void resetPassword(@PathVariable(value="username")
                                                                                                                         String username,
                                                                                                                         @ContextOperation(value=UPDATE)
                                                                                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getUserSvc

@NonNull
protected UserService<User> getUserSvc()

getUserPasswordService

@NonNull
protected UserPasswordService<PasswordToken,User> getUserPasswordService()

getClientService

@NonNull
protected AuthorizedClientService<AuthorizedClient> getClientService()