Package com.broadleafcommerce.orderoperation.service.provider.external

Class ExternalCampaignProvider

java.lang.Object

com.broadleafcommerce.orderoperation.service.provider.external.AbstractExternalProvider

com.broadleafcommerce.orderoperation.service.provider.external.ExternalCampaignProvider

All Implemented Interfaces:

CampaignProvider

public class ExternalCampaignProvider
extends AbstractExternalProvider
implements CampaignProvider

Author:

Sunny Yu

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CAMPAIGN_CLIENT_ID	Deprecated.

Fields inherited from class com.broadleafcommerce.orderoperation.service.provider.external.AbstractExternalProvider

RSQL_FILTER_PARAM

Constructor Summary

Constructors

Constructor	Description
ExternalCampaignProvider(org.springframework.web.reactive.function.client.WebClient webClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ExternalCampaignProperties properties)

Method Summary

Modifier and Type	Method	Description
CodeGenerationResult	generateCodesForVouchers(VoucherCodeGenerationRequest voucherCodeGenerationRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Generates CampaignCodes for voucher offers based on the given VoucherCodeGenerationRequest.
protected ExternalCampaignProperties	getProperties()
protected String	getServiceClient()

Methods inherited from class com.broadleafcommerce.orderoperation.service.provider.external.AbstractExternalProvider

executeRequest, getHeaders, getObjectMapper, getTypeFactory, getWebClient, pageableToParams

Methods inherited from class java.lang.Object

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

Field Detail

CAMPAIGN_CLIENT_ID

@Deprecated
protected static final String CAMPAIGN_CLIENT_ID

Deprecated.

See Also:

Constant Field Values

Constructor Detail

ExternalCampaignProvider

public ExternalCampaignProvider(org.springframework.web.reactive.function.client.WebClient webClient,
                                com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                com.broadleafcommerce.common.extension.TypeFactory typeFactory,
                                ExternalCampaignProperties properties)

Method Detail

generateCodesForVouchers

public CodeGenerationResult generateCodesForVouchers(VoucherCodeGenerationRequest voucherCodeGenerationRequest,
                                                     @Nullable
                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CampaignProvider

Generates CampaignCodes for voucher offers based on the given VoucherCodeGenerationRequest.

This method will generate and return the CampaignCodes in the same request, therefore it's meant for small batch of code generation only.

Specified by:

generateCodesForVouchers in interface CampaignProvider

Parameters:

voucherCodeGenerationRequest - the VoucherCodeGenerationRequest to generate the voucher CampaignCodes with

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

the CodeGenerationResult containing the generated voucher CampaignCodes based on the given VoucherCodeGenerationRequest

getServiceClient

protected String getServiceClient()

getProperties

protected ExternalCampaignProperties getProperties()