org.broadleafcommerce.vendor.authorizenet.web.controller

Class BroadleafAuthorizeNetController

java.lang.Object

org.broadleafcommerce.common.web.controller.BroadleafAbstractController

org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

org.broadleafcommerce.vendor.authorizenet.web.controller.BroadleafAuthorizeNetController

@Controller(value="blAuthorizeNetController")
@RequestMapping(value="/authorizenet")
public class BroadleafAuthorizeNetController
extends org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

Author:

Chad Harchar (charchar), Elbert Bautista (elbertbautista)

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorizeNetCheckoutService	authorizeNetCheckoutService
protected AuthorizeNetConfiguration	configuration
protected static String	GATEWAY_CONTEXT_KEY
protected static org.apache.commons.logging.Log	LOG
protected org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponseService	paymentGatewayWebResponseService
protected org.broadleafcommerce.common.payment.service.PaymentGatewayTransactionService	transactionService
protected org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponsePrintService	webResponsePrintService

Fields inherited from class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

baseCartRedirect, baseConfirmationRedirect, baseErrorView, baseOrderReviewRedirect, baseRedirect, PAYMENT_PROCESSING_ERROR, paymentGatewayCheckoutService, processingErrorMessage

Constructor Summary

Constructors

Constructor and Description
BroadleafAuthorizeNetController()

Method Summary

Methods

Modifier and Type	Method and Description
String	errorEndpoint(org.springframework.ui.Model model, javax.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, Map<String,String> pathVars)
org.broadleafcommerce.common.payment.service.PaymentGatewayConfiguration	getConfiguration()
String	getGatewayContextKey()
org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponseService	getWebResponseService()
void	handleProcessingException(Exception e, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)
void	handleUnsuccessfulTransaction(org.springframework.ui.Model model, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, org.broadleafcommerce.common.payment.dto.PaymentResponseDTO responseDTO)
String	process(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, org.springframework.ui.Model model) Invoked by Authorize.net after taking the user's credit card.
protected String	requestParamToString(javax.servlet.http.HttpServletRequest request)
protected org.broadleafcommerce.common.payment.dto.PaymentRequestDTO	responseToVoidRequest(org.broadleafcommerce.common.payment.dto.PaymentResponseDTO response) Builds a request with enough information to void the given response from the gateway
String	returnEndpoint(org.springframework.ui.Model model, javax.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, Map<String,String> pathVars)

Methods inherited from class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

applyPaymentToOrder, getBaseConfirmationRedirect, getCartViewRedirect, getConfirmationViewRedirect, getErrorViewRedirect, getOrderReviewRedirect, getProcessingErrorMessage, initiateCheckout, lookupOrderNumberFromOrderId, process

Methods inherited from class org.broadleafcommerce.common.web.controller.BroadleafAbstractController

addDeepLink, getContextPath, isAjaxRequest, jsonResponse

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

GATEWAY_CONTEXT_KEY

protected static final String GATEWAY_CONTEXT_KEY

See Also:

Constant Field Values

paymentGatewayWebResponseService

protected org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponseService paymentGatewayWebResponseService

authorizeNetCheckoutService

protected AuthorizeNetCheckoutService authorizeNetCheckoutService

configuration

protected AuthorizeNetConfiguration configuration

webResponsePrintService

protected org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponsePrintService webResponsePrintService

transactionService

protected org.broadleafcommerce.common.payment.service.PaymentGatewayTransactionService transactionService

Constructor Detail

BroadleafAuthorizeNetController

public BroadleafAuthorizeNetController()

Method Detail

getGatewayContextKey

public String getGatewayContextKey()

Specified by:

getGatewayContextKey in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

handleProcessingException

public void handleProcessingException(Exception e,
                             org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)
                               throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Specified by:

handleProcessingException in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

handleUnsuccessfulTransaction

public void handleUnsuccessfulTransaction(org.springframework.ui.Model model,
                                 org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
                                 org.broadleafcommerce.common.payment.dto.PaymentResponseDTO responseDTO)
                                   throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Specified by:

handleUnsuccessfulTransaction in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

getWebResponseService

public org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponseService getWebResponseService()

Specified by:

getWebResponseService in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

getConfiguration

public org.broadleafcommerce.common.payment.service.PaymentGatewayConfiguration getConfiguration()

Specified by:

getConfiguration in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

errorEndpoint

@RequestMapping(value="/error",
                method=GET)
public String errorEndpoint(org.springframework.ui.Model model,
                                  javax.servlet.http.HttpServletRequest request,
                                  org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
                                  Map<String,String> pathVars)
                     throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Specified by:

errorEndpoint in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

returnEndpoint

@RequestMapping(value="/return",
                method=GET)
public String returnEndpoint(org.springframework.ui.Model model,
                                   javax.servlet.http.HttpServletRequest request,
                                   org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
                                   @PathVariable
                                   Map<String,String> pathVars)
                      throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Specified by:

returnEndpoint in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

process

@RequestMapping(value="/process",
                method=POST)
@ResponseBody
public String process(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response,
                                         org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
                                         org.springframework.ui.Model model)
               throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Invoked by Authorize.net after taking the user's credit card. This should process the payment and add it to the order as well as check out the order if configured.

At this point in the lifecyle of taking payment, the card has already been charged. If there is a problem checking out the order, we need to communicate that explicitly up to Authorize.net via a VOID transaction. Otherwise, the user will be left with a non-submitted Order but their card will still be charged.

Parameters:

request -

response -

model -

Returns:

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

responseToVoidRequest

protected org.broadleafcommerce.common.payment.dto.PaymentRequestDTO responseToVoidRequest(org.broadleafcommerce.common.payment.dto.PaymentResponseDTO response)

Builds a request with enough information to void the given response from the gateway

Parameters:

response -

Returns:

requestParamToString

protected String requestParamToString(javax.servlet.http.HttpServletRequest request)