com.broadleafcommerce.rest.api.endpoint.customer

Class CustomerEndpoint

java.lang.Object

com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

com.broadleafcommerce.rest.api.endpoint.customer.CustomerEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.MessageSourceAware

@FrameworkRestController
 @FrameworkMapping(value="/customer",
                  produces={"application/json","application/xml"})
public class CustomerEndpoint
extends BaseEndpoint

This endpoint depends on JAX-RS. It should be extended by components that actually wish to provide an endpoint. The annotations such as @Path, @Scope, @Context, @PathParam, @QueryParam,

Author:

Jay Aisenbrey (cja769)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.core.web.controller.account.validator.ChangePasswordValidator	changePasswordValidator
protected org.broadleafcommerce.profile.core.service.CustomerAddressService	customerAddressService
protected org.broadleafcommerce.profile.core.service.CustomerPaymentService	customerPaymentService
protected org.broadleafcommerce.profile.core.service.CustomerService	customerService

Fields inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

context, messageSource

Constructor Summary

Constructors

Constructor and Description
CustomerEndpoint()

Method Summary

Modifier and Type	Method and Description
CustomerAddressWrapper	addAddress(javax.servlet.http.HttpServletRequest request, CustomerAddressWrapper wrapper)
CustomerAddressWrapper	addAddress(javax.servlet.http.HttpServletRequest request, Long customerId, CustomerAddressWrapper wrapper)
CustomerWrapper	addAttribute(javax.servlet.http.HttpServletRequest request, CustomerAttributeWrapper wrapper)
CustomerWrapper	addAttribute(javax.servlet.http.HttpServletRequest request, Long customerId, CustomerAttributeWrapper wrapper)
CustomerWrapper	addCustomer(javax.servlet.http.HttpServletRequest request, CustomerWrapper wrapper)
CustomerPaymentWrapper	addCustomerPayment(javax.servlet.http.HttpServletRequest request, CustomerPaymentWrapper wrapper)
CustomerPaymentWrapper	addCustomerPayment(javax.servlet.http.HttpServletRequest request, Long customerId, CustomerPaymentWrapper wrapper)
CustomerWrapper	changePassword(javax.servlet.http.HttpServletRequest request, org.broadleafcommerce.core.web.controller.account.ChangePasswordForm changePasswordForm, org.springframework.validation.BindingResult result)
CustomerAddressWrapper	findAddress(javax.servlet.http.HttpServletRequest request, Long customerId, String addressName)
CustomerAddressWrapper	findAddress(javax.servlet.http.HttpServletRequest request, String addressName)
List<CustomerAddressWrapper>	findAllAddresses(javax.servlet.http.HttpServletRequest request)
List<CustomerAddressWrapper>	findAllAddresses(javax.servlet.http.HttpServletRequest request, Long customerId)
List<CustomerPaymentWrapper>	findAllCustomerPayments(javax.servlet.http.HttpServletRequest request)
List<CustomerPaymentWrapper>	findAllCustomerPayments(javax.servlet.http.HttpServletRequest request, Long customerId)
CustomerWrapper	findCustomer(javax.servlet.http.HttpServletRequest request, Long customerId) Returns the current customer via CustomerState
CustomerWrapper	findCustomerByEmail(javax.servlet.http.HttpServletRequest request, String emailAddress)
CustomerPaymentWrapper	findCustomerPayment(javax.servlet.http.HttpServletRequest request, Long paymentId)
CustomerPaymentWrapper	findCustomerPayment(javax.servlet.http.HttpServletRequest request, Long customerId, Long paymentId)
protected org.broadleafcommerce.profile.core.domain.Customer	getCustomer(Long customerId)
List<CustomerAddressWrapper>	removeAddress(javax.servlet.http.HttpServletRequest request, Long customerId, String addressName)
List<CustomerAddressWrapper>	removeAddress(javax.servlet.http.HttpServletRequest request, String addressName)
CustomerWrapper	removeAllAddresses(javax.servlet.http.HttpServletRequest request)
CustomerWrapper	removeAllAddresses(javax.servlet.http.HttpServletRequest request, Long customerId)
CustomerWrapper	removeAllAttributes(javax.servlet.http.HttpServletRequest request)
CustomerWrapper	removeAllAttributes(javax.servlet.http.HttpServletRequest request, Long customerId)
CustomerWrapper	removeAllCustomerPayments(javax.servlet.http.HttpServletRequest request)
CustomerWrapper	removeAllCustomerPayments(javax.servlet.http.HttpServletRequest request, Long customerId)
CustomerWrapper	removeAttribute(javax.servlet.http.HttpServletRequest request, Long customerId, String attributeName)
CustomerWrapper	removeAttribute(javax.servlet.http.HttpServletRequest request, String attributeName)
List<CustomerPaymentWrapper>	removeCustomerPayment(javax.servlet.http.HttpServletRequest request, Long paymentId)
List<CustomerPaymentWrapper>	removeCustomerPayment(javax.servlet.http.HttpServletRequest request, Long customerId, Long paymentId)
CustomerAddressWrapper	updateAddress(javax.servlet.http.HttpServletRequest request, Long customerAddressId, CustomerAddressWrapper wrapper)
CustomerAddressWrapper	updateAddress(javax.servlet.http.HttpServletRequest request, Long customerId, Long customerAddressId, CustomerAddressWrapper wrapper)
CustomerWrapper	updateCustomer(javax.servlet.http.HttpServletRequest request, CustomerWrapper wrapper)
CustomerPaymentWrapper	updateCustomerPayment(javax.servlet.http.HttpServletRequest request, Long paymentId, CustomerPaymentWrapper wrapper)
CustomerPaymentWrapper	updateCustomerPayment(javax.servlet.http.HttpServletRequest request, Long customerId, Long paymentId, CustomerPaymentWrapper wrapper)

Methods inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

getApplicationContext, getMessageSource, setApplicationContext, setMessageSource

Methods inherited from class java.lang.Object

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

Field Detail

customerService

protected org.broadleafcommerce.profile.core.service.CustomerService customerService

changePasswordValidator

protected org.broadleafcommerce.core.web.controller.account.validator.ChangePasswordValidator changePasswordValidator

customerAddressService

protected org.broadleafcommerce.profile.core.service.CustomerAddressService customerAddressService

customerPaymentService

protected org.broadleafcommerce.profile.core.service.CustomerPaymentService customerPaymentService

Constructor Detail

CustomerEndpoint

public CustomerEndpoint()

Method Detail

findCustomerByEmail

@FrameworkMapping(method=GET)
public CustomerWrapper findCustomerByEmail(javax.servlet.http.HttpServletRequest request,
                                                                         @RequestParam(value="email",required=true)
                                                                         String emailAddress)

findCustomer

public CustomerWrapper findCustomer(javax.servlet.http.HttpServletRequest request,
                                    Long customerId)

Returns the current customer via CustomerState

Parameters:

request -

Returns:

addCustomer

@FrameworkMapping(method=POST,
                  consumes={"application/json","application/xml"})
public CustomerWrapper addCustomer(javax.servlet.http.HttpServletRequest request,
                                                                                                                                     @RequestBody
                                                                                                                                     CustomerWrapper wrapper)

updateCustomer

@FrameworkMapping(method=PUT,
                  consumes={"application/json","application/xml"})
public CustomerWrapper updateCustomer(javax.servlet.http.HttpServletRequest request,
                                                                                                                                       @RequestBody
                                                                                                                                       CustomerWrapper wrapper)

changePassword

@FrameworkMapping(method=POST,
                  value="/password",
                  consumes={"application/json","application/xml"})
public CustomerWrapper changePassword(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                             @RequestBody
                                                                                                                                                                             org.broadleafcommerce.core.web.controller.account.ChangePasswordForm changePasswordForm,
                                                                                                                                                                             org.springframework.validation.BindingResult result)

removeAllAttributes

@FrameworkMapping(value="/attributes",
                  method=DELETE)
public CustomerWrapper removeAllAttributes(javax.servlet.http.HttpServletRequest request)

removeAllAttributes

public CustomerWrapper removeAllAttributes(javax.servlet.http.HttpServletRequest request,
                                           Long customerId)

addAttribute

@FrameworkMapping(value="/attribute",
                  method=PUT,
                  consumes={"application/json","application/xml"})
public CustomerWrapper addAttribute(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                           @RequestBody
                                                                                                                                                                           CustomerAttributeWrapper wrapper)

addAttribute

public CustomerWrapper addAttribute(javax.servlet.http.HttpServletRequest request,
                                    Long customerId,
                                    CustomerAttributeWrapper wrapper)

removeAttribute

@FrameworkMapping(value="/attribute/{attributeName}",
                  method=DELETE)
public CustomerWrapper removeAttribute(javax.servlet.http.HttpServletRequest request,
                                                                                                                              @PathVariable(value="attributeName")
                                                                                                                              String attributeName)

removeAttribute

public CustomerWrapper removeAttribute(javax.servlet.http.HttpServletRequest request,
                                       Long customerId,
                                       String attributeName)

findAddress

@FrameworkMapping(value="/address",
                  method=GET)
public CustomerAddressWrapper findAddress(javax.servlet.http.HttpServletRequest request,
                                                                                                            @RequestParam(value="addressName")
                                                                                                            String addressName)

findAddress

public CustomerAddressWrapper findAddress(javax.servlet.http.HttpServletRequest request,
                                          Long customerId,
                                          String addressName)

findAllAddresses

@FrameworkMapping(value="/addresses",
                  method=GET)
public List<CustomerAddressWrapper> findAllAddresses(javax.servlet.http.HttpServletRequest request)

findAllAddresses

public List<CustomerAddressWrapper> findAllAddresses(javax.servlet.http.HttpServletRequest request,
                                                     Long customerId)

addAddress

@FrameworkMapping(value="/address",
                  method=PUT,
                  consumes={"application/json","application/xml"})
public CustomerAddressWrapper addAddress(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                              @RequestBody
                                                                                                                                                                              CustomerAddressWrapper wrapper)

addAddress

public CustomerAddressWrapper addAddress(javax.servlet.http.HttpServletRequest request,
                                         Long customerId,
                                         CustomerAddressWrapper wrapper)

updateAddress

@FrameworkMapping(value="/address/{addressId}",
                  method=PUT,
                  consumes={"application/json","application/xml"})
public CustomerAddressWrapper updateAddress(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                             @PathVariable(value="addressId")
                                                                                                                                                                                             Long customerAddressId,
                                                                                                                                                                                             @RequestBody
                                                                                                                                                                                             CustomerAddressWrapper wrapper)

updateAddress

public CustomerAddressWrapper updateAddress(javax.servlet.http.HttpServletRequest request,
                                            Long customerId,
                                            Long customerAddressId,
                                            CustomerAddressWrapper wrapper)

removeAllAddresses

@FrameworkMapping(value="/addresses",
                  method=DELETE)
public CustomerWrapper removeAllAddresses(javax.servlet.http.HttpServletRequest request)

removeAllAddresses

public CustomerWrapper removeAllAddresses(javax.servlet.http.HttpServletRequest request,
                                          Long customerId)

removeAddress

@FrameworkMapping(value="/address/{addressName}",
                  method=DELETE)
public List<CustomerAddressWrapper> removeAddress(javax.servlet.http.HttpServletRequest request,
                                                                                                                                     @PathVariable(value="addressName")
                                                                                                                                     String addressName)

removeAddress

public List<CustomerAddressWrapper> removeAddress(javax.servlet.http.HttpServletRequest request,
                                                  Long customerId,
                                                  String addressName)

findCustomerPayment

@FrameworkMapping(value="/payment",
                  method=GET)
public CustomerPaymentWrapper findCustomerPayment(javax.servlet.http.HttpServletRequest request,
                                                                                                                    @RequestParam(value="paymentId")
                                                                                                                    Long paymentId)

findCustomerPayment

public CustomerPaymentWrapper findCustomerPayment(javax.servlet.http.HttpServletRequest request,
                                                  Long customerId,
                                                  Long paymentId)

findAllCustomerPayments

@FrameworkMapping(value="/payments",
                  method=GET)
public List<CustomerPaymentWrapper> findAllCustomerPayments(javax.servlet.http.HttpServletRequest request)

findAllCustomerPayments

public List<CustomerPaymentWrapper> findAllCustomerPayments(javax.servlet.http.HttpServletRequest request,
                                                            Long customerId)

addCustomerPayment

@FrameworkMapping(value="/payment",
                  method=POST,
                  consumes={"application/json","application/xml"})
public CustomerPaymentWrapper addCustomerPayment(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                       @RequestBody
                                                                                                                                                                                       CustomerPaymentWrapper wrapper)

addCustomerPayment

public CustomerPaymentWrapper addCustomerPayment(javax.servlet.http.HttpServletRequest request,
                                                 Long customerId,
                                                 CustomerPaymentWrapper wrapper)

updateCustomerPayment

@FrameworkMapping(value="/payment/{paymentId}",
                  method=PUT,
                  consumes={"application/json","application/xml"})
public CustomerPaymentWrapper updateCustomerPayment(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                     @PathVariable
                                                                                                                                                                                                     Long paymentId,
                                                                                                                                                                                                     @RequestBody
                                                                                                                                                                                                     CustomerPaymentWrapper wrapper)

updateCustomerPayment

public CustomerPaymentWrapper updateCustomerPayment(javax.servlet.http.HttpServletRequest request,
                                                    Long customerId,
                                                    Long paymentId,
                                                    CustomerPaymentWrapper wrapper)

removeAllCustomerPayments

@FrameworkMapping(value="/payments",
                  method=DELETE)
public CustomerWrapper removeAllCustomerPayments(javax.servlet.http.HttpServletRequest request)

removeAllCustomerPayments

public CustomerWrapper removeAllCustomerPayments(javax.servlet.http.HttpServletRequest request,
                                                 Long customerId)

removeCustomerPayment

@FrameworkMapping(value="/payment/{paymentId}",
                  method=DELETE)
public List<CustomerPaymentWrapper> removeCustomerPayment(javax.servlet.http.HttpServletRequest request,
                                                                                                                                           @PathVariable(value="paymentId")
                                                                                                                                           Long paymentId)

removeCustomerPayment

public List<CustomerPaymentWrapper> removeCustomerPayment(javax.servlet.http.HttpServletRequest request,
                                                          Long customerId,
                                                          Long paymentId)

getCustomer

protected org.broadleafcommerce.profile.core.domain.Customer getCustomer(Long customerId)