Package com.broadleafcommerce.vendor.chasepayment.service.hps.provider

Class DefaultHPSProvider

java.lang.Object

com.broadleafcommerce.vendor.chasepayment.provider.AbstractExternalProvider

com.broadleafcommerce.vendor.chasepayment.service.hps.provider.DefaultHPSProvider

All Implemented Interfaces:

HPSProvider

public class DefaultHPSProvider
extends AbstractExternalProvider
implements HPSProvider

Default implementation of HPSProvider.

Constructor Summary

Constructors

Constructor

Description

DefaultHPSProvider(org.springframework.web.reactive.function.client.WebClient webClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory, HPSProviderGlobalProperties hpsProviderGlobalProperties, HPSProviderDiscriminatedProperties hpsProviderDiscriminatedProperties, ChaseIdGenerator chaseIdGenerator, HPSCustomMerchantDataMapper hpsCustomMerchantDataMapper)

Method Summary

Modifier and Type	Method	Description
protected org.springframework.validation.Errors	buildErrorsForBlcInitRequest(BroadleafHPSOrderAbstractionInitRequest blcInitRequest)
protected String	buildRequiredDiscriminatedPropMissingErrorMessage(String missingPropertyFriendlyName, String applicationId, String tenantId)
protected ChaseIdGenerator	getChaseIdGenerator()
protected HPSProviderDiscriminatedProperties	getDiscriminatedProperties()
protected HPSProviderGlobalProperties	getGlobalProperties()
protected HPSCustomMerchantDataMapper	getHpsCustomMerchantDataMapper()
protected <T> T	getRequiredDiscriminatedPropValueOrThrow(BiFunction<String,String,T> discriminatedPropValueSupplier, String applicationId, String tenantId, String missingPropertyFriendlyName)
protected <T> T	getRequiredPropertyValueOrThrow(Supplier<T> propertyValueSupplier, Supplier<String> errorMessage)
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
BroadleafHPSOrderAbstractionInitResponse	performUidInitRequest(BroadleafHPSOrderAbstractionInitRequest hpsInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Execute the 'UID Init Request' from the Chase HPS Order Abstraction flow.
HPSOrderAbstractionQueryResponse	performUidQueryRequest(String uid, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Execute the 'UID Query Request' to obtain details/results about a particular UID.
protected void	populateBlcHPSOrderAbstractionInitResponse(HPSOrderAbstractionInitResponse chaseResponse, BroadleafHPSOrderAbstractionInitResponse blcResponseToPopulate, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	populateHpsInitBillingAddressParameters(HPSOrderAbstractionInitRequest payloadToPopulate, BroadleafHPSOrderAbstractionInitRequest blcInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Initialize the value of the billing address fields on HPSOrderAbstractionInitRequest
protected void	populateHpsInitCardIndicatorsParameter(HPSOrderAbstractionInitRequest payloadToPopulate, BroadleafHPSOrderAbstractionInitRequest blcInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Initialize the value of HPSOrderAbstractionInitRequest.getCard_indicators().
protected void	populateHpsInitCustomMerchantDataParameters(HPSOrderAbstractionInitRequest payloadToPopulate, BroadleafHPSOrderAbstractionInitRequest blcInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Initialize the value of the custom merchant data fields on HPSOrderAbstractionInitRequest
protected void	populateHpsInitDescriptionParameter(HPSOrderAbstractionInitRequest payloadToPopulate, BroadleafHPSOrderAbstractionInitRequest blcInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Initialize the value of HPSOrderAbstractionInitRequest.getDescription().
protected void	populateHpsInitFormNameParameter(HPSOrderAbstractionInitRequest payloadToPopulate, BroadleafHPSOrderAbstractionInitRequest blcInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Initialize the value of HPSOrderAbstractionInitRequest.getForm_name().
protected void	populateHpsInitOrderIdParameter(String resolvedTxnType, HPSOrderAbstractionInitRequest payloadToPopulate, BroadleafHPSOrderAbstractionInitRequest blcInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Initialize the value of HPSOrderAbstractionInitRequest.getOrder_id().
protected void	populateHpsInitTokenizeParameter(String resolvedTxnType, HPSOrderAbstractionInitRequest payloadToPopulate, BroadleafHPSOrderAbstractionInitRequest blcInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Initialize the value of HPSOrderAbstractionInitRequest.getTokenize().
protected void	populateHpsInitTotalAmountParameter(String resolvedTxnType, HPSOrderAbstractionInitRequest payloadToPopulate, BroadleafHPSOrderAbstractionInitRequest blcInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Initialize the value of HPSOrderAbstractionInitRequest.getTotal_amount().
protected void	populateHpsOrderAbstractionInitRequest(HPSOrderAbstractionInitRequest payloadToPopulate, BroadleafHPSOrderAbstractionInitRequest blcInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class com.broadleafcommerce.vendor.chasepayment.provider.AbstractExternalProvider

executeRequest, getApplicationId, getObjectMapper, getTenantId, getWebClient

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultHPSProvider

public DefaultHPSProvider(org.springframework.web.reactive.function.client.WebClient webClient,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 HPSProviderGlobalProperties hpsProviderGlobalProperties,
 HPSProviderDiscriminatedProperties hpsProviderDiscriminatedProperties,
 ChaseIdGenerator chaseIdGenerator,
 HPSCustomMerchantDataMapper hpsCustomMerchantDataMapper)

Method Details

performUidInitRequest

public BroadleafHPSOrderAbstractionInitResponse performUidInitRequest(BroadleafHPSOrderAbstractionInitRequest hpsInitRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: HPSProvider

Execute the 'UID Init Request' from the Chase HPS Order Abstraction flow.

Specified by:

performUidInitRequest in interface HPSProvider

Parameters:

hpsInitRequest - caller-provided details for the init request

contextInfo - context information around multitenant state

Returns:

response details about the result

populateHpsOrderAbstractionInitRequest

protected void populateHpsOrderAbstractionInitRequest(HPSOrderAbstractionInitRequest payloadToPopulate,
 BroadleafHPSOrderAbstractionInitRequest blcInitRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

populateHpsInitCardIndicatorsParameter

protected void populateHpsInitCardIndicatorsParameter(HPSOrderAbstractionInitRequest payloadToPopulate,
 BroadleafHPSOrderAbstractionInitRequest blcInitRequest,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Initialize the value of HPSOrderAbstractionInitRequest.getCard_indicators().

Parameters:

payloadToPopulate - the target instance to populate HPSOrderAbstractionInitRequest.getCard_indicators() for

blcInitRequest - caller-provided details in the original init request

contextInfo - context information about multitenant state

populateHpsInitTokenizeParameter

protected void populateHpsInitTokenizeParameter(String resolvedTxnType,
 HPSOrderAbstractionInitRequest payloadToPopulate,
 BroadleafHPSOrderAbstractionInitRequest blcInitRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Initialize the value of HPSOrderAbstractionInitRequest.getTokenize().

Parameters:

resolvedTxnType - the value that was determined to be used for HPSOrderAbstractionInitRequest.getTxn_type()

payloadToPopulate - the target instance to populate HPSOrderAbstractionInitRequest.getTokenize() for

blcInitRequest - caller-provided details in the original init request

contextInfo - context information about multitenant state

populateHpsInitTotalAmountParameter

protected void populateHpsInitTotalAmountParameter(String resolvedTxnType,
 HPSOrderAbstractionInitRequest payloadToPopulate,
 BroadleafHPSOrderAbstractionInitRequest blcInitRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Initialize the value of HPSOrderAbstractionInitRequest.getTotal_amount().

Parameters:

resolvedTxnType - the value that was determined to be used for HPSOrderAbstractionInitRequest.getTxn_type()

payloadToPopulate - the target instance to populate HPSOrderAbstractionInitRequest.getTotal_amount() for

blcInitRequest - caller-provided details in the original init request

contextInfo - context information about multitenant state

populateHpsInitOrderIdParameter

protected void populateHpsInitOrderIdParameter(String resolvedTxnType,
 HPSOrderAbstractionInitRequest payloadToPopulate,
 BroadleafHPSOrderAbstractionInitRequest blcInitRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Initialize the value of HPSOrderAbstractionInitRequest.getOrder_id().

Parameters:

resolvedTxnType - the value that was determined to be used for HPSOrderAbstractionInitRequest.getTxn_type()

payloadToPopulate - the target instance to populate HPSOrderAbstractionInitRequest.getOrder_id() for

blcInitRequest - caller-provided details in the original init request

contextInfo - context information about multitenant state

populateHpsInitDescriptionParameter

protected void populateHpsInitDescriptionParameter(HPSOrderAbstractionInitRequest payloadToPopulate,
 BroadleafHPSOrderAbstractionInitRequest blcInitRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Initialize the value of HPSOrderAbstractionInitRequest.getDescription().

Parameters:

payloadToPopulate - the target instance to populate HPSOrderAbstractionInitRequest.getDescription() for

blcInitRequest - caller-provided details in the original init request

contextInfo - context information about multitenant state

populateHpsInitFormNameParameter

protected void populateHpsInitFormNameParameter(HPSOrderAbstractionInitRequest payloadToPopulate,
 BroadleafHPSOrderAbstractionInitRequest blcInitRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Initialize the value of HPSOrderAbstractionInitRequest.getForm_name().

Parameters:

payloadToPopulate - the target instance to populate HPSOrderAbstractionInitRequest.getForm_name() for

blcInitRequest - caller-provided details in the original init request

contextInfo - context information about multitenant state

buildErrorsForBlcInitRequest

protected org.springframework.validation.Errors buildErrorsForBlcInitRequest(BroadleafHPSOrderAbstractionInitRequest blcInitRequest)

populateHpsInitBillingAddressParameters

protected void populateHpsInitBillingAddressParameters(HPSOrderAbstractionInitRequest payloadToPopulate,
 BroadleafHPSOrderAbstractionInitRequest blcInitRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Initialize the value of the billing address fields on HPSOrderAbstractionInitRequest

Parameters:

payloadToPopulate - the target instance to populate billing address fields for

blcInitRequest - caller-provided details in the original init request

contextInfo - context information about multitenant state

populateHpsInitCustomMerchantDataParameters

protected void populateHpsInitCustomMerchantDataParameters(HPSOrderAbstractionInitRequest payloadToPopulate,
 BroadleafHPSOrderAbstractionInitRequest blcInitRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Initialize the value of the custom merchant data fields on HPSOrderAbstractionInitRequest

Parameters:

payloadToPopulate - the target instance to populate custom merchant data fields for

blcInitRequest - caller-provided details in the original init request

contextInfo - context information about multitenant state

populateBlcHPSOrderAbstractionInitResponse

protected void populateBlcHPSOrderAbstractionInitResponse(HPSOrderAbstractionInitResponse chaseResponse,
 BroadleafHPSOrderAbstractionInitResponse blcResponseToPopulate,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getRequiredDiscriminatedPropValueOrThrow

protected <T> T getRequiredDiscriminatedPropValueOrThrow(BiFunction<String,String,T> discriminatedPropValueSupplier,
 @Nullable
 String applicationId,
 @Nullable
 String tenantId,
 String missingPropertyFriendlyName)

Type Parameters:

T - the type of the property value

Parameters:

discriminatedPropValueSupplier - a function that takes in applicationId and tenantId, and returns a property value

applicationId - the application ID to find the property value for

tenantId - the tenant ID to find the property value for

missingPropertyFriendlyName - the friendly name to include in an error message if not found

Returns:

the value for the discriminated property, if found

getRequiredPropertyValueOrThrow

protected <T> T getRequiredPropertyValueOrThrow(Supplier<T> propertyValueSupplier,
 Supplier<String> errorMessage)

buildRequiredDiscriminatedPropMissingErrorMessage

protected String buildRequiredDiscriminatedPropMissingErrorMessage(String missingPropertyFriendlyName,
 @Nullable
 String applicationId,
 @Nullable
 String tenantId)

performUidQueryRequest

public HPSOrderAbstractionQueryResponse performUidQueryRequest(String uid,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: HPSProvider

Execute the 'UID Query Request' to obtain details/results about a particular UID.

Specified by:

performUidQueryRequest in interface HPSProvider

Parameters:

uid - the UID for which to obtain details

contextInfo - context information around multitenant state

Returns:

response details about the result

getGlobalProperties

protected HPSProviderGlobalProperties getGlobalProperties()

getDiscriminatedProperties

protected HPSProviderDiscriminatedProperties getDiscriminatedProperties()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

getChaseIdGenerator

protected ChaseIdGenerator getChaseIdGenerator()

getHpsCustomMerchantDataMapper

protected HPSCustomMerchantDataMapper getHpsCustomMerchantDataMapper()