Package com.broadleafcommerce.myfatoorah.service.requestresponse

Class MyFatoorahCaptureRequestResponseTransformer

java.lang.Object

com.broadleafcommerce.myfatoorah.service.requestresponse.AbstractRequestResponseTransformer

com.broadleafcommerce.myfatoorah.service.requestresponse.MyFatoorahCaptureRequestResponseTransformer

All Implemented Interfaces:

RequestResponseTransformer

public class MyFatoorahCaptureRequestResponseTransformer
extends AbstractRequestResponseTransformer

The transformer for DefaultTransactionTypes.CAPTURE transaction type.

Author:

Dima Myroniuk (dmyroniuk)

Constructor Summary

Constructors

Constructor	Description
MyFatoorahCaptureRequestResponseTransformer(MyFatoorahConfigurationProperties configProperties, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected String	buildGatewayTransactionId(MyFatoorahResponse.InvoiceTransaction transaction)	Build the gateway transaction id using the payment id & track id, instead of using MyFatoorahResponse.InvoiceTransaction.getTransactionId() due to this field not being present in the webhook payload.
boolean	canHandle(@NonNull String transactionType)	Checks if this transformer can handle the specified transaction type.
Map<String,Object>	createMyFatoorahRequest(@NonNull MyFatoorahPaymentRequest myFatoorahPaymentRequest)	Creates the MyFatoorah request body based on MyFatoorahPaymentRequest.
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected boolean	isSuccessful(MyFatoorahResponse.InvoiceTransaction transaction)
com.broadleafcommerce.paymentgateway.domain.PaymentResponse	populatePaymentResponse(@NonNull MyFatoorahPaymentRequest myFatoorahPaymentRequest, @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse, @NonNull MyFatoorahResponse myFatoorahResponse)	Populates the payment response based on the response from the MyFatoorah API.
protected com.broadleafcommerce.paymentgateway.domain.PaymentResponse	populatePaymentResponse(@NonNull MyFatoorahPaymentRequest myFatoorahPaymentRequest, @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse, @NonNull MyFatoorahResponse myFatoorahResponse, MyFatoorahResponse.InvoiceTransaction transaction)
protected void	populateResponseMap(@NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse, @NonNull MyFatoorahResponse myFatoorahResponse, MyFatoorahResponse.InvoiceTransaction latestTransaction)

Methods inherited from class com.broadleafcommerce.myfatoorah.service.requestresponse.AbstractRequestResponseTransformer

getConfigProperties, getCurrencyCode, getGatewayResponseCode, getInvoiceAmount, getObjectMapper, getTransactionAmount, identifyFailureType, identifyLatestTransaction, putIfNotBlank

Methods inherited from class java.lang.Object

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

Constructor Details

MyFatoorahCaptureRequestResponseTransformer

public MyFatoorahCaptureRequestResponseTransformer(MyFatoorahConfigurationProperties configProperties,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

canHandle

public boolean canHandle(@NonNull
 @NonNull String transactionType)

Description copied from interface: RequestResponseTransformer

Checks if this transformer can handle the specified transaction type.

Parameters:

transactionType - the transaction type of the request

Returns:

true if this transformer can be used for the specified request

createMyFatoorahRequest

public Map<String,Object> createMyFatoorahRequest(@NonNull
 @NonNull MyFatoorahPaymentRequest myFatoorahPaymentRequest)

Description copied from interface: RequestResponseTransformer

Creates the MyFatoorah request body based on MyFatoorahPaymentRequest.

Specified by:

createMyFatoorahRequest in interface RequestResponseTransformer

Overrides:

createMyFatoorahRequest in class AbstractRequestResponseTransformer

Parameters:

myFatoorahPaymentRequest - the myFatoorah payment request

Returns:

the MyFatoorah request body

populatePaymentResponse

public com.broadleafcommerce.paymentgateway.domain.PaymentResponse populatePaymentResponse(@NonNull
 @NonNull MyFatoorahPaymentRequest myFatoorahPaymentRequest,
 @NonNull
 @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse,
 @NonNull
 @NonNull MyFatoorahResponse myFatoorahResponse)

Description copied from interface: RequestResponseTransformer

Populates the payment response based on the response from the MyFatoorah API.

Specified by:

populatePaymentResponse in interface RequestResponseTransformer

Overrides:

populatePaymentResponse in class AbstractRequestResponseTransformer

Parameters:

myFatoorahPaymentRequest - the myFatoorah payment request

paymentResponse - the payment response to populate

myFatoorahResponse - the response from MyFatoorah API

Returns:

the populated payment response

populatePaymentResponse

protected com.broadleafcommerce.paymentgateway.domain.PaymentResponse populatePaymentResponse(@NonNull
 @NonNull MyFatoorahPaymentRequest myFatoorahPaymentRequest,
 @NonNull
 @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse,
 @NonNull
 @NonNull MyFatoorahResponse myFatoorahResponse,
 @NonNull
 MyFatoorahResponse.InvoiceTransaction transaction)

isSuccessful

protected boolean isSuccessful(MyFatoorahResponse.InvoiceTransaction transaction)

buildGatewayTransactionId

protected String buildGatewayTransactionId(@NonNull
 MyFatoorahResponse.InvoiceTransaction transaction)

Build the gateway transaction id using the payment id & track id, instead of using MyFatoorahResponse.InvoiceTransaction.getTransactionId() due to this field not being present in the webhook payload.

Parameters:

transaction - The transaction results

Returns:

The gateway transaction id based on the payment id & track id

populateResponseMap

protected void populateResponseMap(@NonNull
 @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse,
 @NonNull
 @NonNull MyFatoorahResponse myFatoorahResponse,
 @NonNull
 MyFatoorahResponse.InvoiceTransaction latestTransaction)

getTypeFactory

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