Package de.hybris.platform.ycommercewebservices.v2.controller

Class AddressController

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

    • Field Detail

      • ADDRESS_DOES_NOT_EXIST

        public static final java.lang.String ADDRESS_DOES_NOT_EXIST
        See Also:
        Constant Field Values

    • Constructor Detail

      • AddressController

        public AddressController()

    • Method Detail

      • getAddresses

        @Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(method=GET)
@ResponseBody
public AddressListWsDTO getAddresses​(@RequestParam(defaultValue="DEFAULT")
                                     java.lang.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")
                                  java.lang.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")
                                  java.lang.String fields)

      • getAddress

        @Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/{addressId}",
                method=GET)
@ResponseBody
public AddressWsDTO getAddress​(@PathVariable
                               java.lang.String addressId,
                               @RequestParam(defaultValue="DEFAULT")
                               java.lang.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
                           java.lang.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
                           java.lang.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
                          java.lang.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
                          java.lang.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
                          java.lang.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")
                                              java.lang.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")
                                              java.lang.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)