Package com.broadleafcommerce.customersegment.web.endpoint

Class PreviewCustomerSegmentEndpoint

java.lang.Object

com.broadleafcommerce.customersegment.web.endpoint.PreviewCustomerSegmentEndpoint

@RestController
@RequestMapping(value="/preview-segments/json",
                produces={"application/json","application/xml"})
@ConditionalOnBroadleafModule(ENTERPRISE)
@ConditionalOnProperty("preview.customer.segments.rest")
public class PreviewCustomerSegmentEndpoint
extends Object

This is a secondary endpoint that should be used when working with previewing segments for a stateless API.

This is disabled from getting scanned by default and can be enabled by setting the property "preview.customer.segments.rest" to true.

Author:

Nick Crum ncrum

Field Summary

Fields

Modifier and Type	Field	Description
protected org.broadleafcommerce.common.crossapp.service.CrossAppAuthService	crossAppAuthService
protected final CustomerSegmentService	customerSegmentService
protected static final String	DEFAULT_LIMIT_PARAM_VALUE
protected final org.broadleafcommerce.common.security.service.ExploitProtectionService	exploitProtectionService
static final String	PREVIEW_SEGMENT_ENDPOINT_BASE_PATH

Constructor Summary

Constructors

Constructor	Description
PreviewCustomerSegmentEndpoint()

Method Summary

Modifier and Type	Method	Description
protected PreviewCustomerSegmentResponse	buildResponse(Collection<CustomerSegment> segments, Collection<CustomerSegment> previewSegments)
void	setCrossAppAuthService(org.broadleafcommerce.common.crossapp.service.CrossAppAuthService crossAppAuthService)
void	userNotAuthenticated()
PreviewCustomerSegmentResponse	viewPreviewSegments(jakarta.servlet.http.HttpServletRequest request, String filter, Integer limit)

Methods inherited from class java.lang.Object

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

Field Details

PREVIEW_SEGMENT_ENDPOINT_BASE_PATH

public static final String PREVIEW_SEGMENT_ENDPOINT_BASE_PATH

See Also:

• Constant Field Values

DEFAULT_LIMIT_PARAM_VALUE

protected static final String DEFAULT_LIMIT_PARAM_VALUE

See Also:

• Constant Field Values

customerSegmentService

protected final CustomerSegmentService customerSegmentService

exploitProtectionService

protected final org.broadleafcommerce.common.security.service.ExploitProtectionService exploitProtectionService

crossAppAuthService

protected org.broadleafcommerce.common.crossapp.service.CrossAppAuthService crossAppAuthService

Constructor Details

PreviewCustomerSegmentEndpoint

public PreviewCustomerSegmentEndpoint()

Method Details

setCrossAppAuthService

@Autowired(required=false)
public void setCrossAppAuthService(org.broadleafcommerce.common.crossapp.service.CrossAppAuthService crossAppAuthService)

viewPreviewSegments

@RequestMapping(value="",
                produces={"application/json","application/xml"})
public PreviewCustomerSegmentResponse viewPreviewSegments(jakarta.servlet.http.HttpServletRequest request,
 @RequestParam(value="filter",required=false)
 String filter,
 @RequestParam(value="limit",required=false,defaultValue="10")
 Integer limit)
                                                   throws org.broadleafcommerce.common.exception.ServiceException

Throws:

org.broadleafcommerce.common.exception.ServiceException

buildResponse

protected PreviewCustomerSegmentResponse buildResponse(Collection<CustomerSegment> segments,
 Collection<CustomerSegment> previewSegments)

userNotAuthenticated

@ResponseStatus(value=UNAUTHORIZED,
                reason="Not authorized")
@ExceptionHandler(java.lang.SecurityException.class)
public void userNotAuthenticated()