Package com.broadleafcommerce.paymenttransaction.web.endpoint

Class CustomerPaymentManagementEndpoint

java.lang.Object

com.broadleafcommerce.paymenttransaction.web.endpoint.CustomerPaymentManagementEndpoint

@FrameworkRestController
@FrameworkMapping("/customer-payments")
@DataRouteByKey("paymentTransaction")
public class CustomerPaymentManagementEndpoint
extends Object

Author:

Chris Kittrell (ckittrell)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	CUSTOMER_AUTHENTICATION_FAILED
static final String	CUSTOMER_FORBIDDEN_ACCESS

Constructor Summary

Constructors

Constructor	Description
CustomerPaymentManagementEndpoint(PaymentManagementService<Payment> paymentManagementService, PaymentService<Payment> paymentService, PaymentSummaryService paymentSummaryService, PaymentVersionValidationService paymentVersionValidationService, PaymentAccessValidationService paymentAccessValidationService, SavedPaymentMethodAccessValidationService savedPaymentMethodAccessValidationService)

Method Summary

Modifier and Type	Method	Description
void	archivePayment(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String paymentId, Integer paymentVersion, CustomerRef customerRef)
protected com.broadleafcommerce.paymentgateway.domain.PaymentInfo	buildPaymentInfo(@NonNull Payment payment, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected com.broadleafcommerce.paymentgateway.domain.UpdateGatewayPaymentRequest	buildUpdateGatewayPaymentRequest(@NonNull UpdatePaymentRequest req, @NonNull Payment payment, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
PaymentSummary	createPayment(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, CreatePaymentRequest createPaymentRequest, CustomerRef customerRef)
protected String	getApplicationId(com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected PaymentAccessValidationService	getPaymentAccessValidationService()
protected com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider	getPaymentGatewayResourceProvider()
protected PaymentManagementService<Payment>	getPaymentManagementService()
protected PaymentService<Payment>	getPaymentService()
protected PaymentSummaryService	getPaymentSummaryService()
protected PaymentVersionValidationService	getPaymentVersionValidationService()
protected SavedPaymentMethodAccessValidationService	getSavedPaymentMethodAccessValidationService()
protected String	getTenantId(com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
org.springframework.data.domain.Page<PaymentSummary>	readAllPaymentsForOwner(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String ownerType, String ownerId, CustomerRef customerRef, org.springframework.data.domain.Pageable page)
void	setPaymentGatewayResourceProvider(com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider paymentGatewayResourceProvider)
void	setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)
protected Map<String,Object>	updateGatewayPaymentIfNecessary(@NonNull UpdatePaymentRequest request, @NonNull Payment payment, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
org.springframework.http.ResponseEntity<PaymentSummary>	updatePayment(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String paymentId, UpdatePaymentRequest req, Integer paymentVersion, CustomerRef customerRef)
protected org.springframework.data.domain.Page<Payment>	validateCustomerPaymentReadAllRequest(@NonNull org.springframework.data.domain.Page<Payment> payments, @NonNull CustomerRef customerRef, @NonNull org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected boolean	validateCustomerPaymentRequest(@NonNull Payment payment, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the given CustomerRef's access to the given Payment.
protected void	validateSavedPaymentMethodIfNecessary(@NonNull CreatePaymentRequest req, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the saved payment method ownership for the given CreatePaymentRequest and CustomerRef if the saved payment method id is specified.
protected void	validateSavedPaymentMethodIfNecessary(@NonNull UpdatePaymentRequest req, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the saved payment method ownership for the given UpdatePaymentRequest and CustomerRef if the saved payment method id is specified.

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

CUSTOMER_AUTHENTICATION_FAILED

public static final String CUSTOMER_AUTHENTICATION_FAILED

See Also:

• Constant Field Values

CUSTOMER_FORBIDDEN_ACCESS

public static final String CUSTOMER_FORBIDDEN_ACCESS

See Also:

• Constant Field Values

Constructor Details

CustomerPaymentManagementEndpoint

public CustomerPaymentManagementEndpoint(PaymentManagementService<Payment> paymentManagementService,
 PaymentService<Payment> paymentService,
 PaymentSummaryService paymentSummaryService,
 PaymentVersionValidationService paymentVersionValidationService,
 PaymentAccessValidationService paymentAccessValidationService,
 SavedPaymentMethodAccessValidationService savedPaymentMethodAccessValidationService)

Method Details

createPayment

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="CUSTOMER_PAYMENT_MANAGEMENT")
public PaymentSummary createPayment(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 CreatePaymentRequest createPaymentRequest,
 CustomerRef customerRef)

readAllPaymentsForOwner

@FrameworkGetMapping(params={"ownerType","ownerId"})
@Policy(permissionRoots="CUSTOMER_PAYMENT_MANAGEMENT")
public org.springframework.data.domain.Page<PaymentSummary> readAllPaymentsForOwner(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam
 String ownerType,
 @RequestParam
 String ownerId,
 CustomerRef customerRef,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

updatePayment

@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
@Policy(permissionRoots="CUSTOMER_PAYMENT_MANAGEMENT")
public org.springframework.http.ResponseEntity<PaymentSummary> updatePayment(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String paymentId,
 @RequestBody
 UpdatePaymentRequest req,
 Integer paymentVersion,
 CustomerRef customerRef)

archivePayment

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="CUSTOMER_PAYMENT_MANAGEMENT")
public void archivePayment(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String paymentId,
 Integer paymentVersion,
 CustomerRef customerRef)

validateSavedPaymentMethodIfNecessary

protected void validateSavedPaymentMethodIfNecessary(@NonNull
 @NonNull CreatePaymentRequest req,
 @NonNull
 @NonNull CustomerRef customerRef,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Validates the saved payment method ownership for the given CreatePaymentRequest and CustomerRef if the saved payment method id is specified.

Parameters:

req - the CreatePaymentRequest to validate

customerRef - the CustomerRef that is attempting to create the payment

contextInfo - context information related to multitenancy

validateSavedPaymentMethodIfNecessary

protected void validateSavedPaymentMethodIfNecessary(@NonNull
 @NonNull UpdatePaymentRequest req,
 @NonNull
 @NonNull CustomerRef customerRef,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Validates the saved payment method ownership for the given UpdatePaymentRequest and CustomerRef if the saved payment method id is specified.

Parameters:

req - the UpdatePaymentRequest to validate

customerRef - the CustomerRef that is attempting to update the payment

contextInfo - context information related to multitenancy

validateCustomerPaymentReadAllRequest

protected org.springframework.data.domain.Page<Payment> validateCustomerPaymentReadAllRequest(@NonNull
 @NonNull org.springframework.data.domain.Page<Payment> payments,
 @NonNull
 @NonNull CustomerRef customerRef,
 @NonNull
 @NonNull org.springframework.data.domain.Pageable page,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

validateCustomerPaymentRequest

protected boolean validateCustomerPaymentRequest(@NonNull
 @NonNull Payment payment,
 @NonNull
 @NonNull CustomerRef customerRef,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Validates the given CustomerRef's access to the given Payment.

Parameters:

payment - the Payment being accessed

customerRef - the CustomerRef representing the user attempting to access the payment

contextInfo - Context information around sandbox and multitenant state

Returns:

true if payment can be accessed by the given CustomerRef, otherwise false

updateGatewayPaymentIfNecessary

@Nullable
protected Map<String,Object> updateGatewayPaymentIfNecessary(@NonNull
 @NonNull UpdatePaymentRequest request,
 @NonNull
 @NonNull Payment payment,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

buildUpdateGatewayPaymentRequest

protected com.broadleafcommerce.paymentgateway.domain.UpdateGatewayPaymentRequest buildUpdateGatewayPaymentRequest(@NonNull
 @NonNull UpdatePaymentRequest req,
 @NonNull
 @NonNull Payment payment,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

buildPaymentInfo

protected com.broadleafcommerce.paymentgateway.domain.PaymentInfo buildPaymentInfo(@NonNull
 @NonNull Payment payment,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

getApplicationId

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

getTenantId

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

getPaymentManagementService

protected PaymentManagementService<Payment> getPaymentManagementService()

getPaymentGatewayResourceProvider

protected com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider getPaymentGatewayResourceProvider()

setPaymentGatewayResourceProvider

@Autowired
public void setPaymentGatewayResourceProvider(com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider paymentGatewayResourceProvider)

getPaymentService

protected PaymentService<Payment> getPaymentService()

getPaymentSummaryService

protected PaymentSummaryService getPaymentSummaryService()

getPaymentVersionValidationService

protected PaymentVersionValidationService getPaymentVersionValidationService()

getPaymentAccessValidationService

protected PaymentAccessValidationService getPaymentAccessValidationService()

getSavedPaymentMethodAccessValidationService

protected SavedPaymentMethodAccessValidationService getSavedPaymentMethodAccessValidationService()

getTypeFactory

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

setTypeFactory

@Autowired
public void setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)