Package com.broadleafcommerce.payment.service.gateway.webhooks

Class DefaultCheckoutComGatewayWebhookHandler

java.lang.Object

com.broadleafcommerce.payment.service.gateway.webhooks.DefaultCheckoutComGatewayWebhookHandler

All Implemented Interfaces:

CheckoutComGatewayWebhookHandler, com.broadleafcommerce.paymentgateway.service.PaymentGatewayTypeAware, com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler

public class DefaultCheckoutComGatewayWebhookHandler
extends Object
implements CheckoutComGatewayWebhookHandler

Field Summary

Fields

Modifier and Type	Field	Description
static String	CKO_REQUEST_ID
static String	CKO_SIGNATURE

Constructor Summary

Constructors

Constructor	Description
DefaultCheckoutComGatewayWebhookHandler(WebhookSignatureUtil signatureUtil, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected CheckoutComWebhookResponse	convertRequestBody(String rawRequestBody)
protected com.broadleafcommerce.paymentgateway.domain.PaymentResponse	convertToPaymentResponse(@NonNull CheckoutComWebhookResponse webhookResponse, @NonNull String requestBody)
org.apache.commons.lang3.tuple.Pair<com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier,com.broadleafcommerce.paymentgateway.domain.PaymentResponse>	convertToPaymentResponse(@NonNull org.springframework.http.HttpHeaders headers, @NonNull String requestBody)
protected String	getApplicationId(@NonNull CheckoutComWebhookResponse webhookResponse)
String	getGatewayType()
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
protected WebhookSignatureUtil	getSignatureUtil()
protected String	getTenantId(@NonNull CheckoutComWebhookResponse webhookResponse)
protected com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier	getTransactionIdentifier(CheckoutComWebhookResponse webhookResponse)	Builds a TransactionIdentifier based on the transactionReferenceId & tenantId values gathered from the provided CheckoutComWebhookResponse.
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected boolean	isSignatureValid(@NonNull org.springframework.http.HttpHeaders headers, @NonNull String rawRequestBody)	Determines whether the CKO-Signature header is valid by building a hash of the request body, leveraging the secret API key as the hash key.
void	validate(org.springframework.http.HttpHeaders headers, String rawRequestBody)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler

buildFailedWebhookResponse, buildSuccessfulWebhookResponse

Field Detail

CKO_SIGNATURE

public static final String CKO_SIGNATURE

See Also:

Constant Field Values

CKO_REQUEST_ID

public static final String CKO_REQUEST_ID

See Also:

Constant Field Values

Constructor Detail

DefaultCheckoutComGatewayWebhookHandler

public DefaultCheckoutComGatewayWebhookHandler(WebhookSignatureUtil signatureUtil,
                                               com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                               com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Detail

validate

public void validate(org.springframework.http.HttpHeaders headers,
                     String rawRequestBody)
              throws com.broadleafcommerce.paymentgateway.service.exception.WebhookValidationException

Specified by:

validate in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler

Throws:

com.broadleafcommerce.paymentgateway.service.exception.WebhookValidationException

convertToPaymentResponse

public org.apache.commons.lang3.tuple.Pair<com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier,com.broadleafcommerce.paymentgateway.domain.PaymentResponse> convertToPaymentResponse(@NonNull
                                                                                                                                                                                                         @NonNull org.springframework.http.HttpHeaders headers,
                                                                                                                                                                                                         @NonNull
                                                                                                                                                                                                         @NonNull String requestBody)

Specified by:

convertToPaymentResponse in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler

getGatewayType

public String getGatewayType()

Specified by:

getGatewayType in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTypeAware

convertRequestBody

protected CheckoutComWebhookResponse convertRequestBody(String rawRequestBody)

getTransactionIdentifier

protected com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier getTransactionIdentifier(CheckoutComWebhookResponse webhookResponse)

Builds a TransactionIdentifier based on the transactionReferenceId & tenantId values gathered from the provided CheckoutComWebhookResponse.

Parameters:

webhookResponse - The webhook transaction result payload

Returns:

A TransactionIdentifier based on the transactionReferenceId & tenantId values gathered from the CheckoutComWebhookResponse

convertToPaymentResponse

protected com.broadleafcommerce.paymentgateway.domain.PaymentResponse convertToPaymentResponse(@NonNull
                                                                                               @NonNull CheckoutComWebhookResponse webhookResponse,
                                                                                               @NonNull
                                                                                               @NonNull String requestBody)

isSignatureValid

protected boolean isSignatureValid(@NonNull
                                   @NonNull org.springframework.http.HttpHeaders headers,
                                   @NonNull
                                   @NonNull String rawRequestBody)

Determines whether the CKO-Signature header is valid by building a hash of the request body, leveraging the secret API key as the hash key.

Parameters:

headers - The webhook request headers

rawRequestBody - The raw webhook request body, in the form of a String

Returns:

whether the CKO-Signature header is valid

getApplicationId

protected String getApplicationId(@NonNull
                                  @NonNull CheckoutComWebhookResponse webhookResponse)

getTenantId

protected String getTenantId(@NonNull
                             @NonNull CheckoutComWebhookResponse webhookResponse)

getSignatureUtil

protected WebhookSignatureUtil getSignatureUtil()

getObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

getTypeFactory

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