Package com.broadleafcommerce.paypal.micro.domain.api

Class AbstractPayPalRequest<RES,REQ extends com.paypal.http.HttpRequest<RES>>

java.lang.Object

com.broadleafcommerce.paypal.micro.domain.api.AbstractPayPalRequest<RES,REQ>

Type Parameters:

RES - The response content type such as Order

REQ - The request type such as OrdersCreateRequest

All Implemented Interfaces:

PayPalRequest

Direct Known Subclasses:

PayPalAuthorizationRetrievalRequest, PayPalAuthorizeRequest, PayPalCaptureAuthRequest, PayPalCaptureOrderRequest, PayPalCaptureRetrievalRequest, PayPalCreateOrderRequest, PayPalOrderRetrievalRequest, PayPalReAuthorizeRequest, PayPalRefundRequest, PayPalUpdateOrderRequest, PayPalVoidAuthRequest

public abstract class AbstractPayPalRequest<RES,REQ extends com.paypal.http.HttpRequest<RES>>
extends Object
implements PayPalRequest

Represents a request to make against the PayPal REST APIs. It should encapsulate everything necessary to make the request and return a response.

Constructor Summary

Constructors

Constructor	Description
AbstractPayPalRequest(@NonNull PayPalClientProvider clientProvider, @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest)

Method Summary

Modifier and Type	Method	Description
protected abstract REQ	buildRequest()	Method to build out request and provide it the implementation-specific configuration such as headers and request body.
protected void	configureRequest(@NonNull com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest)	Configures request with content and headers.
PayPalResponse	execute()	Executes this request if valid.
protected AbstractPayPalResponse<RES>	executeInternal()	Deprecated. in favour of executeInternal(String, String)
protected abstract AbstractPayPalResponse<RES>	executeInternal(String applicationId, String tenantId)	Executes the configured request using the getClient(String, String) PayPalHttpClient}.
protected com.paypal.core.PayPalHttpClient	getClient()	Deprecated. in favour of getClient(String, String)
protected com.paypal.core.PayPalHttpClient	getClient(String applicationId, String tenantId)	Convenience method for getting the PayPalClientProvider.getClient(String, String) ()} from clientProvider.
protected PayPalClientProvider	getClientProvider()	The PayPalClientProvider used to configure and execute requests.
protected com.broadleafcommerce.paymentgateway.domain.PaymentRequest	getPaymentRequest()
protected REQ	getRequest()	The HttpRequest that is built to facilitate executing request.
protected boolean	isExecuted()	Whether the request has been executed.
protected boolean	isValid()	Whether this is configured correctly and can execute the request.
protected abstract boolean	isValidInternal()	Implementation specific determination of whether the request can be executed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPayPalRequest

public AbstractPayPalRequest(@NonNull
                             @NonNull PayPalClientProvider clientProvider,
                             @NonNull
                             @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest)

Method Detail

execute

public PayPalResponse execute()

Description copied from interface: PayPalRequest

Executes this request if valid.

Specified by:

execute in interface PayPalRequest

Returns:

The AbstractPayPalResponse wrapper around the response from PayPal.

isValid

protected boolean isValid()

Whether this is configured correctly and can execute the request. Relies upon isValidInternal() and whether the request has already been executed.

Returns:

Whether this is configured correctly and can execute the request.

configureRequest

protected void configureRequest(@NonNull
                                @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest)

Configures request with content and headers. Defers to buildRequest() for most of the work.

getClient

@Deprecated(since="1.2.0")
protected com.paypal.core.PayPalHttpClient getClient()

Deprecated.

in favour of getClient(String, String)

Convenience method for getting the PayPalClientProvider.getClient() from clientProvider.

Returns:

clientProvider.client

getClient

protected com.paypal.core.PayPalHttpClient getClient(@Nullable
                                                     String applicationId,
                                                     @Nullable
                                                     String tenantId)

Convenience method for getting the PayPalClientProvider.getClient(String, String) ()} from clientProvider.

Parameters:

applicationId - the application ID

tenantId - the tenant ID

Returns:

clientProvider.client

buildRequest

protected abstract REQ buildRequest()

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

Returns:

The configured request

executeInternal

@Deprecated(since="1.2.0")
protected AbstractPayPalResponse<RES> executeInternal()
                                               throws IOException

Deprecated.

in favour of executeInternal(String, String)

Executes the configured request using the PayPalHttpClient.

Returns:

The response from PayPal.

Throws:

IOException - Thrown if the request execution fails.

executeInternal

protected abstract AbstractPayPalResponse<RES> executeInternal(@Nullable
                                                               String applicationId,
                                                               @Nullable
                                                               String tenantId)
                                                        throws IOException

Executes the configured request using the getClient(String, String) PayPalHttpClient}.

Parameters:

applicationId - the application ID

tenantId - the tenant ID

Returns:

The response from PayPal

Throws:

IOException - Thrown if the request execution fails.

isValidInternal

protected abstract boolean isValidInternal()

Implementation specific determination of whether the request can be executed.

Returns:

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

getClientProvider

protected PayPalClientProvider getClientProvider()

The PayPalClientProvider used to configure and execute requests.

getPaymentRequest

protected com.broadleafcommerce.paymentgateway.domain.PaymentRequest getPaymentRequest()

getRequest

protected REQ getRequest()

The HttpRequest that is built to facilitate executing request.

isExecuted

protected boolean isExecuted()

Whether the request has been executed.