Package com.broadleafcommerce.adminuser.resource.web.endpoint

Class AdminUserEndpoint

java.lang.Object

com.broadleafcommerce.adminuser.resource.web.endpoint.AdminUserEndpoint

@FrameworkRestController
@FrameworkMapping("/users")
@DataRouteByExample(AdminUser.class)
public class AdminUserEndpoint
extends Object

Endpoints for CRUD operations on User.

Access control for user operations are based on application context (the applicationId found in the context request) for each endpoint. To access a user, application context must either be global or an application that the user is assigned to.

Author:

Samarth Dhruva (samarthd)

Field Summary

Fields

Modifier and Type	Field	Description
protected final AdminUserService<AdminUser>	userSvc

Constructor Summary

Constructors

Constructor	Description
AdminUserEndpoint(AdminUserService<AdminUser> userSvc)

Method Summary

Modifier and Type	Method	Description
AdminUser	createUser(AdminUser user, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteUser(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
AdminUser	getUser(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
AdminUser	getUser(Principal principal, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<AdminUser>	readAllUsers(String name, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
AdminUser	replaceUser(String id, AdminUser user, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
AdminUser	updateUserPreferences(Principal principal, UserPreferences preferences, 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

Field Details

userSvc

protected final AdminUserService<AdminUser> userSvc

Constructor Details

AdminUserEndpoint

public AdminUserEndpoint(AdminUserService<AdminUser> userSvc)

Method Details

getUser

@FrameworkGetMapping("/my-preferences")
@Policy(permissionRoots="ADMIN_USER",
        identityTypes=ADMIN)
public AdminUser getUser(Principal principal,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

updateUserPreferences

@FrameworkPatchMapping("/my-preferences")
@Policy(permissionRoots="ADMIN_USER",
        operationTypes=UPDATE,
        identityTypes=ADMIN)
public AdminUser updateUserPreferences(Principal principal,
 @RequestBody
 UserPreferences preferences,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAllUsers

@FrameworkGetMapping
@Policy(permissionRoots="ADMIN_USER")
public org.springframework.data.domain.Page<AdminUser> readAllUsers(@RequestParam(value="q",required=false)
 String name,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getUser

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

createUser

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

replaceUser

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

deleteUser

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