Package com.broadleafcommerce.paymenttransaction.web.endpoint

Class CustomerSavedPaymentMethodManagementEndpoint

java.lang.Object

com.broadleafcommerce.paymenttransaction.web.endpoint.CustomerSavedPaymentMethodManagementEndpoint

@FrameworkRestController
@FrameworkMapping("/customers/{customerId}/saved-payment-methods")
@DataRouteByKey("paymentTransaction")
@ConditionalOnPaymentTransactionAsSavedPaymentStorageLocation
public class CustomerSavedPaymentMethodManagementEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
CustomerSavedPaymentMethodManagementEndpoint(SavedPaymentMethodService<SavedPaymentMethod> savedPaymentMethodService, SavedPaymentMethodSummaryService summaryService, SavedPaymentMethodVersionValidationService savedPaymentMethodVersionValidationService)

Method Summary

Modifier and Type	Method	Description
SavedPaymentMethodSummary	createSavedPaymentMethod(String customerId, CreateSavedPaymentMethodRequest createRequest, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteSavedPaymentMethod(String customerId, String savedPaymentMethodId, Integer version, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected SavedPaymentMethodService<SavedPaymentMethod>	getSavedPaymentMethodService()
protected SavedPaymentMethodVersionValidationService	getSavedPaymentMethodVersionValidationService()
protected SavedPaymentMethodSummaryService	getSummaryService()
SavedPaymentMethodSummary	readSavedPaymentMethod(String customerId, String savedPaymentMethodId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<SavedPaymentMethodSummary>	readSavedPaymentMethods(String customerId, boolean availableToUse, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
SavedPaymentMethodSummary	updateSavedPaymentMethod(String customerId, String savedPaymentMethodId, UpdateSavedPaymentMethodRequest updateRequest, Integer version, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

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

Constructor Details

CustomerSavedPaymentMethodManagementEndpoint

public CustomerSavedPaymentMethodManagementEndpoint(SavedPaymentMethodService<SavedPaymentMethod> savedPaymentMethodService,
 SavedPaymentMethodSummaryService summaryService,
 SavedPaymentMethodVersionValidationService savedPaymentMethodVersionValidationService)

Method Details

readSavedPaymentMethods

@Policy(permissionRoots="CUSTOMER_SAVED_PAYMENT_MANAGEMENT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="customer_id")
@FrameworkGetMapping
public org.springframework.data.domain.Page<SavedPaymentMethodSummary> readSavedPaymentMethods(@PathVariable("customerId")
 String customerId,
 @RequestParam(value="availableToUse",required=false,defaultValue="true")
 boolean availableToUse,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

createSavedPaymentMethod

@Policy(permissionRoots="CUSTOMER_SAVED_PAYMENT_MANAGEMENT")
@FrameworkPostMapping
public SavedPaymentMethodSummary createSavedPaymentMethod(@PathVariable("customerId")
 String customerId,
 @RequestBody
 CreateSavedPaymentMethodRequest createRequest,
 CustomerRef customerRef,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readSavedPaymentMethod

@Policy(permissionRoots="CUSTOMER_SAVED_PAYMENT_MANAGEMENT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="customer_id")
@FrameworkGetMapping("/{savedPaymentMethodId}")
public SavedPaymentMethodSummary readSavedPaymentMethod(@PathVariable("customerId")
 String customerId,
 @PathVariable("savedPaymentMethodId")
 String savedPaymentMethodId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

updateSavedPaymentMethod

@Policy(permissionRoots="CUSTOMER_SAVED_PAYMENT_MANAGEMENT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="customer_id")
@FrameworkPatchMapping("/{savedPaymentMethodId}")
public SavedPaymentMethodSummary updateSavedPaymentMethod(@PathVariable("customerId")
 String customerId,
 @PathVariable("savedPaymentMethodId")
 String savedPaymentMethodId,
 @RequestBody
 UpdateSavedPaymentMethodRequest updateRequest,
 Integer version,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteSavedPaymentMethod

@Policy(permissionRoots="CUSTOMER_SAVED_PAYMENT_MANAGEMENT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="customer_id")
@FrameworkDeleteMapping("/{savedPaymentMethodId}")
@ResponseStatus(NO_CONTENT)
public void deleteSavedPaymentMethod(@PathVariable("customerId")
 String customerId,
 @PathVariable("savedPaymentMethodId")
 String savedPaymentMethodId,
 Integer version,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getSavedPaymentMethodService

protected SavedPaymentMethodService<SavedPaymentMethod> getSavedPaymentMethodService()

getSummaryService

protected SavedPaymentMethodSummaryService getSummaryService()

getSavedPaymentMethodVersionValidationService

protected SavedPaymentMethodVersionValidationService getSavedPaymentMethodVersionValidationService()