Package com.broadleafcommerce.cartoperation.service.provider.external.payments

Class ExternalPaymentTransactionExecutionProvider

java.lang.Object

com.broadleafcommerce.cartoperation.service.provider.external.AbstractExternalProvider

com.broadleafcommerce.cartoperation.service.provider.external.payments.ExternalPaymentTransactionExecutionProvider

All Implemented Interfaces:

PaymentTransactionExecutionProvider

public class ExternalPaymentTransactionExecutionProvider
extends AbstractExternalProvider
implements PaymentTransactionExecutionProvider

Author:

Chris Kittrell (ckittrell)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_HEADER_PAYMENT_LOCK_TOKEN
static final String	DEFAULT_HEADER_PAYMENT_VERSION

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

ENTITY_NOT_FOUND

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TransactionExecutionResponse	authorizeAndCapturePayment(@NonNull String paymentId, @NonNull Integer paymentVersion, @NonNull TransactionExecutionRequest request, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
TransactionExecutionResponse	authorizePayment(@NonNull String paymentId, @NonNull Integer paymentVersion, @NonNull TransactionExecutionRequest request, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected org.springframework.web.util.UriComponentsBuilder	getBaseUri()	Gets the base URI common to all requests this provider will make.
protected String	getServiceClient()
TransactionExecutionResponse	handleExternalTransactionResult(@NonNull String gatewayType, @NonNull Map<String,Object> request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Looks up external payment transaction results & records them to the relevant transaction.
TransactionExecutionResponse	lookup3DSTransactionResult(@NonNull String paymentId, @NonNull String requestId, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Looks up the 3DS transaction results from the gateway.
TransactionExecutionResponse	lookupExternalTransactionResult(@NonNull String paymentId, @NonNull String requestId, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Looks up the external transaction results from the gateway.
PaymentCallbackValidationResponse	validatePaymentCallbackToken(@NonNull PaymentCallbackValidationRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the payment callback and returns the validation results in the PaymentCallbackValidationResponse for interpretation.

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

buildNotFoundException, executeRequest, getHeaders, getObjectMapper, getTypeFactory, getWebClient, isEntityNotFound, pageableToParams, uriVars

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_HEADER_PAYMENT_VERSION

public static final String DEFAULT_HEADER_PAYMENT_VERSION

See Also:

• Constant Field Values

DEFAULT_HEADER_PAYMENT_LOCK_TOKEN

public static final String DEFAULT_HEADER_PAYMENT_LOCK_TOKEN

See Also:

• Constant Field Values

Constructor Details

ExternalPaymentTransactionExecutionProvider

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

Method Details

authorizePayment

public TransactionExecutionResponse authorizePayment(@NonNull
 @NonNull String paymentId,
 @NonNull
 @NonNull Integer paymentVersion,
 @NonNull
 @NonNull TransactionExecutionRequest request,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Specified by:

authorizePayment in interface PaymentTransactionExecutionProvider

authorizeAndCapturePayment

public TransactionExecutionResponse authorizeAndCapturePayment(@NonNull
 @NonNull String paymentId,
 @NonNull
 @NonNull Integer paymentVersion,
 @NonNull
 @NonNull TransactionExecutionRequest request,
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Specified by:

authorizeAndCapturePayment in interface PaymentTransactionExecutionProvider

lookup3DSTransactionResult

public TransactionExecutionResponse lookup3DSTransactionResult(@NonNull
 @NonNull String paymentId,
 @NonNull
 @NonNull String requestId,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentTransactionExecutionProvider

Looks up the 3DS transaction results from the gateway. If the results are present in the payment gateway, but not in Payment Transaction Services, then record the results; otherwise, return the existing transaction results.

Specified by:

lookup3DSTransactionResult in interface PaymentTransactionExecutionProvider

Parameters:

paymentId - the id of the payment that contains a reference to the required 3DS transaction

requestId - The id representing this request to checkout

lockToken - the token that owns the payment lock

contextInfo - context information around sandbox and multitenant state

Returns:

a TransactionExecutionResponse object describing the result of the transaction

lookupExternalTransactionResult

public TransactionExecutionResponse lookupExternalTransactionResult(@NonNull
 @NonNull String paymentId,
 @NonNull
 @NonNull String requestId,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentTransactionExecutionProvider

Looks up the external transaction results from the gateway. If the results are present in the payment gateway, but not in Payment Transaction Services, then record the results; otherwise, return the existing transaction results.

Specified by:

lookupExternalTransactionResult in interface PaymentTransactionExecutionProvider

Parameters:

paymentId - the id of the payment that contains a reference to the required external transaction

requestId - The id representing this request to checkout

lockToken - the token that owns the payment lock

contextInfo - context information around sandbox and multitenant state

Returns:

a TransactionExecutionResponse object describing the result of the transaction

validatePaymentCallbackToken

public PaymentCallbackValidationResponse validatePaymentCallbackToken(@NonNull
 @NonNull PaymentCallbackValidationRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentTransactionExecutionProvider

Validates the payment callback and returns the validation results in the PaymentCallbackValidationResponse for interpretation.

Specified by:

validatePaymentCallbackToken in interface PaymentTransactionExecutionProvider

Parameters:

request - the validation request to perform on this payment callback

contextInfo - context information related to multitenancy

Returns:

the result of the validation

handleExternalTransactionResult

public TransactionExecutionResponse handleExternalTransactionResult(@NonNull
 @NonNull String gatewayType,
 @NonNull
 @NonNull Map<String,Object> request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentTransactionExecutionProvider

Looks up external payment transaction results & records them to the relevant transaction.

Specified by:

handleExternalTransactionResult in interface PaymentTransactionExecutionProvider

Parameters:

gatewayType - The gateway used to process the transaction

request - A map of the payment-gateway-provided properties used to lookup the transaction

contextInfo - context information related to multitenancy.

Returns:

a TransactionExecutionResponse object describing the result of the transaction

getBaseUri

protected org.springframework.web.util.UriComponentsBuilder getBaseUri()

Gets the base URI common to all requests this provider will make.

Returns:

a URI components builder with the base URI set up

getServiceClient

protected String getServiceClient()