Package com.broadleafcommerce.customer.web.endpoint

Class 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

      All Methods Instance Methods Concrete Methods 
      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, javax.servlet.http.HttpServletResponse response)  
      com.broadleafcommerce.common.dataexport.domain.Export exportCustomers​(String filterString, com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)  
      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> 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)  

    • Constructor Detail

      • 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 Detail

      • 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

        @FrameworkPostMapping(value="/exports/customers",
                      consumes="application/json")
@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)

      • 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,
                                                                                                                                           javax.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()