Package com.broadleafcommerce.customer.web.endpoint

Class AccountRoleEndpoint

java.lang.Object

com.broadleafcommerce.customer.web.endpoint.AccountRoleEndpoint

@FrameworkRestController
@FrameworkMapping("/account-roles")
@DataRouteByExample(AccountRole.class)
public class AccountRoleEndpoint
extends Object

Endpoints for CRUD operations on AccountRole.

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

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

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

Author:

Samarth Dhruva (samarthd), Chris Kittrell (ckittrell)

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
AccountRoleEndpoint(AccountRoleService<AccountRole> accountRoleService)

Method Summary

Modifier and Type	Method	Description
AccountRole	createRole(AccountRole role, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteRole(String roleId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected AccountRoleService<AccountRole>	getAccountRoleService()
AccountRole	getRole(String roleId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.http.ResponseEntity<com.broadleafcommerce.common.error.ApiError>	handleInvalidAccountRoleDeleteException(InvalidAccountRoleDeleteException ex, org.springframework.web.context.request.WebRequest request)
protected void	logDebug(Exception ex, org.springframework.web.context.request.WebRequest request)
org.springframework.data.domain.Page<AccountRole>	readAllRoles(String name, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
AccountRole	replaceRole(String roleId, AccountRole role, 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

AccountRoleEndpoint

public AccountRoleEndpoint(AccountRoleService<AccountRole> accountRoleService)

Method Detail

readAllRoles

@FrameworkGetMapping
@Policy(permissionRoots="ACCOUNT_ROLE")
public org.springframework.data.domain.Page<AccountRole> readAllRoles(@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)

getRole

@FrameworkGetMapping("/{roleId}")
@Policy(permissionRoots="ACCOUNT_ROLE")
public AccountRole getRole(@PathVariable("roleId")
                           String roleId,
                           @ContextOperation(READ)
                           com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

createRole

@FrameworkPostMapping
@Policy(permissionRoots="ACCOUNT_ROLE")
public AccountRole createRole(@RequestBody
                              AccountRole role,
                              @ContextOperation(CREATE)
                              com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

replaceRole

@FrameworkPutMapping("/{roleId}")
@Policy(permissionRoots="ACCOUNT_ROLE")
public AccountRole replaceRole(@PathVariable("roleId")
                               String roleId,
                               @RequestBody
                               AccountRole role,
                               @ContextOperation(UPDATE)
                               com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteRole

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

handleInvalidAccountRoleDeleteException

@ExceptionHandler(InvalidAccountRoleDeleteException.class)
public org.springframework.http.ResponseEntity<com.broadleafcommerce.common.error.ApiError> handleInvalidAccountRoleDeleteException(InvalidAccountRoleDeleteException ex,
                                                                                                                                    org.springframework.web.context.request.WebRequest request)

See Also:

AccountRoleService.delete(String, ContextInfo)

logDebug

protected void logDebug(Exception ex,
                        org.springframework.web.context.request.WebRequest request)

getAccountRoleService

protected AccountRoleService<AccountRole> getAccountRoleService()