Package com.broadleafcommerce.auth.resource.web.endpoint

Class UserPermissionEndpoint

java.lang.Object

com.broadleafcommerce.auth.resource.web.endpoint.UserPermissionEndpoint

@FrameworkRestController
@FrameworkMapping("/permissions")
public class UserPermissionEndpoint
extends Object

Endpoint for CRUD operations on UserPermissions

Author:

Chris Getz

Constructor Summary

Constructors

Constructor	Description
UserPermissionEndpoint(UserPermissionService<UserPermission> userPermissionService)

Method Summary

Modifier and Type	Method	Description
UserPermission	createPermission(UserPermission req)
void	deletePermission(String id)
protected UserPermissionService<UserPermission>	getUserPermissionService()
org.springframework.data.domain.Page<UserPermission>	readAllPermissions(String query, boolean accountPermission, boolean includeNonUserAssignablePermissions, org.springframework.data.domain.Pageable page)
Set<UserPermission>	readByIds(Collection<String> ids)
UserPermission	readPermission(String id)
UserPermission	replacePermission(String id, UserPermission req)

Methods inherited from class java.lang.Object

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

Constructor Details

UserPermissionEndpoint

public UserPermissionEndpoint(UserPermissionService<UserPermission> userPermissionService)

Method Details

readAllPermissions

@FrameworkGetMapping
@Policy(permissionRoots="PERMISSION",
        operationTypes=READ)
public org.springframework.data.domain.Page<UserPermission> readAllPermissions(@RequestParam(value="q",required=false)
 String query,
 @RequestParam(value="accountPermission",required=false,defaultValue="false")
 boolean accountPermission,
 @RequestParam(value="includeNonUserAssignablePermissions",required=false,defaultValue="false")
 boolean includeNonUserAssignablePermissions,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

readPermission

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="PERMISSION",
        operationTypes=READ)
public UserPermission readPermission(@PathVariable("id")
 String id)

createPermission

@FrameworkPostMapping
@Policy(permissionRoots="PERMISSION",
        operationTypes=CREATE)
public UserPermission createPermission(@RequestBody
 UserPermission req)

replacePermission

@FrameworkPutMapping("/{id}")
@Policy(permissionRoots="PERMISSION",
        operationTypes=UPDATE)
public UserPermission replacePermission(@PathVariable("id")
 String id,
 @RequestBody
 UserPermission req)

deletePermission

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="PERMISSION",
        operationTypes=DELETE)
public void deletePermission(@PathVariable("id")
 String id)

readByIds

@FrameworkGetMapping("/ids")
@Policy(permissionRoots="PERMISSION",
        operationTypes=READ)
public Set<UserPermission> readByIds(@RequestParam(name="ids")
 Collection<String> ids)

getUserPermissionService

protected UserPermissionService<UserPermission> getUserPermissionService()