Package com.broadleafcommerce.cartoperation.web.endpoint

Class ExternalPaymentTransactionCallbackEndpoint

java.lang.Object

com.broadleafcommerce.cartoperation.web.endpoint.ExternalPaymentTransactionCallbackEndpoint

@FrameworkRestController
@FrameworkMapping("/checkout/{cartId}/payment-callback/{gatewayType}")
@DataRouteByKey("cartoperation")
@ConditionalOnProperty(value="broadleaf.payment.legacy-external-payment-pattern-enabled",
                       havingValue="false",
                       matchIfMissing=true)
public class ExternalPaymentTransactionCallbackEndpoint
extends Object

Author:

Dima Myroniuk (dmyroniuk)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_ID
static final String	BASE_URI
static final String	ERROR_ATTR
static final String	INVALID_CALLBACK_REQUEST
static final String	STOREFRONT_REDIRECT_PARAM
static final String	TENANT_ID

Constructor Summary

Constructors

Constructor	Description
ExternalPaymentTransactionCallbackEndpoint(ExternalPaymentTransactionCallbackService externalPaymentTransactionCallbackService, ExternalPaymentTransactionCallbackRedirectionProperties callbackRedirectionProperties, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected void	addValidationErrorRedirectAttribute(org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)
protected ExternalPaymentTransactionCallbackDTO	buildCallbackDTO(@NonNull String cartId, @NonNull String gatewayType, @NonNull Map<String,Object> requestBody, @NonNull Map<String,String> requestParams)
protected com.broadleafcommerce.data.tracking.core.context.ContextInfo	buildContextInfo(@NonNull com.broadleafcommerce.data.tracking.core.type.OperationType operationType, @NonNull Map<String,Object> requestBody, @NonNull Map<String,String> requestParams)
protected org.springframework.web.servlet.ModelAndView	externalPaymentTransactionCallbackGet(String cartId, String gatewayType, Map<String,String> requestParams, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected org.springframework.web.servlet.ModelAndView	externalPaymentTransactionCallbackPost(String cartId, String gatewayType, Map<String,String> requestParams, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected String	getApplicationId(Map<String,Object> requestBody, Map<String,String> requestParams)
protected String	getApplicationIdFromContext(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected ExternalPaymentTransactionCallbackRedirectionProperties	getCallbackRedirectionProperties()
protected ExternalPaymentTransactionCallbackService	getExternalPaymentTransactionCallbackService()
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
protected String	getRedirectUri(@NonNull ExternalPaymentTransactionCallbackDTO callbackDTO, String applicationId, String tenantId)
protected String	getRedirectUrl(@NonNull ExternalPaymentTransactionCallbackDTO callbackDTO, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected Map<String,Object>	getRequestBody(@NonNull jakarta.servlet.http.HttpServletRequest request)
protected String	getStorefrontBaseUrl(@NonNull ExternalPaymentTransactionCallbackDTO callbackDTO, String applicationId, String tenantId)
protected String	getTenantId(Map<String,Object> requestBody, Map<String,String> requestParams)
protected String	getTenantIdFromContext(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected void	hydrateRedirectAttributes(@NonNull org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, @NonNull ExternalPaymentTransactionCallbackDTO callbackDTO)	Hook point to hydrate any additional attributes before redirecting to the frontend.

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

STOREFRONT_REDIRECT_PARAM

public static final String STOREFRONT_REDIRECT_PARAM

See Also:

• Constant Field Values

TENANT_ID

public static final String TENANT_ID

See Also:

• Constant Field Values

APPLICATION_ID

public static final String APPLICATION_ID

See Also:

• Constant Field Values

INVALID_CALLBACK_REQUEST

public static final String INVALID_CALLBACK_REQUEST

See Also:

• Constant Field Values

ERROR_ATTR

public static final String ERROR_ATTR

See Also:

• Constant Field Values

Constructor Details

ExternalPaymentTransactionCallbackEndpoint

public ExternalPaymentTransactionCallbackEndpoint(ExternalPaymentTransactionCallbackService externalPaymentTransactionCallbackService,
 ExternalPaymentTransactionCallbackRedirectionProperties callbackRedirectionProperties,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

externalPaymentTransactionCallbackGet

@FrameworkGetMapping
protected org.springframework.web.servlet.ModelAndView externalPaymentTransactionCallbackGet(@PathVariable
 String cartId,
 @PathVariable
 String gatewayType,
 @RequestParam(required=false)
 Map<String,String> requestParams,
 org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

externalPaymentTransactionCallbackPost

@FrameworkPostMapping
protected org.springframework.web.servlet.ModelAndView externalPaymentTransactionCallbackPost(@PathVariable
 String cartId,
 @PathVariable
 String gatewayType,
 @RequestParam(required=false)
 Map<String,String> requestParams,
 org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

buildCallbackDTO

protected ExternalPaymentTransactionCallbackDTO buildCallbackDTO(@NonNull
 @NonNull String cartId,
 @NonNull
 @NonNull String gatewayType,
 @NonNull
 @NonNull Map<String,Object> requestBody,
 @NonNull
 @NonNull Map<String,String> requestParams)

buildContextInfo

protected com.broadleafcommerce.data.tracking.core.context.ContextInfo buildContextInfo(@NonNull
 @NonNull com.broadleafcommerce.data.tracking.core.type.OperationType operationType,
 @NonNull
 @NonNull Map<String,Object> requestBody,
 @NonNull
 @NonNull Map<String,String> requestParams)

getTenantId

@Nullable
protected String getTenantId(Map<String,Object> requestBody,
 Map<String,String> requestParams)

getApplicationId

@Nullable
protected String getApplicationId(Map<String,Object> requestBody,
 Map<String,String> requestParams)

getRequestBody

protected Map<String,Object> getRequestBody(@NonNull
 @NonNull jakarta.servlet.http.HttpServletRequest request)

hydrateRedirectAttributes

protected void hydrateRedirectAttributes(@NonNull
 @NonNull org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
 @NonNull
 @NonNull ExternalPaymentTransactionCallbackDTO callbackDTO)

Hook point to hydrate any additional attributes before redirecting to the frontend.

Parameters:

redirectAttributes - The redirect attributes of this request

callbackDTO - Additional attributes to add to the redirect attributes

addValidationErrorRedirectAttribute

protected void addValidationErrorRedirectAttribute(org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)

getRedirectUrl

protected String getRedirectUrl(@NonNull
 @NonNull ExternalPaymentTransactionCallbackDTO callbackDTO,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getStorefrontBaseUrl

protected String getStorefrontBaseUrl(@NonNull
 @NonNull ExternalPaymentTransactionCallbackDTO callbackDTO,
 @Nullable
 String applicationId,
 @Nullable
 String tenantId)

getRedirectUri

protected String getRedirectUri(@NonNull
 @NonNull ExternalPaymentTransactionCallbackDTO callbackDTO,
 @Nullable
 String applicationId,
 @Nullable
 String tenantId)

getApplicationIdFromContext

@Nullable
protected String getApplicationIdFromContext(@Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getTenantIdFromContext

@Nullable
protected String getTenantIdFromContext(@Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getExternalPaymentTransactionCallbackService

protected ExternalPaymentTransactionCallbackService getExternalPaymentTransactionCallbackService()

getCallbackRedirectionProperties

protected ExternalPaymentTransactionCallbackRedirectionProperties getCallbackRedirectionProperties()

getObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

getTypeFactory

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