Package com.broadleafcommerce.content.web.endpoint

Class ContentModelEndpoint

java.lang.Object

com.broadleafcommerce.content.web.endpoint.ContentModelEndpoint

@FrameworkRestController
@FrameworkMapping("/content-models")
@DataRouteByExample(ContentModel.class)
public class ContentModelEndpoint
extends Object

Author:

Jon Fleschler (jfleschler)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
ContentModelEndpoint(ContentModelService<ContentModel> service)

Method Summary

Modifier and Type	Method	Description
ContentModel	createContentModel(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, ContentModel contentModel)
void	deleteContentModel(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
protected ContentModelService<ContentModel>	getService()
org.springframework.data.domain.Page<ContentModel>	readAllContentModels(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String nameQuery, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
ContentModel	readContentModel(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
ContentModel	replaceContentModel(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, ContentModel contentModel)

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

ContentModelEndpoint

public ContentModelEndpoint(ContentModelService<ContentModel> service)

Method Details

readAllContentModels

@Policy(permissionRoots="CONTENT")
@FrameworkGetMapping
public org.springframework.data.domain.Page<ContentModel> readAllContentModels(@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,sort="name",direction=ASC)
 org.springframework.data.domain.Pageable page)

readContentModel

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

createContentModel

@Policy(permissionRoots="CONTENT")
@FrameworkPostMapping(consumes="application/json")
public ContentModel createContentModel(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 ContentModel contentModel)

replaceContentModel

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

deleteContentModel

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

getService

protected ContentModelService<ContentModel> getService()