Package com.broadleafcommerce.vendor.chasepayment.service.orbital.external

Class DefaultOrbitalGatewayExternalCallService

java.lang.Object

com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall<OrbitalPaymentRequestWrapper,com.broadleafcommerce.paymentgateway.domain.PaymentResponse>

com.broadleafcommerce.vendor.chasepayment.service.orbital.external.DefaultOrbitalGatewayExternalCallService

All Implemented Interfaces:

com.broadleafcommerce.paymentgateway.service.FailureCountExposable, com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceStatusDetectable<OrbitalPaymentRequestWrapper>, OrbitalGatewayExternalCallService

public class DefaultOrbitalGatewayExternalCallService
extends com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall<OrbitalPaymentRequestWrapper,com.broadleafcommerce.paymentgateway.domain.PaymentResponse>
implements OrbitalGatewayExternalCallService

Default implementation of OrbitalGatewayExternalCallService.

Field Summary

Fields inherited from class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

failureCount, isUp

Constructor Summary

Constructors

Constructor

Description

DefaultOrbitalGatewayExternalCallService(ChaseOrbitalGatewayConfigurationProperties orbitalGatewayConfigProperties, com.broadleafcommerce.paymentgateway.util.PaymentResponseUtil paymentResponseUtil, OrbitalGatewayProvider orbitalGatewayProvider, List<OrbitalRequestResponseTransformer> requestResponseTransformers, com.broadleafcommerce.common.extension.TypeFactory typeFactory, OrbitalResponseCodeEvaluator responseCodeEvaluator)

Method Summary

Modifier and Type	Method	Description
protected com.broadleafcommerce.paymentgateway.domain.PaymentResponse	buildEagerPaymentResponse(@NonNull OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
protected OrbitalCaptureRequest	buildOrbitalCaptureRequest(OrbitalRequestResponseTransformer requestResponseTransformer, OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
protected OrbitalCreatePaymentRequest	buildOrbitalCreatePaymentRequest(OrbitalRequestResponseTransformer requestResponseTransformer, OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
protected OrbitalRefundRequest	buildOrbitalRefundRequest(OrbitalRequestResponseTransformer requestResponseTransformer, OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
protected OrbitalReversalRequest	buildOrbitalReversalRequest(OrbitalRequestResponseTransformer requestResponseTransformer, OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
com.broadleafcommerce.paymentgateway.domain.PaymentResponse	call(OrbitalPaymentRequestWrapper paymentRequest)	Make an external request to the gateway to execute the transaction corresponding to the provided payment request.
com.broadleafcommerce.paymentgateway.domain.PaymentResponse	communicateWithVendor(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
protected void	executeAuthorizeAndCaptureRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, OrbitalRequestResponseTransformer requestResponseTransformer)
protected void	executeAuthorizeRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, OrbitalRequestResponseTransformer requestResponseTransformer)
protected void	executeCaptureRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, OrbitalRequestResponseTransformer requestResponseTransformer)
protected void	executeRefundRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, OrbitalRequestResponseTransformer requestResponseTransformer)
protected void	executeRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate)
protected void	executeReverseAuthRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, OrbitalRequestResponseTransformer requestResponseTransformer)
Integer	getFailureReportingThreshold()
protected String	getGatewayTransactionType(@NonNull OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
protected ChaseOrbitalGatewayConfigurationProperties	getOrbitalGatewayConfigProperties()
protected OrbitalGatewayProvider	getOrbitalGatewayProvider()
protected com.broadleafcommerce.paymentgateway.util.PaymentResponseUtil	getPaymentResponseUtil()
protected List<OrbitalRequestResponseTransformer>	getRequestResponseTransformers()
protected OrbitalResponseCodeEvaluator	getResponseCodeEvaluator()
String	getServiceName()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected void	handleExecuteCustomRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate)	Hook point to allow clients to handle additional transaction types.
protected void	handleMissingRequiredConfigurationException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, MissingRequiredConfigurationException e)	If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a MissingRequiredConfigurationException, this method is called to capture error details on the response.
protected void	handleOrbitalRequestCreationException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, OrbitalRequestCreationException e)	If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a OrbitalRequestCreationException, this method is called to capture error details on the response.
protected void	handleOrbitalRequestResponseTransformerNotFoundException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, OrbitalRequestResponseTransformerNotFoundException e)	If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a OrbitalRequestResponseTransformerNotFoundException, this method is called to capture error details on the response.
protected void	handleOrbitalResponseInterpretationException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, OrbitalResponseInterpretationException e)	If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a OrbitalResponseInterpretationException, this method is called to capture error details on the response.
protected void	handleProviderApiException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, ProviderApiException e)	If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a ProviderApiException, this method is called to capture error details on the response.
protected void	handleUnexpectedOrbitalRequestResponseException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper, com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate, UnexpectedOrbitalRequestResponseException e)	If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a UnexpectedOrbitalRequestResponseException, this method is called to capture error details on the response.
protected OrbitalRequestResponseTransformer	identifyRequestResponseTransformer(@NonNull OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)

Methods inherited from class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

clearStatus, getServiceStatus, incrementFailure, process

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultOrbitalGatewayExternalCallService

public DefaultOrbitalGatewayExternalCallService(ChaseOrbitalGatewayConfigurationProperties orbitalGatewayConfigProperties,
 com.broadleafcommerce.paymentgateway.util.PaymentResponseUtil paymentResponseUtil,
 OrbitalGatewayProvider orbitalGatewayProvider,
 List<OrbitalRequestResponseTransformer> requestResponseTransformers,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 OrbitalResponseCodeEvaluator responseCodeEvaluator)

Method Details

call

public com.broadleafcommerce.paymentgateway.domain.PaymentResponse call(OrbitalPaymentRequestWrapper paymentRequest)

Description copied from interface: OrbitalGatewayExternalCallService

Make an external request to the gateway to execute the transaction corresponding to the provided payment request.

Specified by:

call in interface OrbitalGatewayExternalCallService

Parameters:

paymentRequest - The request payload that should be used to form the transaction

Returns:

object that carries the response from the external gateway service

communicateWithVendor

public com.broadleafcommerce.paymentgateway.domain.PaymentResponse communicateWithVendor(@NonNull
 OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
                                                                                  throws Exception

Specified by:

communicateWithVendor in class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall<OrbitalPaymentRequestWrapper,com.broadleafcommerce.paymentgateway.domain.PaymentResponse>

Throws:

Exception

buildEagerPaymentResponse

protected com.broadleafcommerce.paymentgateway.domain.PaymentResponse buildEagerPaymentResponse(@NonNull
 @NonNull OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)

Parameters:

orbitalPaymentRequestWrapper - the received request details

Returns:

an initial payment response placeholder object that defaults to reporting 'unsuccessful'. This can serve as an initial starting point for the payment response and fleshed out as the flow progresses.

getGatewayTransactionType

protected String getGatewayTransactionType(@NonNull
 @NonNull OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)

executeRequest

protected void executeRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate)

identifyRequestResponseTransformer

protected OrbitalRequestResponseTransformer identifyRequestResponseTransformer(@NonNull
 @NonNull OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)

executeAuthorizeRequest

protected void executeAuthorizeRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 OrbitalRequestResponseTransformer requestResponseTransformer)

buildOrbitalCreatePaymentRequest

protected OrbitalCreatePaymentRequest buildOrbitalCreatePaymentRequest(OrbitalRequestResponseTransformer requestResponseTransformer,
 OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)

executeAuthorizeAndCaptureRequest

protected void executeAuthorizeAndCaptureRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 OrbitalRequestResponseTransformer requestResponseTransformer)

executeCaptureRequest

protected void executeCaptureRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 OrbitalRequestResponseTransformer requestResponseTransformer)

buildOrbitalCaptureRequest

protected OrbitalCaptureRequest buildOrbitalCaptureRequest(OrbitalRequestResponseTransformer requestResponseTransformer,
 OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)

executeRefundRequest

protected void executeRefundRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 OrbitalRequestResponseTransformer requestResponseTransformer)

buildOrbitalRefundRequest

protected OrbitalRefundRequest buildOrbitalRefundRequest(OrbitalRequestResponseTransformer requestResponseTransformer,
 OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)

executeReverseAuthRequest

protected void executeReverseAuthRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 OrbitalRequestResponseTransformer requestResponseTransformer)

buildOrbitalReversalRequest

protected OrbitalReversalRequest buildOrbitalReversalRequest(OrbitalRequestResponseTransformer requestResponseTransformer,
 OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)

handleExecuteCustomRequest

protected void handleExecuteCustomRequest(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate)

Hook point to allow clients to handle additional transaction types. Default throws an error.

Parameters:

orbitalPaymentRequestWrapper - request details

responseToPopulate - response object to populate with results

handleProviderApiException

protected void handleProviderApiException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 ProviderApiException e)

If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a ProviderApiException, this method is called to capture error details on the response.

Parameters:

orbitalPaymentRequestWrapper - the original request details

responseToPopulate - the response on which any error details should be populated

e - the thrown exception

handleMissingRequiredConfigurationException

protected void handleMissingRequiredConfigurationException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 MissingRequiredConfigurationException e)

If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a MissingRequiredConfigurationException, this method is called to capture error details on the response.

Parameters:

orbitalPaymentRequestWrapper - the original request details

responseToPopulate - the response on which any error details should be populated

e - the thrown exception

handleOrbitalRequestResponseTransformerNotFoundException

protected void handleOrbitalRequestResponseTransformerNotFoundException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 OrbitalRequestResponseTransformerNotFoundException e)

If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a OrbitalRequestResponseTransformerNotFoundException, this method is called to capture error details on the response.

Parameters:

orbitalPaymentRequestWrapper - the original request details

responseToPopulate - the response on which any error details should be populated

e - the thrown exception

handleOrbitalRequestCreationException

protected void handleOrbitalRequestCreationException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 OrbitalRequestCreationException e)

If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a OrbitalRequestCreationException, this method is called to capture error details on the response.

Parameters:

orbitalPaymentRequestWrapper - the original request details

responseToPopulate - the response on which any error details should be populated

e - the thrown exception

handleUnexpectedOrbitalRequestResponseException

protected void handleUnexpectedOrbitalRequestResponseException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 UnexpectedOrbitalRequestResponseException e)

If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a UnexpectedOrbitalRequestResponseException, this method is called to capture error details on the response.

Parameters:

orbitalPaymentRequestWrapper - the original request details

responseToPopulate - the response on which any error details should be populated

e - the thrown exception

handleOrbitalResponseInterpretationException

protected void handleOrbitalResponseInterpretationException(OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse responseToPopulate,
 OrbitalResponseInterpretationException e)

If executeRequest(OrbitalPaymentRequestWrapper, PaymentResponse) throws a OrbitalResponseInterpretationException, this method is called to capture error details on the response.

Parameters:

orbitalPaymentRequestWrapper - the original request details

responseToPopulate - the response on which any error details should be populated

e - the thrown exception

getFailureReportingThreshold

@NonNull
public Integer getFailureReportingThreshold()

Specified by:

getFailureReportingThreshold in interface com.broadleafcommerce.paymentgateway.service.FailureCountExposable

Specified by:

getFailureReportingThreshold in class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall<OrbitalPaymentRequestWrapper,com.broadleafcommerce.paymentgateway.domain.PaymentResponse>

getServiceName

@NonNull
public String getServiceName()

Specified by:

getServiceName in interface com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceStatusDetectable<OrbitalPaymentRequestWrapper>

getOrbitalGatewayConfigProperties

protected ChaseOrbitalGatewayConfigurationProperties getOrbitalGatewayConfigProperties()

getPaymentResponseUtil

protected com.broadleafcommerce.paymentgateway.util.PaymentResponseUtil getPaymentResponseUtil()

getOrbitalGatewayProvider

protected OrbitalGatewayProvider getOrbitalGatewayProvider()

getRequestResponseTransformers

protected List<OrbitalRequestResponseTransformer> getRequestResponseTransformers()

getTypeFactory

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

getResponseCodeEvaluator

protected OrbitalResponseCodeEvaluator getResponseCodeEvaluator()