Package com.broadleafcommerce.content.web.endpoint

Class ContentItemEndpoint

java.lang.Object

com.broadleafcommerce.content.web.endpoint.ContentItemEndpoint

@FrameworkRestController
@FrameworkMapping("/content-items")
@DataRouteByExample(ContentItem.class)
public class ContentItemEndpoint
extends Object

Author:

Jon Fleschler (jfleschler)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
ContentItemEndpoint(ContentItemService<ContentItem> service, ContentItemHydrationService hydrationService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Summary

Modifier and Type	Method	Description
List<ContentItem>	bulkCloneContentItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, List<CloneContentItemRequest> cloneContentItemRequests)
ContentItem	cloneContentItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String contentItemId, CloneContentItemRequest cloneContentItemRequest)
ContentItem	createContentItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, ContentItem item)
org.springframework.http.ResponseEntity<Void>	deleteContentItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
protected String	getAuthenticatedUserId()
protected com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils	getAuthenticationUtils()
protected CloneContentItemService<ContentItem,CloneContentItemRequest>	getCloneContentItemSvc()
ContentItem	getEmptyContentItemForModel(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String modelId)
protected ContentFolderItemService<ContentFolderItem>	getFolderItemService()
protected ContentItemHydrationService	getHydrationService()
protected ContentItemService<ContentItem>	getService()
protected StarredItemService<StarredItem>	getStarredItemService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
org.springframework.data.domain.Page<ContentItem>	readAllContentItems(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String nameQuery, String activeFilter, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
org.springframework.data.domain.Page<ContentItem>	readAllContentItemsByQuery(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String query, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
Collection<ContentTag>	readAllContentItemsTags(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<ContentItem>	readAllNonEmptyUriContentItems(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, org.springframework.data.domain.Pageable page)
ContentItem	readContentItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
org.springframework.data.domain.Page<ContentItem>	readStarredContentItems(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String nameQuery, boolean starred, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllItemTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
ContentItem	replaceContentItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, ContentItem item)
void	setAuthenticationUtils(com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils)
void	setCloneContentItemSvc(CloneContentItemService<ContentItem,CloneContentItemRequest> cloneContentItemSvc)
void	setFolderItemService(ContentFolderItemService<ContentFolderItem> folderItemService)
void	setStarredItemService(StarredItemService<StarredItem> starredItemService)
ContentItem	updateContentItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, ContentItem item)

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

ContentItemEndpoint

public ContentItemEndpoint(ContentItemService<ContentItem> service,
 ContentItemHydrationService hydrationService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Details

readAllContentItems

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

readAllNonEmptyUriContentItems

@Policy(permissionRoots="CONTENT")
@FrameworkGetMapping(params="addressableByUri=true")
public org.springframework.data.domain.Page<ContentItem> readAllNonEmptyUriContentItems(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

readStarredContentItems

@Policy(permissionRoots="CONTENT",
        identityTypes=ADMIN)
@FrameworkGetMapping(params="starred=true")
public org.springframework.data.domain.Page<ContentItem> readStarredContentItems(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestParam(value="q",required=false)
 String nameQuery,
 @RequestParam("starred")
 boolean starred,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

readAllContentItemsByQuery

@Policy(permissionRoots="CONTENT")
@FrameworkGetMapping("/search")
public org.springframework.data.domain.Page<ContentItem> readAllContentItemsByQuery(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestParam("q")
 String query,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

readAllContentItemsTags

@Policy(permissionRoots="CONTENT")
@FrameworkGetMapping("/tags")
public Collection<ContentTag> readAllContentItemsTags(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getEmptyContentItemForModel

@Policy(permissionRoots="CONTENT")
@FrameworkGetMapping("/create/{modelId}")
public ContentItem getEmptyContentItemForModel(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("modelId")
 String modelId)

readContentItem

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

createContentItem

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

updateContentItem

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

replaceContentItem

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

deleteContentItem

@Policy(permissionRoots="CONTENT")
@FrameworkDeleteMapping("/{id}")
public org.springframework.http.ResponseEntity<Void> deleteContentItem(@ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

replaceAllItemTranslations

@FrameworkPutMapping(value="/{id}/translations/{locale}",
                     consumes="application/json")
@Policy(permissionRoots="CONTENT")
public com.broadleafcommerce.translation.service.dto.TranslationsPayload replaceAllItemTranslations(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id,
 @PathVariable("locale")
 Locale locale,
 @RequestBody
 com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)

cloneContentItem

@FrameworkPostMapping("/{id}/clone")
@Policy(permissionRoots="CONTENT")
public ContentItem cloneContentItem(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String contentItemId,
 @RequestBody
 CloneContentItemRequest cloneContentItemRequest)

bulkCloneContentItem

@FrameworkPostMapping("/bulk-clone")
@Policy(permissionRoots="CONTENT")
public List<ContentItem> bulkCloneContentItem(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 List<CloneContentItemRequest> cloneContentItemRequests)

getAuthenticatedUserId

protected String getAuthenticatedUserId()

getService

protected ContentItemService<ContentItem> getService()

getHydrationService

protected ContentItemHydrationService getHydrationService()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

getTranslationEntityService

protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> getTranslationEntityService()

getAuthenticationUtils

protected com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils getAuthenticationUtils()

setAuthenticationUtils

@Autowired
public void setAuthenticationUtils(com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils)

getStarredItemService

protected StarredItemService<StarredItem> getStarredItemService()

setStarredItemService

@Autowired
public void setStarredItemService(StarredItemService<StarredItem> starredItemService)

getFolderItemService

protected ContentFolderItemService<ContentFolderItem> getFolderItemService()

setFolderItemService

@Autowired
public void setFolderItemService(ContentFolderItemService<ContentFolderItem> folderItemService)

getCloneContentItemSvc

protected CloneContentItemService<ContentItem,CloneContentItemRequest> getCloneContentItemSvc()

setCloneContentItemSvc

@Autowired
public void setCloneContentItemSvc(CloneContentItemService<ContentItem,CloneContentItemRequest> cloneContentItemSvc)