Package com.broadleafcommerce.customer.web.endpoint

Class AccountPermissionEndpoint

java.lang.Object

com.broadleafcommerce.customer.web.endpoint.AccountPermissionEndpoint

@FrameworkRestController
@FrameworkMapping("/account-permissions")
@DataRouteByExample(AccountPermission.class)
public class AccountPermissionEndpoint
extends Object

Endpoints for CRUD operations on AccountPermission.

Access control for these operations are based on tenant context for each endpoint.

Global permissions can be read in any context, but are immutable in all but the global context.

All other permissions can be read/modified in the global context or the tenant context the permission is assigned to. Tenant-level users can only create/modify permissions from their tenant.

Author:

Chris Kittrell (ckittrell)

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
AccountPermissionEndpoint(AccountPermissionService<AccountPermission> accountPermissionService)

Method Summary

Modifier and Type	Method	Description
AccountPermission	createPermission(AccountPermission permission, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deletePermission(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected AccountPermissionService<AccountPermission>	getAccountPermissionService()
AccountPermission	getPermission(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<AccountPermission>	readAllPermissions(String name, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
AccountPermission	replacePermission(String id, AccountPermission permission, 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 Detail

BASE_URI

public static final String BASE_URI

See Also:

Constant Field Values

Constructor Detail

AccountPermissionEndpoint

public AccountPermissionEndpoint(AccountPermissionService<AccountPermission> accountPermissionService)

Method Detail

readAllPermissions

@FrameworkGetMapping
@Policy(permissionRoots="ACCOUNT_PERMISSION")
public org.springframework.data.domain.Page<AccountPermission> readAllPermissions(@RequestParam(value="q",required=false)
                                                                                  String name,
                                                                                  @PageableDefault(size=50)
                                                                                  org.springframework.data.domain.Pageable page,
                                                                                  @ContextOperation(READ)
                                                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getPermission

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

createPermission

@FrameworkPostMapping
@Policy(permissionRoots="ACCOUNT_PERMISSION")
public AccountPermission createPermission(@RequestBody
                                          AccountPermission permission,
                                          @ContextOperation(CREATE)
                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

replacePermission

@FrameworkPutMapping("/{id}")
@Policy(permissionRoots="ACCOUNT_PERMISSION")
public AccountPermission replacePermission(@PathVariable("id")
                                           String id,
                                           @RequestBody
                                           AccountPermission permission,
                                           @ContextOperation(UPDATE)
                                           com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deletePermission

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

getAccountPermissionService

protected AccountPermissionService<AccountPermission> getAccountPermissionService()