Package com.broadleafcommerce.vendor.web.endpoint

Class VendorEndpoint

java.lang.Object

com.broadleafcommerce.vendor.web.endpoint.VendorEndpoint

@FrameworkRestController
@FrameworkMapping("/vendors")
@DataRouteByExample(Vendor.class)
public class VendorEndpoint
extends Object

Author:

Jon Fleschler (jfleschler)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VENDORS_URI

Constructor Summary

Constructors

Constructor	Description
VendorEndpoint(VendorService<Vendor> vendorService)

Method Summary

Modifier and Type	Method	Description
Vendor	createVendorFromRequest(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, VendorCreationRequest vendorRequest)
void	deleteVendor(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
protected VendorService<Vendor>	getVendorService()
org.springframework.data.domain.Page<Vendor>	readAllVendors(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String nameQuery, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
Vendor	readVendor(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
Vendor	readVendorByRef(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String vendorRef)
Vendor	replaceVendor(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, Vendor vendor)

Methods inherited from class java.lang.Object

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

Field Details

VENDORS_URI

public static final String VENDORS_URI

See Also:

• Constant Field Values

Constructor Details

VendorEndpoint

public VendorEndpoint(VendorService<Vendor> vendorService)

Method Details

readAllVendors

@Policy(permissionRoots="VENDOR")
@FrameworkGetMapping
public org.springframework.data.domain.Page<Vendor> readAllVendors(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestParam(value="q",required=false)
 String nameQuery,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

readVendor

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

readVendorByRef

@Policy(permissionRoots="VENDOR")
@FrameworkGetMapping("/by-vendor-ref/{vendorRef}")
public Vendor readVendorByRef(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("vendorRef")
 String vendorRef)

createVendorFromRequest

@Policy(permissionRoots="VENDOR")
@FrameworkPostMapping(consumes="application/json")
public Vendor createVendorFromRequest(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 VendorCreationRequest vendorRequest)

replaceVendor

@Policy(permissionRoots="VENDOR")
@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
public Vendor replaceVendor(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id,
 @RequestBody
 Vendor vendor)

deleteVendor

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

getVendorService

protected VendorService<Vendor> getVendorService()