Package de.hybris.platform.commercewebservices.core.v2.controller

Class AddressController

java.lang.Object

de.hybris.platform.commercewebservices.core.v2.controller.BaseController

de.hybris.platform.commercewebservices.core.v2.controller.BaseCommerceController

de.hybris.platform.commercewebservices.core.v2.controller.AddressController

@Controller
@RequestMapping("/{baseSiteId}/users/{userId}/addresses")
public class AddressController
extends BaseCommerceController

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDRESS_DOES_NOT_EXIST

Fields inherited from class de.hybris.platform.commercewebservices.core.v2.controller.BaseCommerceController

API_COMPATIBILITY_B2C_CHANNELS, ENTRY

Fields inherited from class de.hybris.platform.commercewebservices.core.v2.controller.BaseController

BASIC_FIELD_SET, DEFAULT_CURRENT_PAGE, DEFAULT_FIELD_SET, DEFAULT_PAGE_SIZE, HEADER_TOTAL_COUNT, INVALID_REQUEST_BODY_ERROR_MESSAGE

Constructor Summary

Constructors

Constructor	Description
AddressController()

Method Summary

Modifier and Type	Method	Description
AddressWsDTO	createAddress(AddressWsDTO address, String fields)
AddressWsDTO	createAddress(javax.servlet.http.HttpServletRequest request, String fields)	Deprecated, for removal: This API element is subject to removal in a future version. since 2005.
protected ErrorListWsDTO	createResponseErrors(org.springframework.validation.Errors errors)
AddressWsDTO	getAddress(String addressId, String fields)
AddressListWsDTO	getAddresses(String fields)
protected boolean	isAddressValid(AddressData addressData, org.springframework.validation.Errors errors, AddressValidationData validationData)	Checks if address is valid by a validators
protected void	populateErrors(org.springframework.validation.Errors errors, AddressVerificationResult<AddressVerificationDecision> addressVerificationResult)	Populates Errors object
void	removeAddress(String addressId)
void	replaceAddress(String addressId, AddressWsDTO address)
void	replaceAddress(String addressId, javax.servlet.http.HttpServletRequest request)	Deprecated, for removal: This API element is subject to removal in a future version. since 2005.
void	updateAddress(String addressId, AddressWsDTO address)
void	updateAddress(String addressId, javax.servlet.http.HttpServletRequest request)	Deprecated, for removal: This API element is subject to removal in a future version. since 2005.
AddressValidationWsDTO	validateAddress(AddressWsDTO address, String fields)
AddressValidationWsDTO	validateAddress(javax.servlet.http.HttpServletRequest request, String fields)	Deprecated, for removal: This API element is subject to removal in a future version. since 2005.
protected AddressValidationData	verifyAddresByService(AddressData addressData, org.springframework.validation.Errors errors, AddressValidationData validationData)	Verifies address by commerce service

Methods inherited from class de.hybris.platform.commercewebservices.core.v2.controller.BaseCommerceController

addPaymentDetailsInternal, applyVoucherForCartInternal, createAddressInternal, createAddressInternal, getAddressDTOValidator, getAddressValidator, getCartFacade, getCartVoucherValidator, 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.commercewebservices.core.v2.controller.BaseController

addPaginationField, getDataMapper, handleDuplicateUidException, handleErrorInternal, handleHttpMessageNotReadableException, handleModelNotFoundException, 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

Field Details

ADDRESS_DOES_NOT_EXIST

public static final String ADDRESS_DOES_NOT_EXIST

See Also:

• Constant Field Values

Constructor Details

AddressController

public AddressController()

Method Details

getAddresses

@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(method=GET)
@ResponseBody
public AddressListWsDTO getAddresses(@RequestParam(defaultValue="DEFAULT")
 String fields)

createAddress

@Deprecated(since="2005",
            forRemoval=true)
@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(method=POST)
@ResponseBody
@ResponseStatus(CREATED)
public AddressWsDTO createAddress(javax.servlet.http.HttpServletRequest request,
 @RequestParam(defaultValue="DEFAULT")
 String fields)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2005. Please use createAddress(AddressWsDTO, String) instead.

createAddress

@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(method=POST,
                consumes={"application/json","application/xml"})
@ResponseBody
@ResponseStatus(CREATED)
public AddressWsDTO createAddress(@RequestBody
 AddressWsDTO address,
 @RequestParam(defaultValue="DEFAULT")
 String fields)

getAddress

@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/{addressId}",
                method=GET)
@ResponseBody
public AddressWsDTO getAddress(@PathVariable
 String addressId,
 @RequestParam(defaultValue="DEFAULT")
 String fields)

replaceAddress

@Deprecated(since="2005",
            forRemoval=true)
@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/{addressId}",
                method=PUT)
@ResponseStatus(OK)
public void replaceAddress(@PathVariable
 String addressId,
 javax.servlet.http.HttpServletRequest request)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2005. Please use replaceAddress(String, AddressWsDTO) instead.

replaceAddress

@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/{addressId}",
                method=PUT,
                consumes={"application/json","application/xml"})
@ResponseStatus(OK)
public void replaceAddress(@PathVariable
 String addressId,
 @RequestBody
 AddressWsDTO address)

updateAddress

@Deprecated(since="2005",
            forRemoval=true)
@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/{addressId}",
                method=PATCH)
@ResponseStatus(OK)
public void updateAddress(@PathVariable
 String addressId,
 javax.servlet.http.HttpServletRequest request)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2005. Please use updateAddress(String, AddressWsDTO) instead.

updateAddress

@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/{addressId}",
                method=PATCH,
                consumes={"application/json","application/xml"})
@ResponseStatus(OK)
public void updateAddress(@PathVariable
 String addressId,
 @RequestBody
 AddressWsDTO address)

removeAddress

@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/{addressId}",
                method=DELETE)
@ResponseStatus(OK)
public void removeAddress(@PathVariable
 String addressId)

validateAddress

@Deprecated(since="2005",
            forRemoval=true)
@Secured({"ROLE_CUSTOMERGROUP","ROLE_CLIENT","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/verification",
                method=POST)
@ResponseBody
public AddressValidationWsDTO validateAddress(javax.servlet.http.HttpServletRequest request,
 @RequestParam(defaultValue="DEFAULT")
 String fields)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2005. Please use validateAddress(AddressWsDTO, String) instead.

validateAddress

@Secured({"ROLE_CUSTOMERGROUP","ROLE_CLIENT","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/verification",
                method=POST,
                consumes={"application/json","application/xml"})
@ResponseBody
public AddressValidationWsDTO validateAddress(@RequestBody
 AddressWsDTO address,
 @RequestParam(defaultValue="DEFAULT")
 String fields)

isAddressValid

protected boolean isAddressValid(AddressData addressData,
 org.springframework.validation.Errors errors,
 AddressValidationData validationData)

Checks if address is valid by a validators

Returns:

true - address is valid , false - address is invalid

verifyAddresByService

protected AddressValidationData verifyAddresByService(AddressData addressData,
 org.springframework.validation.Errors errors,
 AddressValidationData validationData)

Verifies address by commerce service

Returns:

object with verification errors and suggested addresses list

createResponseErrors

protected ErrorListWsDTO createResponseErrors(org.springframework.validation.Errors errors)

populateErrors

protected void populateErrors(org.springframework.validation.Errors errors,
 AddressVerificationResult<AddressVerificationDecision> addressVerificationResult)

Populates Errors object

Parameters:

errors -

addressVerificationResult -