org.broadleafcommerce.common.payment.service

Class AbstractPaymentGatewayConfiguration

java.lang.Object

org.broadleafcommerce.common.payment.service.AbstractPaymentGatewayConfiguration

All Implemented Interfaces:

PaymentGatewayConfiguration

Direct Known Subclasses:

PassthroughPaymentConfigurationImpl

public class AbstractPaymentGatewayConfiguration
extends Object
implements PaymentGatewayConfiguration

Constructor Summary

Constructors

Constructor and Description
AbstractPaymentGatewayConfiguration()

Method Summary

Modifier and Type	Method and Description
int	getFailureReportingThreshold() All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend the AbstractExternalPaymentGatewayCall class.
PaymentGatewayType	getGatewayType() Each payment module should have a unique subclass of PaymentGatewayType with only a single type.
boolean	handlesAuthorize()
boolean	handlesAuthorizeAndCapture()
boolean	handlesCapture()
boolean	handlesMultiplePayments() Denotes whether or not this payment provider supports multiple payments on an order.
boolean	handlesMultipleShipment()
boolean	handlesPartialCapture()
boolean	handlesRecurringPayment()
boolean	handlesRefund()
boolean	handlesReverseAuthorize()
boolean	handlesSavedCustomerPayment()
boolean	handlesVoid()
boolean	isPerformAuthorizeAndCapture() Gets the configured transaction type for this module.
void	setFailureReportingThreshold(int failureReportingThreshold) All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend the AbstractExternalPaymentGatewayCall class.
void	setPerformAuthorizeAndCapture(boolean performAuthorizeAndCapture) Sets the transaction type to 'AUTHORIZE AND CAPTURE' for this gateway.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPaymentGatewayConfiguration

public AbstractPaymentGatewayConfiguration()

Method Detail

isPerformAuthorizeAndCapture

public boolean isPerformAuthorizeAndCapture()

Description copied from interface: PaymentGatewayConfiguration

Gets the configured transaction type for this module.

The possible initial transaction types for a gateway can be: 'Authorize' or 'Authorize and Capture'

This property is intended to be configurable

Specified by:

isPerformAuthorizeAndCapture in interface PaymentGatewayConfiguration

See Also:

org.broadleafcommerce.common.payment.PaymentTransactionType}

setPerformAuthorizeAndCapture

public void setPerformAuthorizeAndCapture(boolean performAuthorizeAndCapture)

Description copied from interface: PaymentGatewayConfiguration

Sets the transaction type to 'AUTHORIZE AND CAPTURE' for this gateway. If this is set to 'FALSE', then the gateway will only issue an 'AUTHORIZATION' request.

This property is intended to be configurable

Specified by:

setPerformAuthorizeAndCapture in interface PaymentGatewayConfiguration

See Also:

org.broadleafcommerce.common.payment.PaymentTransactionType}

getFailureReportingThreshold

public int getFailureReportingThreshold()

Description copied from interface: PaymentGatewayConfiguration

All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend the AbstractExternalPaymentGatewayCall class. One of the configuration parameters is the failure reporting threshold.

Specified by:

getFailureReportingThreshold in interface PaymentGatewayConfiguration

See Also:

AbstractExternalPaymentGatewayCall}

setFailureReportingThreshold

public void setFailureReportingThreshold(int failureReportingThreshold)

Description copied from interface: PaymentGatewayConfiguration

All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend the AbstractExternalPaymentGatewayCall class. One of the configuration parameters is the failure reporting threshold.

Specified by:

setFailureReportingThreshold in interface PaymentGatewayConfiguration

See Also:

AbstractExternalPaymentGatewayCall}

handlesAuthorize

public boolean handlesAuthorize()

Specified by:

handlesAuthorize in interface PaymentGatewayConfiguration

handlesCapture

public boolean handlesCapture()

Specified by:

handlesCapture in interface PaymentGatewayConfiguration

handlesAuthorizeAndCapture

public boolean handlesAuthorizeAndCapture()

Specified by:

handlesAuthorizeAndCapture in interface PaymentGatewayConfiguration

handlesReverseAuthorize

public boolean handlesReverseAuthorize()

Specified by:

handlesReverseAuthorize in interface PaymentGatewayConfiguration

handlesVoid

public boolean handlesVoid()

Specified by:

handlesVoid in interface PaymentGatewayConfiguration

handlesRefund

public boolean handlesRefund()

Specified by:

handlesRefund in interface PaymentGatewayConfiguration

handlesPartialCapture

public boolean handlesPartialCapture()

Specified by:

handlesPartialCapture in interface PaymentGatewayConfiguration

handlesMultipleShipment

public boolean handlesMultipleShipment()

Specified by:

handlesMultipleShipment in interface PaymentGatewayConfiguration

handlesRecurringPayment

public boolean handlesRecurringPayment()

Specified by:

handlesRecurringPayment in interface PaymentGatewayConfiguration

handlesSavedCustomerPayment

public boolean handlesSavedCustomerPayment()

Specified by:

handlesSavedCustomerPayment in interface PaymentGatewayConfiguration

handlesMultiplePayments

public boolean handlesMultiplePayments()

Description copied from interface: PaymentGatewayConfiguration

Denotes whether or not this payment provider supports multiple payments on an order. For instance, a gift card provider might want to support multiple gift cards on a single order but a credit card provider may not support payment with multiple credit cards.

If a provider does not support multiple payments in an order then that means that all payments are deleted (archived) on an order whenever a new payment of that type is attempted to be added to the order.

Specified by:

handlesMultiplePayments in interface PaymentGatewayConfiguration

See Also:

PaymentGatewayCheckoutService}

getGatewayType

public PaymentGatewayType getGatewayType()

Description copied from interface: PaymentGatewayConfiguration

Each payment module should have a unique subclass of PaymentGatewayType with only a single type. For instance, the Braintree module would have a 'BraintreePaymentGatewayType' subclass which adds itself to the global static map.

In order to ensure that the class loader loads the extension of PaymentGatewayType, it is recommended to add a simple bean definition to a module application context that is utilized by both the site and admin. Using the Braintree module as an example again, this might look like:

 
 <bean class="com.broadleafcommerce.payment.service.gateway.BraintreeGatewayType" />
 
 

Specified by:

getGatewayType in interface PaymentGatewayConfiguration