Package com.broadleafcommerce.cart.web.endpoint

Class ItemListAccessRuleEndpoint<P extends com.broadleafcommerce.cart.client.domain.ItemListAccessRule>

java.lang.Object

com.broadleafcommerce.cart.web.endpoint.ItemListAccessRuleEndpoint<P>

@FrameworkRestController
@FrameworkMapping
@DataRouteByExample(com.broadleafcommerce.cart.client.domain.ItemListAccessRule.class)
public class ItemListAccessRuleEndpoint<P extends com.broadleafcommerce.cart.client.domain.ItemListAccessRule>
extends Object

Endpoint for managing item list access rules.

Author:

Jacob Mitash

Constructor Summary

Constructors

Constructor	Description
ItemListAccessRuleEndpoint(ItemListAccessRuleService<P> ruleService)

Method Summary

Modifier and Type	Method	Description
P	createItemListAccessRule(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, P requestBody)
List<P>	createItemListAccessRules(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, List<P> requestBody)
void	deleteItemListAccessRule(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, String accessRuleId)
void	deleteItemListAccessRules(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, Set<String> accessRuleIds)
com.broadleafcommerce.cart.client.domain.ItemListAccessResponse	getFilteredItemListIdsByRoles(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, com.broadleafcommerce.order.common.domain.CustomerRef customerRef, Set<String> roles, Set<String> listIds)
P	getItemListAccessRuleById(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, String accessRuleId, org.springframework.data.domain.Pageable pageable)
List<P>	getItemListAccessRulesByIds(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, Set<String> accessRuleIds)
org.springframework.data.domain.Page<P>	getItemListAccessRulesForCustomer(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, com.broadleafcommerce.order.common.domain.CustomerRef customerRef, org.springframework.data.domain.Pageable pageable)
P	getItemListAccessRulesForCustomerAndItemList(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, com.broadleafcommerce.order.common.domain.CustomerRef customerRef, String customerId, String itemListId)
org.springframework.data.domain.Page<P>	getItemListAccessRulesForItemList(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, org.springframework.data.domain.Pageable pageable)
protected ItemListAccessRuleService<P>	getRuleService()
P	replaceItemListAccessRule(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, String accessRuleId, P requestBody)
List<P>	replaceItemListAccessRules(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, List<P> requestBody)
P	updateItemListAccessRule(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, String accessRuleId, P requestBody)
List<P>	updateItemListAccessRules(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemListId, List<P> requestBody)

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemListAccessRuleEndpoint

public ItemListAccessRuleEndpoint(ItemListAccessRuleService<P> ruleService)

Method Detail

getItemListAccessRulesForCustomer

@Policy(permissionRoots="CART")
@FrameworkGetMapping("/customers/{customerId}/item-list-access-rules")
public org.springframework.data.domain.Page<P> getItemListAccessRulesForCustomer(@ContextOperation(READ)
                                                                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                 com.broadleafcommerce.order.common.domain.CustomerRef customerRef,
                                                                                 @PageableDefault
                                                                                 org.springframework.data.domain.Pageable pageable)

getItemListAccessRulesForCustomerAndItemList

@Policy(permissionRoots="CART")
@FrameworkGetMapping("/customers/{customerId}/item-list-access-rules/{itemListId}")
public P getItemListAccessRulesForCustomerAndItemList(@ContextOperation(READ)
                                                      com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                      com.broadleafcommerce.order.common.domain.CustomerRef customerRef,
                                                      @PathVariable
                                                      String customerId,
                                                      @PathVariable
                                                      String itemListId)

getFilteredItemListIdsByRoles

@Policy(permissionRoots="CART")
@FrameworkGetMapping("/customers/{customerId}/item-list-access-by-roles")
public com.broadleafcommerce.cart.client.domain.ItemListAccessResponse getFilteredItemListIdsByRoles(@ContextOperation(READ)
                                                                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                                     com.broadleafcommerce.order.common.domain.CustomerRef customerRef,
                                                                                                     @RequestParam
                                                                                                     Set<String> roles,
                                                                                                     @RequestParam
                                                                                                     Set<String> listIds)

getItemListAccessRulesForItemList

@Policy(permissionRoots="CART")
@FrameworkGetMapping("/item-lists/{itemListId}/access-rules")
public org.springframework.data.domain.Page<P> getItemListAccessRulesForItemList(@ContextOperation(READ)
                                                                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                 @PathVariable
                                                                                 String itemListId,
                                                                                 @PageableDefault
                                                                                 org.springframework.data.domain.Pageable pageable)

getItemListAccessRuleById

@Policy(permissionRoots="CART")
@FrameworkGetMapping("/item-lists/{itemListId}/access-rules/{accessRuleId}")
public P getItemListAccessRuleById(@ContextOperation(READ)
                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                   @PathVariable
                                   String itemListId,
                                   @PathVariable
                                   String accessRuleId,
                                   @PageableDefault
                                   org.springframework.data.domain.Pageable pageable)

createItemListAccessRule

@Policy(permissionRoots="CART")
@FrameworkPostMapping("/item-lists/{itemListId}/access-rules")
public P createItemListAccessRule(@ContextOperation(CREATE)
                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                  @PathVariable
                                  String itemListId,
                                  @RequestBody
                                  P requestBody)

replaceItemListAccessRule

@Policy(permissionRoots="CART")
@FrameworkPutMapping("/item-lists/{itemListId}/access-rules/{accessRuleId}")
public P replaceItemListAccessRule(@ContextOperation(UPDATE)
                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                   @PathVariable
                                   String itemListId,
                                   @PathVariable
                                   String accessRuleId,
                                   @RequestBody
                                   P requestBody)

updateItemListAccessRule

@Policy(permissionRoots="CART")
@FrameworkPatchMapping("/item-lists/{itemListId}/access-rules/{accessRuleId}")
public P updateItemListAccessRule(@ContextOperation(UPDATE)
                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                  @PathVariable
                                  String itemListId,
                                  @PathVariable
                                  String accessRuleId,
                                  @RequestBody
                                  P requestBody)

deleteItemListAccessRule

@Policy(permissionRoots="CART")
@FrameworkDeleteMapping("/item-lists/{itemListId}/access-rules/{accessRuleId}")
public void deleteItemListAccessRule(@ContextOperation(DELETE)
                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                     @PathVariable
                                     String itemListId,
                                     @PathVariable
                                     String accessRuleId)

getItemListAccessRulesByIds

@Policy(permissionRoots="CART")
@FrameworkGetMapping(value="/item-lists/{itemListId}/bulk-access-rules",
                     params="accessRuleIds")
public List<P> getItemListAccessRulesByIds(@ContextOperation(READ)
                                           com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                           @PathVariable
                                           String itemListId,
                                           @RequestParam
                                           Set<String> accessRuleIds)

createItemListAccessRules

@Policy(permissionRoots="CART")
@FrameworkPostMapping("/item-lists/{itemListId}/bulk-access-rules")
public List<P> createItemListAccessRules(@ContextOperation(CREATE)
                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                         @PathVariable
                                         String itemListId,
                                         @RequestBody
                                         List<P> requestBody)

replaceItemListAccessRules

@Policy(permissionRoots="CART")
@FrameworkPutMapping("/item-lists/{itemListId}/bulk-access-rules")
public List<P> replaceItemListAccessRules(@ContextOperation(UPDATE)
                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                          @PathVariable
                                          String itemListId,
                                          @RequestBody
                                          List<P> requestBody)

updateItemListAccessRules

@Policy(permissionRoots="CART")
@FrameworkPatchMapping("/item-lists/{itemListId}/bulk-access-rules")
public List<P> updateItemListAccessRules(@ContextOperation(UPDATE)
                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                         @PathVariable
                                         String itemListId,
                                         @RequestBody
                                         List<P> requestBody)

deleteItemListAccessRules

@Policy(permissionRoots="CART")
@FrameworkDeleteMapping(value="/item-lists/{itemListId}/bulk-access-rules",
                        params="accessRuleIds")
public void deleteItemListAccessRules(@ContextOperation(DELETE)
                                      com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                      @PathVariable
                                      String itemListId,
                                      @RequestParam
                                      Set<String> accessRuleIds)

getRuleService

protected ItemListAccessRuleService<P> getRuleService()