de.hybris.platform.ycommercewebservices.v1.controller

Class CustomersController

java.lang.Object

de.hybris.platform.ycommercewebservices.v1.controller.BaseController

de.hybris.platform.ycommercewebservices.v1.controller.CustomersController

public class CustomersController
extends BaseController

Main Controller for CustomerFacade WebServices

Field Summary

Fields inherited from class de.hybris.platform.ycommercewebservices.v1.controller.BaseController

DEFAULT_CURRENT_PAGE, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
CustomersController()

Method Summary

Modifier and Type	Method and Description
void	changeCustomerPassword(java.lang.String customerId, java.lang.String newPassword) Client should pass old and new password in Body.
LoginChangeResponse	changeLogin(java.lang.String newLogin, java.lang.String password) Web service for changing customer login. Sample call: https://localhost:9002/rest/v1/mysite/customers/current/login?newLogin=:newLogin&password=:password Method requires customer authentication and is restricted to HTTPS channel. Method type : POST.
void	changePassword(java.lang.String old, java.lang.String newPassword) Client should pass old and new password in Body.
void	convertAnonymousUserToCustomer(java.lang.String password, HttpSession httpSession) Converts currently logged guest user to full user.
AddressData	createAddress(HttpServletRequest request) Create new address for current customer
protected ErrorListWsDTO	createResponseErrors(Errors errors)
void	deleteAddress(java.lang.String id) Remove address from current customer
void	deletePaymentInfo(java.lang.String id) Web service for deleting current user's credit card payment info by id. Sample call: http://localhost:9001/rest/v1/mysite/customers/paymentinfos/123 Method requires authentication and is restricted to HTTPS channel. Method type : DELETE.
AddressData	editAddress(java.lang.String id, HttpServletRequest request) Edit address from current customer
AddressDataList	getAddresses() Get all customer's addresses
UserGroupDataList	getAllCustomerGroupsForCurrentCustomer()
UserGroupDataList	getAllCustomerGroupsForCustomer(java.lang.String uid) Web service for getting customer groups for current user. Sample call: https://localhost:9002/rest/v1/mysite/customers/{uid}/customergroups Method requires authentication and is restricted to HTTPS channel. Method type : GET.
CustomerData	getCurrentCustomer() Get customer data
CCPaymentInfoData	getPaymentInfo(java.lang.String id) Web service for getting current user's credit card payment info by id. Sample call: https://localhost:9002/rest/v1/mysite/customers/paymentinfos/123 Method requires authentication and is restricted to HTTPS channel. Method type : GET.
CCPaymentInfoDatas	getPaymentInfos(boolean saved) Web service for getting current user's credit card payment infos. Sample call: http://localhost:9001/rest/v1/mysite/customers/paymentinfos?saved=true Method requires authentication and is restricted to HTTPS channel. Method type : GET.
void	guestLogin(java.lang.String email) Creates the user dedicated to do a guest checkout.
protected boolean	isAddressValid(AddressData addressData, Errors errors, AddressValidationData validationData) Checks if address is valid by a validators
protected void	populateErrors(Errors errors, AddressVerificationResult<AddressVerificationDecision> addressVerificationResult) Populates Errors object
void	registerUser(java.lang.String login, java.lang.String password, java.lang.String titleCode, java.lang.String firstName, java.lang.String lastName) Client should pass customer's data as POST Body.
PasswordRestoreResponse	restorePassword(java.lang.String login) Web service for restoring password of current customer. Sample call: https://localhost:9002/rest/v1/mysite/customers/current/forgottenpassword?login=:login/ Method requires client or trusted_client authentication and is restricted to HTTPS channel. Method type : POST.
void	updateDefaultAddress(java.lang.String id) Update customer's default address
void	updatePaymentInfo(java.lang.String paymentInfoId, HttpServletRequest request) Web service for modifying existing payment info. Sample call: https://localhost:9002/rest/v1/mysite/paymentinfos/123 Method requires authentication and is restricted to HTTPS channel. Method type : PUT.
void	updatePaymentInfoAddress(java.lang.String paymentInfoId, HttpServletRequest request) Web service for modifying billing address data for the specific payment info. Sample call: https://localhost:9002/rest/v1/mysite/paymentinfos/123/address Method requires authentication and is restricted to HTTPS channel. Method type : POST.
CustomerData	updateProfile(HttpServletRequest request) Update customer's profile
protected AddressValidationData	verifyAddresByService(AddressData addressData, Errors errors, AddressValidationData validationData) Verifies address by commerce service
AddressValidationData	verifyAddress(HttpServletRequest request) Verifies address

Methods inherited from class de.hybris.platform.ycommercewebservices.v1.controller.BaseController

handleErrorInternal, handleModelNotFoundException, sanitize

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomersController

public CustomersController()

Method Detail

registerUser

public void registerUser(java.lang.String login,
                         java.lang.String password,
                         java.lang.String titleCode,
                         java.lang.String firstName,
                         java.lang.String lastName)
                  throws DuplicateUidException,
                         RequestParameterException

Client should pass customer's data as POST Body. Content-Type needs to be set to application/x-www-form-urlencoded; charset=UTF-8 and sample body (urlencoded) is: old=1234&new=1111
Sample call: https://localhost:9002/rest/v1/mysite/customers
Method requires authentication and is restricted to HTTPS channel.
Method type : POST Register data need to be sent as post body..


Parameters:

login - - login to be created

password - - customer password

firstName - - customer first name

lastName - - customer last name

titleCode - - customer's title

Throws:

DuplicateUidException - in case the requested login already exists

RequestParameterException

guestLogin

public void guestLogin(java.lang.String email)
                throws DuplicateUidException

Creates the user dedicated to do a guest checkout. Newly created user will be available only by cartService and only during the current session.

Parameters:

email - - guest user's e-mail, it will be part of user id

Throws:

DuplicateUidException

convertAnonymousUserToCustomer

public void convertAnonymousUserToCustomer(java.lang.String password,
                                           HttpSession httpSession)
                                    throws DuplicateUidException,
                                           SessionAttributeException

Converts currently logged guest user to full user. It is possible to call it after guest user has placed order during the same session.

Parameters:

password -

httpSession -

Throws:

DuplicateUidException

SessionAttributeException

updateDefaultAddress

public void updateDefaultAddress(java.lang.String id)
                          throws DuplicateUidException

Update customer's default address

Parameters:

id - - Address id to be set as default address

Throws:

DuplicateUidException

updateProfile

public CustomerData updateProfile(HttpServletRequest request)
                           throws DuplicateUidException

Update customer's profile

Parameters:

request - - http request

Returns:

updated profile

Throws:

DuplicateUidException

getAddresses

public AddressDataList getAddresses()

Get all customer's addresses

Returns:

List of customer addresses

createAddress

public AddressData createAddress(HttpServletRequest request)
                          throws DuplicateUidException,
                                 WebserviceValidationException

Create new address for current customer

Parameters:

request -

Returns:

address created

Throws:

DuplicateUidException

WebserviceValidationException

editAddress

public AddressData editAddress(java.lang.String id,
                               HttpServletRequest request)
                        throws WebserviceValidationException

Edit address from current customer

Parameters:

id - - id of address to be edited

Returns:

modified address

Throws:

WebserviceValidationException

deleteAddress

public void deleteAddress(java.lang.String id)

Remove address from current customer

Parameters:

id - - id of address to be removed

getCurrentCustomer

public CustomerData getCurrentCustomer()

Get customer data

Returns:

CustomerData object containing customer information

changePassword

public void changePassword(java.lang.String old,
                           java.lang.String newPassword)

Client should pass old and new password in Body. Content-Type needs to be set to application/x-www-form-urlencoded; charset=UTF-8 and sample body (urlencoded) is: old=1234&new=1111

Parameters:

old - - old password

newPassword - - new password

getPaymentInfos

public CCPaymentInfoDatas getPaymentInfos(boolean saved)

Web service for getting current user's credit card payment infos.
Sample call: http://localhost:9001/rest/v1/mysite/customers/paymentinfos?saved=true
Method requires authentication and is restricted to HTTPS channel.
Method type : GET.


Parameters:

saved - - true to retrieve only saved payment infos. false by default

Returns:

List of CCPaymentInfoData as response body

getPaymentInfo

public CCPaymentInfoData getPaymentInfo(java.lang.String id)

Web service for getting current user's credit card payment info by id.
Sample call: https://localhost:9002/rest/v1/mysite/customers/paymentinfos/123
Method requires authentication and is restricted to HTTPS channel.
Method type : GET.


Returns:

CCPaymentInfoData as response body

deletePaymentInfo

public void deletePaymentInfo(java.lang.String id)

Web service for deleting current user's credit card payment info by id.
Sample call: http://localhost:9001/rest/v1/mysite/customers/paymentinfos/123
Method requires authentication and is restricted to HTTPS channel.
Method type : DELETE.


updatePaymentInfoAddress

public void updatePaymentInfoAddress(java.lang.String paymentInfoId,
                                     HttpServletRequest request)
                              throws RequestParameterException

Web service for modifying billing address data for the specific payment info.
Sample call: https://localhost:9002/rest/v1/mysite/paymentinfos/123/address
Method requires authentication and is restricted to HTTPS channel.
Method type : POST. Address data need to be sent as post body.
Method uses HttpRequestAddressDataPopulator to populate address data from request parameters.

Parameters:

paymentInfoId -

request -

Throws:

RequestParameterException

updatePaymentInfo

public void updatePaymentInfo(java.lang.String paymentInfoId,
                              HttpServletRequest request)
                       throws RequestParameterException

Web service for modifying existing payment info.
Sample call: https://localhost:9002/rest/v1/mysite/paymentinfos/123
Method requires authentication and is restricted to HTTPS channel.
Method type : PUT. PaymentInfo data need to be sent in body.
Method uses HttpRequestPaymentInfoPopulator to populate payment info data from request parameters.

Parameters:

paymentInfoId -

request -

Throws:

RequestParameterException

getAllCustomerGroupsForCurrentCustomer

public UserGroupDataList getAllCustomerGroupsForCurrentCustomer()

getAllCustomerGroupsForCustomer

public UserGroupDataList getAllCustomerGroupsForCustomer(java.lang.String uid)

Web service for getting customer groups for current user.
Sample call: https://localhost:9002/rest/v1/mysite/customers/{uid}/customergroups
Method requires authentication and is restricted to HTTPS channel.
Method type : GET.

Returns:

UserGroupDataList as response body

changeLogin

public LoginChangeResponse changeLogin(java.lang.String newLogin,
                                       java.lang.String password)
                                throws DuplicateUidException,
                                       PasswordMismatchException,
                                       RequestParameterException

Web service for changing customer login.
Sample call: https://localhost:9002/rest/v1/mysite/customers/current/login?newLogin=:newLogin&password=:password
Method requires customer authentication and is restricted to HTTPS channel.
Method type : POST.

Parameters:

newLogin -

password -

Returns:

LoginChangeResponse

Throws:

DuplicateUidException

PasswordMismatchException

RequestParameterException

restorePassword

public PasswordRestoreResponse restorePassword(java.lang.String login)

Web service for restoring password of current customer.
Sample call: https://localhost:9002/rest/v1/mysite/customers/current/forgottenpassword?login=:login/
Method requires client or trusted_client authentication and is restricted to HTTPS channel.
Method type : POST.

Parameters:

login -

Returns:

PasswordRestoreResponse

changeCustomerPassword

public void changeCustomerPassword(java.lang.String customerId,
                                   java.lang.String newPassword)

Client should pass old and new password in Body. Content-Type needs to be set to application/x-www-form-urlencoded; charset=UTF-8 and sample body (urlencoded) is: new=1111

Parameters:

newPassword - - new password

verifyAddress

public AddressValidationData verifyAddress(HttpServletRequest request)

Verifies address

Parameters:

request -

Returns:

address created

isAddressValid

protected boolean isAddressValid(AddressData addressData,
                                 Errors errors,
                                 AddressValidationData validationData)

Checks if address is valid by a validators

Parameters:

addressData -

errors -

validationData -

Returns:

true if address is valid; false otherwise

verifyAddresByService

protected AddressValidationData verifyAddresByService(AddressData addressData,
                                                      Errors errors,
                                                      AddressValidationData validationData)

Verifies address by commerce service

Parameters:

addressData -

errors -

validationData -

Returns:

verified address

createResponseErrors

protected ErrorListWsDTO createResponseErrors(Errors errors)

populateErrors

protected void populateErrors(Errors errors,
                              AddressVerificationResult<AddressVerificationDecision> addressVerificationResult)

Populates Errors object

Parameters:

errors -

addressVerificationResult -