Package com.broadleafcommerce.customer.web.endpoint

Class CustomerSegmentExportEndpoint

java.lang.Object

com.broadleafcommerce.customer.web.endpoint.CustomerSegmentExportEndpoint

@FrameworkRestController
@DataRouteByExample(CustomerSegment.class)
public class CustomerSegmentExportEndpoint
extends Object

Constructor Summary

Constructors

Constructor	Description
CustomerSegmentExportEndpoint(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, javax.servlet.http.HttpServletResponse response)
com.broadleafcommerce.common.dataexport.domain.Export	exportSegmentMembers(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>	readCustomerSegmentExportsForAuthor(String segmentId, 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 Detail

CustomerSegmentExportEndpoint

public CustomerSegmentExportEndpoint(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/segments/{id}")
@Policy(permissionRoots="CUSTOMER_SEGMENT")
public org.springframework.http.ResponseEntity<?> readExportById(@PathVariable("id")
                                                                 String exportId,
                                                                 @ContextOperation(READ)
                                                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

exportSegmentMembers

@FrameworkPostMapping(value="/exports/segments",
                      consumes="application/json")
@Policy(permissionRoots="CUSTOMER_SEGMENT")
public com.broadleafcommerce.common.dataexport.domain.Export exportSegmentMembers(@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/segments/{id}/download")
@Policy(permissionRoots="CUSTOMER_SEGMENT")
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)

readCustomerSegmentExportsForAuthor

@FrameworkGetMapping("/my-exports/segments")
@Policy(permissionRoots="CUSTOMER_SEGMENT")
public org.springframework.http.ResponseEntity<Object> readCustomerSegmentExportsForAuthor(@RequestParam("segmentId")
                                                                                           String segmentId,
                                                                                           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()