Package com.broadleafcommerce.catalog.web.endpoint

Class CatalogAccessPolicyEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.CatalogAccessPolicyEndpoint

@FrameworkRestController
@FrameworkMapping("/catalog-access-policies")
@DataRouteByExample(CatalogAccessPolicy.class)
public class CatalogAccessPolicyEndpoint
extends Object

Author:

Nathan Moore (nathandmoore)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
CatalogAccessPolicyEndpoint(CatalogAccessPolicyService<CatalogAccessPolicy> service)

Method Summary

Modifier and Type	Method	Description
CatalogAccessPolicy	create(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, CatalogAccessPolicy req)
org.springframework.http.ResponseEntity<Void>	deleteById(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
protected CatalogAccessPolicyService<CatalogAccessPolicy>	getService()
org.springframework.data.domain.Page<CatalogAccessPolicy>	readAll(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String query, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
CatalogAccessPolicy	readById(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
CatalogAccessPolicy	replace(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, CatalogAccessPolicy req)
CatalogAccessPolicy	update(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, CatalogAccessPolicy req)

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

CatalogAccessPolicyEndpoint

public CatalogAccessPolicyEndpoint(CatalogAccessPolicyService<CatalogAccessPolicy> service)

Method Details

readAll

@FrameworkGetMapping
@Policy(permissionRoots="CATALOG_ACCESS_POLICY")
public org.springframework.data.domain.Page<CatalogAccessPolicy> readAll(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam(value="q",required=false)
 String query,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50,sort="name",direction=ASC)
 org.springframework.data.domain.Pageable page)

readById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="CATALOG_ACCESS_POLICY")
public CatalogAccessPolicy readById(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id)

update

@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
@Policy(permissionRoots="CATALOG_ACCESS_POLICY")
public CatalogAccessPolicy update(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id,
 @RequestBody
 CatalogAccessPolicy req)

replace

@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
@Policy(permissionRoots="CATALOG_ACCESS_POLICY")
public CatalogAccessPolicy replace(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id,
 @RequestBody
 CatalogAccessPolicy req)

create

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="CATALOG_ACCESS_POLICY")
public CatalogAccessPolicy create(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 CatalogAccessPolicy req)

deleteById

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="CATALOG_ACCESS_POLICY")
public org.springframework.http.ResponseEntity<Void> deleteById(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id)

getService

protected CatalogAccessPolicyService<CatalogAccessPolicy> getService()