Package com.broadleafcommerce.catalog.web.endpoint

Class ProductExportEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.ProductExportEndpoint

@FrameworkRestController
@DataRouteByExample(Product.class)
public class ProductExportEndpoint
extends Object

Constructor Summary

Constructors

Constructor	Description
ProductExportEndpoint(com.broadleafcommerce.common.dataexport.service.ExportManager exportManager, com.broadleafcommerce.common.dataexport.service.ExportService<com.broadleafcommerce.common.dataexport.domain.Export> exportService, com.broadleafcommerce.common.dataexport.service.ExportDownloadService exportDownloadService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody>	downloadProductExport(String exportId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, jakarta.servlet.http.HttpServletResponse response)
void	exportProducts(com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
void	exportProducts(String filterString, com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Deprecated, for removal: This API element is subject to removal in a future version. since 2.0.1, in favor of exportProducts(ExportRequest, ContextInfo).
protected com.broadleafcommerce.common.dataexport.service.ExportDownloadService	getExportDownloadService()
protected com.broadleafcommerce.common.dataexport.service.ExportManager	getExportManager()
protected com.broadleafcommerce.common.dataexport.service.ExportService<com.broadleafcommerce.common.dataexport.domain.Export>	getExportService()
org.springframework.http.ResponseEntity<Object>	readProductExportsForAuthor(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.http.ResponseEntity<Object>	readProductExportsForSystem(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

ProductExportEndpoint

public ProductExportEndpoint(com.broadleafcommerce.common.dataexport.service.ExportManager exportManager,
 com.broadleafcommerce.common.dataexport.service.ExportService<com.broadleafcommerce.common.dataexport.domain.Export> exportService,
 com.broadleafcommerce.common.dataexport.service.ExportDownloadService exportDownloadService)

Method Details

exportProducts

@FrameworkPostMapping(value="/exports/products",
                      consumes="application/json")
@Policy(permissionRoots="PRODUCT")
public void exportProducts(@RequestBody
 com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

exportProducts

@Deprecated(since="2.0.1",
            forRemoval=true)
@FrameworkPostMapping(value="/exports/products",
                      consumes="application/json",
                      params="cq")
@Policy(permissionRoots="PRODUCT")
public void exportProducts(@RequestParam(value="cq",defaultValue="")
 String filterString,
 @RequestBody
 com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.1, in favor of exportProducts(ExportRequest, ContextInfo). The new implementation for export grids includes the filter string as part of the ExportRequest, instead of passing it as a parameter in the HTTP request.

downloadProductExport

@FrameworkGetMapping("/exports/products/{id}/download")
@Policy(permissionRoots="PRODUCT")
public org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody> downloadProductExport(@PathVariable("id")
 String exportId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 jakarta.servlet.http.HttpServletResponse response)

readProductExportsForAuthor

@FrameworkGetMapping("/my-exports/products")
@Policy(permissionRoots="PRODUCT")
public org.springframework.http.ResponseEntity<Object> readProductExportsForAuthor(cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable pageable,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readProductExportsForSystem

@FrameworkGetMapping("/exports/products")
@Policy(permissionRoots="PRODUCT")
public org.springframework.http.ResponseEntity<Object> readProductExportsForSystem(cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable pageable,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getExportManager

protected com.broadleafcommerce.common.dataexport.service.ExportManager getExportManager()

getExportService

protected com.broadleafcommerce.common.dataexport.service.ExportService<com.broadleafcommerce.common.dataexport.domain.Export> getExportService()

getExportDownloadService

protected com.broadleafcommerce.common.dataexport.service.ExportDownloadService getExportDownloadService()