Class CustomerExportEndpoint

java.lang.Object
com.broadleafcommerce.customer.web.endpoint.CustomerExportEndpoint

@FrameworkRestController @DataRouteByExample(Customer.class) public class CustomerExportEndpoint extends Object
  • Constructor Summary

    Constructors
    Constructor
    Description
    CustomerExportEndpoint(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>
    downloadExport(String exportId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, jakarta.servlet.http.HttpServletResponse response)
     
    com.broadleafcommerce.common.dataexport.domain.Export
    exportCustomers(com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
     
    com.broadleafcommerce.common.dataexport.domain.Export
    exportCustomers(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.
    protected com.broadleafcommerce.common.dataexport.service.ExportDownloadService
     
    protected com.broadleafcommerce.common.dataexport.service.ExportManager
     
    protected com.broadleafcommerce.common.dataexport.service.ExportService<com.broadleafcommerce.common.dataexport.domain.Export>
     
    org.springframework.http.ResponseEntity<Object>
    readCustomerExportsForAuthor(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<?>
    readExportById(String exportId, 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

    • CustomerExportEndpoint

      public CustomerExportEndpoint(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

    • readExportById

      @FrameworkGetMapping("/exports/customers/{id}") @Policy(permissionRoots="CUSTOMER") public org.springframework.http.ResponseEntity<?> readExportById(@PathVariable("id") String exportId, @ContextOperation(READ) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    • exportCustomers

      @Deprecated(since="2.0.1", forRemoval=true) @FrameworkPostMapping(value="/exports/customers", consumes="application/json", params="cq") @Policy(permissionRoots="CUSTOMER") public com.broadleafcommerce.common.dataexport.domain.Export exportCustomers(@RequestParam(value="cq",defaultValue="",required=false) 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 exportCustomers(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.
    • exportCustomers

      @FrameworkPostMapping(value="/exports/customers", consumes="application/json") @Policy(permissionRoots="CUSTOMER") public com.broadleafcommerce.common.dataexport.domain.Export exportCustomers(@RequestBody com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, @ContextOperation(READ) com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    • downloadExport

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

      @FrameworkGetMapping("/my-exports/customers") @Policy(permissionRoots="CUSTOMER") public org.springframework.http.ResponseEntity<Object> readCustomerExportsForAuthor(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()