Package com.broadleafcommerce.paymentgateway.service.provider

Interface PaymentGatewayResourceProvider

All Known Implementing Classes:

DefaultPaymentGatewayResourceProvider

public interface PaymentGatewayResourceProvider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically. 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.

Author:

Chris Kittrell (ckittrell)

Method Summary

Modifier and Type	Method	Description
PaymentGateway3DSTransactionLookupService	get3DSTransactionLookupService(String gatewayType)	Returns the implementation of PaymentGateway3DSTransactionLookupService for the specified gateway type.
PaymentGatewayConfiguration	getConfiguration(String gatewayType)	Returns the first PaymentGatewayConfiguration that matches the given PaymentGatewayType.
PaymentGatewayCustomerService	getCustomerService(String gatewayType)	Returns the first PaymentGatewayCustomerService that matches the given PaymentGatewayType.
PaymentGatewayHostedService	getHostedService(String gatewayType)	Returns the first PaymentGatewayHostedService that matches the given PaymentGatewayType.
PaymentGatewayPaymentModificationService	getPaymentModificationService(String gatewayType)	Returns the implementation of PaymentGatewayPaymentModificationService for the specified gateway type.
PaymentGatewayPaymentValidator	getPaymentValidator(String gatewayType)	Returns the first PaymentGatewayPaymentValidator that matches the given PaymentGatewayType.
PaymentGatewayReportingService	getReportingService(String gatewayType)	Returns the first PaymentGatewayReportingService that matches the given PaymentGatewayType.
PaymentGatewayRollbackService	getRollbackService(String gatewayType)	Returns the first PaymentGatewayRollbackService that matches the given PaymentGatewayType.
PaymentGatewaySavedPaymentMethodService	getSavedPaymentMethodService(String gatewayType)	Returns the implementation of PaymentGatewaySavedPaymentMethodService for the specified gateway type or null.
PaymentGatewayTransactionResponseService	getTransactionResponseService(String gatewayType)	Returns the first PaymentGatewayTransactionResponseService that matches the given PaymentGatewayType.
PaymentGatewayTransactionResponseValidator	getTransactionResponseValidator(String gatewayType)	Returns the first PaymentGatewayTransactionResponseValidator that matches the given PaymentGatewayType.
PaymentGatewayTransactionService	getTransactionService(String gatewayType)	Returns the first PaymentGatewayTransactionService that matches the given PaymentGatewayType.
PaymentGatewayWebhookHandler	getWebhookHandler(String gatewayType)	Returns the first PaymentGatewayWebhookHandler that matches the given PaymentGatewayType.

Method Detail

getConfiguration

PaymentGatewayConfiguration getConfiguration(String gatewayType)

Returns the first PaymentGatewayConfiguration that matches the given PaymentGatewayType.

Parameters:

gatewayType - a String representation of the PaymentGatewayType

Throws:

UnsupportedOperationException - if there is no resource for the given PaymentGatewayType.

getTransactionService

PaymentGatewayTransactionService getTransactionService(String gatewayType)

Returns the first PaymentGatewayTransactionService that matches the given PaymentGatewayType.

Parameters:

gatewayType - a String representation of the PaymentGatewayType

Throws:

UnsupportedOperationException - if there is no resource for the given PaymentGatewayType.

getRollbackService

PaymentGatewayRollbackService getRollbackService(String gatewayType)

Returns the first PaymentGatewayRollbackService that matches the given PaymentGatewayType.

Parameters:

gatewayType - a String representation of the PaymentGatewayType

Throws:

UnsupportedOperationException - if there is no resource for the given PaymentGatewayType.

getWebhookHandler

PaymentGatewayWebhookHandler getWebhookHandler(String gatewayType)

Returns the first PaymentGatewayWebhookHandler that matches the given PaymentGatewayType.

Parameters:

gatewayType - a String representation of the PaymentGatewayType

Throws:

UnsupportedOperationException - if there is no resource for the given PaymentGatewayType.

getReportingService

PaymentGatewayReportingService getReportingService(String gatewayType)

Returns the first PaymentGatewayReportingService that matches the given PaymentGatewayType.

Parameters:

gatewayType - a String representation of the PaymentGatewayType

Throws:

UnsupportedOperationException - if there is no resource for the given PaymentGatewayType.

getCustomerService

PaymentGatewayCustomerService getCustomerService(String gatewayType)

Returns the first PaymentGatewayCustomerService that matches the given PaymentGatewayType.

Parameters:

gatewayType - a String representation of the PaymentGatewayType

Throws:

UnsupportedOperationException - if there is no resource for the given PaymentGatewayType.

getHostedService

PaymentGatewayHostedService getHostedService(String gatewayType)

Returns the first PaymentGatewayHostedService that matches the given PaymentGatewayType.

Parameters:

gatewayType - a String representation of the PaymentGatewayType

Throws:

UnsupportedOperationException - if there is no resource for the given PaymentGatewayType.

getPaymentValidator

PaymentGatewayPaymentValidator getPaymentValidator(String gatewayType)

Returns the first PaymentGatewayPaymentValidator that matches the given PaymentGatewayType.

Parameters:

gatewayType - a String representation of the PaymentGatewayType

Throws:

UnsupportedOperationException - if there is no resource for the given PaymentGatewayType.

getTransactionResponseService

PaymentGatewayTransactionResponseService getTransactionResponseService(String gatewayType)

Returns the first PaymentGatewayTransactionResponseService that matches the given PaymentGatewayType.

Parameters:

gatewayType - a String representation of the PaymentGatewayType

Throws:

UnsupportedOperationException - if there is no resource for the given PaymentGatewayType.

getTransactionResponseValidator

PaymentGatewayTransactionResponseValidator getTransactionResponseValidator(String gatewayType)

Returns the first PaymentGatewayTransactionResponseValidator that matches the given PaymentGatewayType.

Parameters:

gatewayType - a String representation of the PaymentGatewayType

Throws:

UnsupportedOperationException - if there is no resource for the given PaymentGatewayType.

getSavedPaymentMethodService

@Nullable
PaymentGatewaySavedPaymentMethodService getSavedPaymentMethodService(String gatewayType)

Returns the implementation of PaymentGatewaySavedPaymentMethodService for the specified gateway type or null.

Parameters:

gatewayType - the PaymentGatewayType related to implementing resource

Returns:

the implementation of PaymentGatewaySavedPaymentMethodService for the specified gateway type or null

get3DSTransactionLookupService

PaymentGateway3DSTransactionLookupService get3DSTransactionLookupService(String gatewayType)

Returns the implementation of PaymentGateway3DSTransactionLookupService for the specified gateway type.

Parameters:

gatewayType - the PaymentGatewayType related to implementing resource

Returns:

the implementation of PaymentGateway3DSTransactionLookupService for the specified gateway type

getPaymentModificationService

@Nullable
PaymentGatewayPaymentModificationService getPaymentModificationService(String gatewayType)

Returns the implementation of PaymentGatewayPaymentModificationService for the specified gateway type.

Parameters:

gatewayType - the PaymentGatewayType related to implementing resource

Returns:

the implementation of PaymentGatewayPaymentModificationService for the specified gateway type