Package com.broadleafcommerce.catalog.web.endpoint.bulkoperation

Class CatalogBulkOperationsEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.bulkoperation.CatalogBulkOperationsEndpoint

@FrameworkRestController
@FrameworkMapping("/catalog-bulk/operations")
@DataRouteByExample(BulkOperation.class)
public class CatalogBulkOperationsEndpoint
extends Object

Since:

2.1.0-GA

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor

Description

CatalogBulkOperationsEndpoint(BulkOperationService<BulkOperation> bulkOperationService, BulkOperationItemService<BulkOperationItem> bulkOperationItemService, com.broadleafcommerce.common.messaging.notification.DetachedDurableMessageSender sender, com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
com.broadleafcommerce.bulk.v2.domain.InitializeItemResponse	addItemsToOperation(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, com.broadleafcommerce.bulk.v2.domain.InitializeItemRequest initializeItemRequest, String bulkOperationId)
BulkOperation	createBulkOperation(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, com.broadleafcommerce.bulk.v2.domain.BulkOperationRequest bulkOperationRequest)
protected BulkOperationItemService<BulkOperationItem>	getBulkOperationItemService()
protected BulkOperationService<BulkOperation>	getBulkOperationService()
protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node>	getParser()
protected com.broadleafcommerce.common.messaging.notification.DetachedDurableMessageSender	getSender()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
org.springframework.data.domain.Page<BulkOperation>	readAllBulkOperations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, ReadBulkOperationsRequest params)
BulkOperation	readBulkOperationById(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String bulkOperationId)
org.springframework.data.domain.Page<BulkOperationItem>	readBulkOperationItems(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String itemState, String bulkOperationId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
protected void	sendProcessBulkOperationRequest(@NonNull BulkOperation bulkOperation, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
BulkOperation	updateBulkOperationTotalRecordsCount(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String bulkOperationId, com.broadleafcommerce.bulk.v2.domain.BulkOperationTotalRecordCountRequest totalRecordsCountRequest)

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

CatalogBulkOperationsEndpoint

public CatalogBulkOperationsEndpoint(BulkOperationService<BulkOperation> bulkOperationService,
 BulkOperationItemService<BulkOperationItem> bulkOperationItemService,
 com.broadleafcommerce.common.messaging.notification.DetachedDurableMessageSender sender,
 com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

createBulkOperation

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="BULK_OPERATION")
public BulkOperation createBulkOperation(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 com.broadleafcommerce.bulk.v2.domain.BulkOperationRequest bulkOperationRequest)

readAllBulkOperations

@FrameworkGetMapping
@Policy(permissionRoots="BULK_OPERATION")
public org.springframework.data.domain.Page<BulkOperation> readAllBulkOperations(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 ReadBulkOperationsRequest params)

readBulkOperationById

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

updateBulkOperationTotalRecordsCount

@FrameworkPatchMapping("/{id}/total-records")
@Policy(permissionRoots="BULK_OPERATION")
public BulkOperation updateBulkOperationTotalRecordsCount(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String bulkOperationId,
 @RequestBody
 com.broadleafcommerce.bulk.v2.domain.BulkOperationTotalRecordCountRequest totalRecordsCountRequest)

readBulkOperationItems

@FrameworkGetMapping("/{id}/items")
@Policy(permissionRoots="BULK_OPERATION")
public org.springframework.data.domain.Page<BulkOperationItem> readBulkOperationItems(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam(value="itemState",required=false)
 String itemState,
 @PathVariable("id")
 String bulkOperationId,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

addItemsToOperation

@FrameworkPostMapping("/{id}/items")
@Policy(permissionRoots="BULK_OPERATION")
public com.broadleafcommerce.bulk.v2.domain.InitializeItemResponse addItemsToOperation(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 com.broadleafcommerce.bulk.v2.domain.InitializeItemRequest initializeItemRequest,
 @PathVariable("id")
 String bulkOperationId)

sendProcessBulkOperationRequest

protected void sendProcessBulkOperationRequest(@NonNull
 @NonNull BulkOperation bulkOperation,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getBulkOperationService

protected BulkOperationService<BulkOperation> getBulkOperationService()

getBulkOperationItemService

protected BulkOperationItemService<BulkOperationItem> getBulkOperationItemService()

getSender

protected com.broadleafcommerce.common.messaging.notification.DetachedDurableMessageSender getSender()

getParser

protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> getParser()

getTypeFactory

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