org.broadleafcommerce.common.payment.service

Interface PaymentGatewayConfigurationServiceProvider

All Known Implementing Classes:

PaymentGatewayConfigurationServiceProviderImpl

public interface PaymentGatewayConfigurationServiceProvider

This represents the main servic bus for grabbing configurations to configured payment gateways to execute service calls programmatically. The main use for this in the framework is in ValidateAndConfirmPaymentActivity and its rollback handler ConfirmPaymentsRollbackHandler. Since multiple gateways can be configured for a single implementation (like Paypal Express and Braintree, or Paypal Express, a credit card module and a gift card module) this allows you to select between them to perform additional operations on a payment transaction.

Once you obtain the correct gateway configuration bean, you can then obtain links to each service to perform individual operations like PaymentGatewayTransactionService or PaymentGatewayFraudService.

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

Methods

Modifier and Type	Method and Description
PaymentGatewayConfigurationService	getGatewayConfigurationService(PaymentGatewayType gatewayType) Returns the first PaymentGatewayConfigurationService that matches the given PaymentGatewayType.
List<PaymentGatewayConfigurationService>	getGatewayConfigurationServices()
void	setGatewayConfigurationServices(List<PaymentGatewayConfigurationService> gatewayConfigurationServices)

Method Detail

getGatewayConfigurationService

PaymentGatewayConfigurationService getGatewayConfigurationService(@Nonnull
                                                                PaymentGatewayType gatewayType)

Returns the first PaymentGatewayConfigurationService that matches the given PaymentGatewayType. Useful when you need a particular PaymentGatewayConfigurationService to communicate in different ways to a payment gateway.

Throws:

IllegalArgumentException - if the given PaymentGatewayType is null or if there is no configuration for the given PaymentGatewayType.

getGatewayConfigurationServices

List<PaymentGatewayConfigurationService> getGatewayConfigurationServices()

setGatewayConfigurationServices

void setGatewayConfigurationServices(List<PaymentGatewayConfigurationService> gatewayConfigurationServices)