org.broadleafcommerce.vendor.paypal.service.payment

Class PayPalCaptureOrderRequest

java.lang.Object

org.broadleafcommerce.vendor.paypal.service.payment.AbstractPayPalRequest<com.paypal.orders.Order,com.paypal.orders.OrdersCaptureRequest>

org.broadleafcommerce.vendor.paypal.service.payment.PayPalCaptureOrderRequest

All Implemented Interfaces:

PayPalRequest

public class PayPalCaptureOrderRequest
extends AbstractPayPalRequest<com.paypal.orders.Order,com.paypal.orders.OrdersCaptureRequest>

Request object used to capture an order immediately. To auth the order immediately but capture it later, use PayPalCaptureAuthRequest.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor and Description
PayPalCaptureOrderRequest(PayPalClientProvider clientProvider, org.broadleafcommerce.common.payment.dto.PaymentRequestDTO paymentRequest, String orderId)

Method Summary

Modifier and Type	Method and Description
protected com.paypal.orders.OrdersCaptureRequest	buildRequest() Method to build out AbstractPayPalRequest.request and provide it the implementation-specific configuration such as headers and request body.
protected AbstractPayPalResponse<com.paypal.orders.Order>	executeInternal() Executes the configured AbstractPayPalRequest.request using the PayPalHttpClient.
protected String	getOrderId()
protected boolean	isValidInternal() Implementation specific determination of whether the request can be executed.

Methods inherited from class org.broadleafcommerce.vendor.paypal.service.payment.AbstractPayPalRequest

configureRequest, execute, getClient, getClientProvider, getPaymentRequest, getRequest, isExecuted, isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

PayPalCaptureOrderRequest

public PayPalCaptureOrderRequest(PayPalClientProvider clientProvider,
                                 org.broadleafcommerce.common.payment.dto.PaymentRequestDTO paymentRequest,
                                 String orderId)

Method Detail

buildRequest

protected com.paypal.orders.OrdersCaptureRequest buildRequest()

Description copied from class: AbstractPayPalRequest

Method to build out AbstractPayPalRequest.request and provide it the implementation-specific configuration such as headers and request body.

Specified by:

buildRequest in class AbstractPayPalRequest<com.paypal.orders.Order,com.paypal.orders.OrdersCaptureRequest>

Returns:

The configured request

executeInternal

protected AbstractPayPalResponse<com.paypal.orders.Order> executeInternal()
                                                                   throws IOException

Description copied from class: AbstractPayPalRequest

Executes the configured AbstractPayPalRequest.request using the PayPalHttpClient.

Specified by:

executeInternal in class AbstractPayPalRequest<com.paypal.orders.Order,com.paypal.orders.OrdersCaptureRequest>

Returns:

The response from PayPal.

Throws:

IOException - Thrown if the request execution fails.

isValidInternal

protected boolean isValidInternal()

Description copied from class: AbstractPayPalRequest

Implementation specific determination of whether the request can be executed.

Specified by:

isValidInternal in class AbstractPayPalRequest<com.paypal.orders.Order,com.paypal.orders.OrdersCaptureRequest>

Returns:

Whether the request can be executed or is in an erroneous state.

getOrderId

protected String getOrderId()