de.hybris.platform.ycommercewebservices.v2.controller

Class UsersController

java.lang.Object

de.hybris.platform.ycommercewebservices.v2.controller.BaseController

de.hybris.platform.ycommercewebservices.v2.controller.BaseCommerceController

de.hybris.platform.ycommercewebservices.v2.controller.UsersController

public class UsersController
extends BaseCommerceController

Main Controller for Users

Field Summary

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

DEFAULT_CURRENT_PAGE, DEFAULT_FIELD_SET, DEFAULT_PAGE_SIZE, HEADER_TOTAL_COUNT

Constructor Summary

Constructors

Constructor and Description
UsersController()

Method Summary

Modifier and Type	Method and Description
void	changeLogin(java.lang.String newLogin, java.lang.String password) Changes customer's login.
void	changePassword(java.lang.String userId, java.lang.String old, java.lang.String newPassword) Changes customer's password.
protected boolean	containsRole(Authentication auth, java.lang.String role)
protected void	convertToCustomer(java.lang.String password, java.lang.String guid)
AddressWsDTO	createAddress(HttpServletRequest request, java.lang.String fields) Creates a new address.
protected OrderHistoriesData	createOrderHistoriesData(SearchPageData<OrderHistoryData> result)
protected ErrorListWsDTO	createResponseErrors(Errors errors)
void	deactivateUser() Removes customer profile.
void	deleteAddress(java.lang.String addressId) Removes customer's address.
void	deletePaymentInfo(java.lang.String paymentDetailsId) Removes customer's credit card payment details based on its ID.
protected java.util.Set<OrderStatus>	extractOrderStatuses(java.lang.String statuses)
protected java.lang.String	getAbsoluteLocationURL(HttpServletRequest httpRequest, java.lang.String uid)
AddressWsDTO	getAddress(java.lang.String addressId, java.lang.String fields) Returns detailed information about address with a given id.
AddressListWsDTO	getAddresses(java.lang.String fields) Returns customer's addresses.
UserGroupListWsDTO	getAllCustomerGroupsForCustomer(java.lang.String userId, java.lang.String fields) Returns all customer groups of a customer.
PaymentDetailsWsDTO	getPaymentDetails(java.lang.String paymentDetailsId, java.lang.String fields) Returns customer's credit card payment details for a given id.
CCPaymentInfoData	getPaymentInfo(java.lang.String paymentDetailsId)
PaymentDetailsListWsDTO	getPaymentInfos(boolean saved, java.lang.String fields) Return customer's credit card payment details list.
UserWsDTO	getUser(java.lang.String fields) Returns customer profile.
protected boolean	isAddressValid(AddressData addressData, Errors errors, AddressValidationData validationData) Checks if address is valid by a validators
void	patchAddress(java.lang.String addressId, HttpServletRequest request) Updates the address.
protected void	populateErrors(Errors errors, AddressVerificationResult<AddressVerificationDecision> addressVerificationResult) Populates Errors object
void	putAddress(java.lang.String addressId, HttpServletRequest request) Updates the address.
void	putPaymentInfo(java.lang.String paymentDetailsId, HttpServletRequest request) Updates existing customer's credit card payment info based on the payment info ID.
void	putUser(java.lang.String firstName, java.lang.String lastName, java.lang.String titleCode, HttpServletRequest request) Updates customer profile.
void	putUser(UserWsDTO user) Updates customer profile.
protected void	registerNewUser(java.lang.String login, java.lang.String password, java.lang.String titleCode, java.lang.String firstName, java.lang.String lastName)
UserWsDTO	registerUser(java.lang.String login, java.lang.String password, java.lang.String titleCode, java.lang.String firstName, java.lang.String lastName, java.lang.String guid, java.lang.String fields, HttpServletRequest httpRequest, HttpServletResponse httpResponse) Registers a customer.
UserWsDTO	registerUser(UserSignUpWsDTO user, java.lang.String fields, HttpServletRequest httpRequest, HttpServletResponse httpResponse) Registers a customer.
void	updatePaymentInfo(java.lang.String paymentDetailsId, HttpServletRequest request) Updates existing customer's credit card payment details based on its ID.
void	updateUser(HttpServletRequest request) Updates customer profile.
protected AddressValidationData	verifyAddresByService(AddressData addressData, Errors errors, AddressValidationData validationData) Verifies address by commerce service
AddressValidationWsDTO	verifyAddress(HttpServletRequest request, java.lang.String fields) Verifies the address.

Methods inherited from class de.hybris.platform.ycommercewebservices.v2.controller.BaseCommerceController

addPaymentDetailsInternal, applyVoucherForCartInternal, createAddressInternal, getAddressDTOValidator, getAddressValidator, getCartFacade, getCcPaymentInfoValidator, getCheckoutFacade, getDeliveryAddressValidator, getHttpRequestAddressDataPopulator, getHttpRequestPaymentInfoPopulator, getPaymentDetailsDTOValidator, getSessionCart, getUserFacade, getVoucherFacade, setAddressDTOValidator, setAddressValidator, setCartDeliveryAddressInternal, setCartDeliveryModeInternal, setCartFacade, setCcPaymentInfoValidator, setCheckoutFacade, setDeliveryAddressValidator, setHttpRequestAddressDataPopulator, setHttpRequestPaymentInfoPopulator, setPaymentDetailsDTOValidator, setPaymentDetailsInternal, setUserFacade, setVoucherFacade, validateCartForPlaceOrder, validateStatusesEnumValue

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

addPaginationField, getDataMapper, handleErrorInternal, handleModelNotFoundException, logParam, logParam, logParam, logValue, sanitize, setDataMapper, setTotalCountHeader, setTotalCountHeader, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersController

public UsersController()

Method Detail

registerUser

public UserWsDTO registerUser(java.lang.String login,
                              java.lang.String password,
                              java.lang.String titleCode,
                              java.lang.String firstName,
                              java.lang.String lastName,
                              java.lang.String guid,
                              java.lang.String fields,
                              HttpServletRequest httpRequest,
                              HttpServletResponse httpResponse)
                       throws DuplicateUidException,
                              RequestParameterException,
                              WebserviceValidationException,
                              java.io.UnsupportedEncodingException

Registers a customer. The following two sets of parameters are available:

• First set is used to register a customer. In this case the required parameters are: login, password, firstName, lastName, titleCode.
• Second set is used to convert a guest to a customer. In this case the required parameters are: guid, password.

Parameters:

login - the login

password - the password

titleCode - the title code

firstName - the first name

lastName - the last name

guid - the guid

fields - the fields

httpRequest - the http request

httpResponse - the http response

Returns:

registered customer

Throws:

DuplicateUidException - the duplicate uid exception

WebserviceValidationException - the webservice validation exception

RequestParameterException - in case given parameters are invalid

java.io.UnsupportedEncodingException - if there utf-8 is not supported when attempting to encode url segments.

registerUser

public UserWsDTO registerUser(UserSignUpWsDTO user,
                              java.lang.String fields,
                              HttpServletRequest httpRequest,
                              HttpServletResponse httpResponse)
                       throws DuplicateUidException,
                              UnknownIdentifierException,
                              java.lang.IllegalArgumentException,
                              WebserviceValidationException,
                              java.io.UnsupportedEncodingException

Registers a customer.

Parameters:

user - User's object

fields - the fields

httpRequest - the http request

httpResponse - the http response

Returns:

registered customer

Throws:

DuplicateUidException - the duplicate uid exception

UnknownIdentifierException - if the title code is invalid

java.lang.IllegalArgumentException - the illegal argument exception

WebserviceValidationException - if any filed is invalid

java.io.UnsupportedEncodingException - if there utf-8 is not supported when attempting to encode url segments.

getAbsoluteLocationURL

protected java.lang.String getAbsoluteLocationURL(HttpServletRequest httpRequest,
                                                  java.lang.String uid)
                                           throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

registerNewUser

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

Throws:

RequestParameterException

DuplicateUidException

convertToCustomer

protected void convertToCustomer(java.lang.String password,
                                 java.lang.String guid)
                          throws RequestParameterException,
                                 DuplicateUidException

Throws:

RequestParameterException

DuplicateUidException

getUser

public UserWsDTO getUser(java.lang.String fields)

Returns customer profile.

Parameters:

fields - the fields

Returns:

Customer profile.

putUser

public void putUser(java.lang.String firstName,
                    java.lang.String lastName,
                    java.lang.String titleCode,
                    HttpServletRequest request)
             throws DuplicateUidException

Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default).

Throws:

DuplicateUidException

putUser

public void putUser(UserWsDTO user)
             throws DuplicateUidException

Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default).

Parameters:

user - User's object

Throws:

DuplicateUidException

updateUser

public void updateUser(HttpServletRequest request)
                throws DuplicateUidException

Updates customer profile. Only attributes provided in the request body will be changed.

Throws:

DuplicateUidException

deactivateUser

public void deactivateUser()

Removes customer profile.

changeLogin

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

Changes customer's login.

Throws:

DuplicateUidException

PasswordMismatchException

RequestParameterException

changePassword

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

Changes customer's password.

containsRole

protected boolean containsRole(Authentication auth,
                               java.lang.String role)

getAddresses

public AddressListWsDTO getAddresses(java.lang.String fields)

Returns customer's addresses.

Returns:

List of customer's addresses

createAddress

public AddressWsDTO createAddress(HttpServletRequest request,
                                  java.lang.String fields)
                           throws WebserviceValidationException

Creates a new address.

Returns:

Created address

Throws:

WebserviceValidationException

getAddress

public AddressWsDTO getAddress(java.lang.String addressId,
                               java.lang.String fields)
                        throws WebserviceValidationException

Returns detailed information about address with a given id.

Returns:

Address data

Throws:

WebserviceValidationException

putAddress

public void putAddress(java.lang.String addressId,
                       HttpServletRequest request)
                throws WebserviceValidationException

Updates the address. Attributes not provided in the request will be defined again (set to null or default).

Throws:

WebserviceValidationException

patchAddress

public void patchAddress(java.lang.String addressId,
                         HttpServletRequest request)
                  throws WebserviceValidationException

Updates the address. Only attributes provided in the request body will be changed.

Throws:

WebserviceValidationException

deleteAddress

public void deleteAddress(java.lang.String addressId)

Removes customer's address.

verifyAddress

public AddressValidationWsDTO verifyAddress(HttpServletRequest request,
                                            java.lang.String fields)

Verifies the address.

Returns:

verification results. If address is incorrect there are information about errors and suggested addresses

isAddressValid

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

Checks if address is valid by a validators

Returns:

true - adress is valid , false - address is invalid

verifyAddresByService

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

Verifies address by commerce service

Returns:

object with verification errors and suggested addresses list

createResponseErrors

protected ErrorListWsDTO createResponseErrors(Errors errors)

populateErrors

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

Populates Errors object

Parameters:

errors -

addressVerificationResult -

getPaymentInfos

public PaymentDetailsListWsDTO getPaymentInfos(boolean saved,
                                               java.lang.String fields)

Return customer's credit card payment details list.

Returns:

Customer's payment details list

getPaymentDetails

public PaymentDetailsWsDTO getPaymentDetails(java.lang.String paymentDetailsId,
                                             java.lang.String fields)

Returns customer's credit card payment details for a given id.

Returns:

Customer's credit card payment details

getPaymentInfo

public CCPaymentInfoData getPaymentInfo(java.lang.String paymentDetailsId)

deletePaymentInfo

public void deletePaymentInfo(java.lang.String paymentDetailsId)

Removes customer's credit card payment details based on its ID.

updatePaymentInfo

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

Updates existing customer's credit card payment details based on its ID. Only attributes given in request will be changed.

Throws:

RequestParameterException

putPaymentInfo

public void putPaymentInfo(java.lang.String paymentDetailsId,
                           HttpServletRequest request)
                    throws RequestParameterException

Updates existing customer's credit card payment info based on the payment info ID. Attributes not given in request will be defined again (set to null or default).

Throws:

RequestParameterException

getAllCustomerGroupsForCustomer

public UserGroupListWsDTO getAllCustomerGroupsForCustomer(java.lang.String userId,
                                                          java.lang.String fields)

Returns all customer groups of a customer.

Returns:

All customer groups of a customer.

extractOrderStatuses

protected java.util.Set<OrderStatus> extractOrderStatuses(java.lang.String statuses)

createOrderHistoriesData

protected OrderHistoriesData createOrderHistoriesData(SearchPageData<OrderHistoryData> result)