Package com.broadleafcommerce.content.web.endpoint

Class StarredItemEndpoint

java.lang.Object

com.broadleafcommerce.content.web.endpoint.StarredItemEndpoint

@FrameworkRestController
@FrameworkMapping("/starred-items")
@DataRouteByExample(StarredItem.class)
public class StarredItemEndpoint
extends Object

Author:

Susana Cruz (susanaccruz)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StarredItemEndpoint.BulkActionStarredItemsRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor

Description

StarredItemEndpoint(StarredItemService<StarredItem> service, com.broadleafcommerce.common.extension.TypeFactory typeFactory, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService, ContentItemService<ContentItem> contentItemService, ContentItemHydrationService hydrationService, com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils)

Method Summary

Modifier and Type	Method	Description
List<StarredItem>	bulkActionStarredItems(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, StarredItemEndpoint.BulkActionStarredItemsRequest request)
StarredItem	createStarredItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, StarredItem item)
org.springframework.http.ResponseEntity<Void>	deleteStarredItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
protected String	getAuthenticatedUserId()
protected com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils	getAuthenticationUtils()
protected ContentItemService<ContentItem>	getContentItemService()
protected ContentItemHydrationService	getHydrationService()
protected StarredItemService<StarredItem>	getService()
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>	readAllUserStarredContentItems(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageInfo)
StarredItem	replaceStarredItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, StarredItem item)
StarredItem	updateStarredItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, StarredItem 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

StarredItemEndpoint

public StarredItemEndpoint(StarredItemService<StarredItem> service,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService,
 ContentItemService<ContentItem> contentItemService,
 ContentItemHydrationService hydrationService,
 com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils)

Method Details

readAllUserStarredContentItems

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

createStarredItem

@Policy(permissionRoots="CONTENT",
        identityTypes=OWNER,
        ownerIdentifier="admin_user_id")
@FrameworkPostMapping(consumes="application/json")
public StarredItem createStarredItem(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 StarredItem item)

updateStarredItem

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

replaceStarredItem

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

deleteStarredItem

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

bulkActionStarredItems

@Policy(permissionRoots="CONTENT",
        identityTypes=OWNER,
        ownerIdentifier="admin_user_id")
@FrameworkPostMapping(value="/bulk",
                      consumes="application/json")
public List<StarredItem> bulkActionStarredItems(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 StarredItemEndpoint.BulkActionStarredItemsRequest request)

getAuthenticatedUserId

protected String getAuthenticatedUserId()

getService

protected StarredItemService<StarredItem> getService()

getTypeFactory

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

getTranslationEntityService

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

getContentItemService

protected ContentItemService<ContentItem> getContentItemService()

getHydrationService

protected ContentItemHydrationService getHydrationService()

getAuthenticationUtils

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