Package com.broadleafcommerce.cartoperation.service.checkout

Class CartOperationCheckoutProperties

java.lang.Object

com.broadleafcommerce.cartoperation.properties.DiscriminatedProperties<CartOperationCheckoutProperties>

com.broadleafcommerce.cartoperation.service.checkout.CartOperationCheckoutProperties

@Validated
@ConfigurationProperties("broadleaf.cartoperation.service.checkout")
public class CartOperationCheckoutProperties
extends DiscriminatedProperties<CartOperationCheckoutProperties>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CartOperationCheckoutProperties.GuestToken	Guest token properties.

Constructor Summary

Constructors

Constructor	Description
CartOperationCheckoutProperties()

Method Summary

Modifier and Type	Method	Description
List<CheckoutPaymentMethodOption>	getCheckoutPaymentMethodOptions(String applicationId, String tenantId)	Gets the value of checkoutPaymentMethodOptions based on the given application and tenant id.
String	getCheckoutTransactionType(String gatewayType, String paymentType, String applicationId, String tenantId)
String	getCheckoutTransactionTypeByGateway(String gateway, String applicationId, String tenantId)	Deprecated. in favor of getCheckoutTransactionType(String, String, String, String)
CartOperationCheckoutProperties.GuestToken	getGuestToken()
List<String>	getPaymentGatewayPriorities(String applicationId, String tenantId)	Gets the value of paymentGatewayPriorities based on the given application and tenant id.
boolean	isCheckoutLookup3DSTransactionsEnabled(String gateway)
boolean	isCheckoutLookupExternalTransactionsEnabled(String gateway)
boolean	isCheckoutPaymentMethodValidationEnabled()	Whether or not to validate payment methods during checkout activity workflow
boolean	isCheckoutTransactionExternalByGateway(String gateway, String applicationId, String tenantId)
void	setCheckoutLookup3dsTransactionsEnabled(Map<String,Boolean> checkoutLookup3dsTransactionsEnabled)	Whether or not to lookup the results of pending 3DS transactions during the checkout workflow.
void	setCheckoutLookupExternalTransactionsEnabled(Map<String,Boolean> checkoutLookupExternalTransactionsEnabled)	Whether or not to lookup the results of pending external transactions during the checkout workflow.
void	setCheckoutPaymentMethodOptions(List<CheckoutPaymentMethodOption> checkoutPaymentMethodOptions)	A list of configured payment methods that are available during checkout.
void	setCheckoutPaymentMethodValidationEnabled(boolean checkoutPaymentMethodValidationEnabled)	Whether or not to validate payment methods during checkout activity workflow
void	setCheckoutTransactionExternal(Map<String,Boolean> checkoutTransactionExternal)	Whether the checkout transaction occurs externally such as for transparent redirect.
void	setCheckoutTransactionTypes(Map<String,String> checkoutTransactionTypes)	Set the TransactionType that should be performed during checkout.
void	setGuestToken(CartOperationCheckoutProperties.GuestToken guestToken)
void	setPaymentGatewayPriorities(List<String> paymentGatewayPriorities)	A list of PaymentGatewayTypes defining the order by which payments will be processed during checkout.

Methods inherited from class com.broadleafcommerce.cartoperation.properties.DiscriminatedProperties

getApplication, getApplicationIdFromContext, getField, getTenant, getTenantIdFromContext, setApplication, setTenant

Methods inherited from class java.lang.Object

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

Constructor Details

CartOperationCheckoutProperties

public CartOperationCheckoutProperties()

Method Details

getCheckoutTransactionType

public String getCheckoutTransactionType(String gatewayType,
 String paymentType,
 @Nullable
 String applicationId,
 @Nullable
 String tenantId)

getCheckoutTransactionTypeByGateway

@Deprecated
public String getCheckoutTransactionTypeByGateway(String gateway,
 @Nullable
 String applicationId,
 @Nullable
 String tenantId)

Deprecated.

in favor of getCheckoutTransactionType(String, String, String, String)

Gathers the checkout TransactionType by gateway type

Parameters:

gateway - name of the gateway

applicationId - the application ID

tenantId - the tenant ID

Returns:

the checkout TransactionType

isCheckoutTransactionExternalByGateway

public boolean isCheckoutTransactionExternalByGateway(String gateway,
 @Nullable
 String applicationId,
 @Nullable
 String tenantId)

isCheckoutLookup3DSTransactionsEnabled

public boolean isCheckoutLookup3DSTransactionsEnabled(String gateway)

isCheckoutLookupExternalTransactionsEnabled

public boolean isCheckoutLookupExternalTransactionsEnabled(String gateway)

getPaymentGatewayPriorities

public List<String> getPaymentGatewayPriorities(@Nullable
 String applicationId,
 @Nullable
 String tenantId)

Gets the value of paymentGatewayPriorities based on the given application and tenant id.

Parameters:

applicationId - the current context's application id

tenantId - the current context's tenant id

Returns:

the value of paymentGatewayPriorities based on the given application and tenant id

getCheckoutPaymentMethodOptions

public List<CheckoutPaymentMethodOption> getCheckoutPaymentMethodOptions(@Nullable
 String applicationId,
 @Nullable
 String tenantId)

Gets the value of checkoutPaymentMethodOptions based on the given application and tenant id.

Parameters:

applicationId - the current context's application id

tenantId - the current context's tenant id

Returns:

the value of checkoutPaymentMethodOptions based on the given application and tenant id

setCheckoutTransactionTypes

public void setCheckoutTransactionTypes(Map<String,String> checkoutTransactionTypes)

Set the TransactionType that should be performed during checkout. Typically, this will be DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE or DefaultTransactionTypes.AUTHORIZE. Map is keyed by payment gateway name.

setCheckoutTransactionExternal

public void setCheckoutTransactionExternal(Map<String,Boolean> checkoutTransactionExternal)

Whether the checkout transaction occurs externally such as for transparent redirect. Otherwise, the transaction is created in Broadleaf during the checkout workflow. The system can use this when validating payments to make sure that they have been executed in the external service. Map is keyed by payment gateway name.

setCheckoutLookup3dsTransactionsEnabled

public void setCheckoutLookup3dsTransactionsEnabled(Map<String,Boolean> checkoutLookup3dsTransactionsEnabled)

Whether or not to lookup the results of pending 3DS transactions during the checkout workflow.

setCheckoutLookupExternalTransactionsEnabled

public void setCheckoutLookupExternalTransactionsEnabled(Map<String,Boolean> checkoutLookupExternalTransactionsEnabled)

Whether or not to lookup the results of pending external transactions during the checkout workflow.

setPaymentGatewayPriorities

public void setPaymentGatewayPriorities(List<String> paymentGatewayPriorities)

A list of PaymentGatewayTypes defining the order by which payments will be processed during checkout.

setCheckoutPaymentMethodOptions

public void setCheckoutPaymentMethodOptions(List<CheckoutPaymentMethodOption> checkoutPaymentMethodOptions)

A list of configured payment methods that are available during checkout.

setCheckoutPaymentMethodValidationEnabled

public void setCheckoutPaymentMethodValidationEnabled(boolean checkoutPaymentMethodValidationEnabled)

Whether or not to validate payment methods during checkout activity workflow

isCheckoutPaymentMethodValidationEnabled

public boolean isCheckoutPaymentMethodValidationEnabled()

Whether or not to validate payment methods during checkout activity workflow

getGuestToken

public CartOperationCheckoutProperties.GuestToken getGuestToken()

setGuestToken

public void setGuestToken(CartOperationCheckoutProperties.GuestToken guestToken)