* Copyright (c) MuleSoft, Inc. All rights reserved. http://www.mulesoft.com

*

* The software in this package is published under the terms of the CPAL v1.0

* license, a copy of which has been included with this distribution in the

* LICENSE.md file.

*/

* Magento is a feature-rich eCommerce platform built on open-source technology that provides online merchants with

* great and control over the look, content and functionality of their eCommerce store.

*

* @author MuleSoft, Inc.

*/

  private static final String ENTITY_PACKAGE = "com.magento.api";

 

  private MagentoOrderClient<MagentoException> orderClient;

    private MagentoCustomerClient<MagentoException> customerClient;

    private MagentoInventoryClient<MagentoException> inventoryClient;

    private MagentoDirectoryClient<MagentoException> directoryClient;

    private MagentoCatalogClient<MagentoException> catalogClient;

    private MagentoShoppingCartClient<MagentoException> shoppingCartClient;

    /**

     *

     */

    private String user;

    /**

     * The address to access Magento Web Services

     */

    private String serverAddress;

    /**

     *

     * @param username The user name to access Magento Web Services

     * @param password The password to access Magento Web Services

     * @param address The address to access Magento Web Services

     */

    @Connect

    public void initialiseConnector(@ConnectionKey String username, @Password String password, String address)

            throws ConnectionException {

        setUser(username);

        setServerAddress(address);

        PortProviderInitializer initializer = new PortProviderInitializer(username, password, address);

        setOrderClient(new AxisMagentoOrderClient(initializer.getPortProvider()));

        setCustomerClient(new AxisMagentoCustomerClient(initializer.getPortProvider()));

        setInventoryClient(new AxisMagentoInventoryClient(initializer.getPortProvider()));

        setDirectoryClient(new AxisMagentoDirectoryClient(initializer.getPortProvider()));

        setCatalogClient(new AxisMagentoCatalogClient(initializer.getPortProvider()));

        setShoppingCartClient(new AxisMagentoShoppingCartClient(initializer.getPortProvider()));

        //Dummy operation for connectivity testing

        try {

            getCatalogCurrentStoreView();

        } catch (Exception e) {

            throw new ConnectionException(ConnectionExceptionCode.INCORRECT_CREDENTIALS, null, e.getMessage());

        }

    }

    @ValidateConnection

    public boolean validateConnection() {

        return orderClient != null && customerClient != null && inventoryClient != null && directoryClient != null &&

                catalogClient != null && shoppingCartClient != null;

    }

    @Disconnect

    public void disconnect() {

        setOrderClient(null);

        setCustomerClient(null);

        setInventoryClient(null);

        setDirectoryClient(null);

        setCatalogClient(null);

        setShoppingCartClient(null);

    }

   

    @ConnectionIdentifier

    public String connectionId() {

        return String.format("%s-at-%s", getUser(), getServerAddress());

    }

   

    private MetaDataKey createKey(Class<?> cls) {

        return new DefaultMetaDataKey(cls.getSimpleName(), cls.getSimpleName());

    }

   

    @MetaDataKeyRetriever

    public List<MetaDataKey> getMetadataKeys() {

      List<MetaDataKey> keys = new ArrayList<MetaDataKey>();

      keys.add(this.createKey(ApiEntity.class));

      keys.add(this.createKey(ApiMethodEntity.class));

      keys.add(this.createKey(AssociativeEntity.class));

      keys.add(this.createKey(AssociativeMultiEntity.class));

      keys.add(this.createKey(CatalogAttributeEntity.class));

      keys.add(this.createKey(CatalogAttributeOptionEntity.class));

      keys.add(this.createKey(CatalogCategoryEntity.class));

      keys.add(this.createKey(CatalogInventoryStockItemEntity.class));

      keys.add(this.createKey(CatalogInventoryStockItemUpdateEntity.class));

      keys.add(this.createKey(CatalogProductAdditionalAttributesEntity.class));

      keys.add(this.createKey(CatalogProductAttributeEntity.class));

      keys.add(this.createKey(CatalogProductAttributeFrontendLabelEntity.class));

      keys.add(this.createKey(CatalogProductAttributeMediaCreateEntity.class));

      keys.add(this.createKey(CatalogProductAttributeMediaTypeEntity.class));

      keys.add(this.createKey(CatalogProductAttributeOptionLabelEntity.class));

      keys.add(this.createKey(CatalogProductAttributeSetEntity.class));

      keys.add(this.createKey(CatalogProductCreateEntity.class));

      keys.add(this.createKey(CatalogProductCustomOptionAdditionalFieldsEntity.class));

      keys.add(this.createKey(CatalogProductCustomOptionInfoEntity.class));

      keys.add(this.createKey(CatalogProductCustomOptionListEntity.class));

      keys.add(this.createKey(CatalogProductCustomOptionTypesEntity.class));

      keys.add(this.createKey(CatalogProductCustomOptionValueAddEntity.class));

      keys.add(this.createKey(CatalogProductCustomOptionValueInfoEntity.class));

      keys.add(this.createKey(CatalogProductCustomOptionValueListEntity.class));

      keys.add(this.createKey(CatalogProductCustomOptionValueUpdateEntity.class));

      keys.add(this.createKey(CatalogProductDownloadableLinkAddEntity.class));

      keys.add(this.createKey(CatalogProductDownloadableLinkAddSampleEntity.class));

      keys.add(this.createKey(CatalogProductDownloadableLinkEntity.class));

      keys.add(this.createKey(CatalogProductDownloadableLinkFileEntity.class));

      keys.add(this.createKey(CatalogProductDownloadableLinkFileInfoEntity.class));

      keys.add(this.createKey(CatalogProductDownloadableLinkInfoEntity.class));

      keys.add(this.createKey(CatalogProductDownloadableLinkSampleEntity.class));

      keys.add(this.createKey(CatalogProductEntity.class));

      keys.add(this.createKey(CatalogProductImageEntity.class));

      keys.add(this.createKey(CatalogProductImageFileEntity.class));

      keys.add(this.createKey(CatalogProductLinkAttributeEntity.class));

      keys.add(this.createKey(CatalogProductLinkEntity.class));

      keys.add(this.createKey(CatalogProductReturnEntity.class));

      keys.add(this.createKey(CatalogProductTagAddEntity.class));

      keys.add(this.createKey(CatalogProductTagInfoEntity.class));

      keys.add(this.createKey(CatalogProductTagListEntity.class));

      keys.add(this.createKey(CatalogProductTagUpdateEntity.class));

      keys.add(this.createKey(CatalogProductTierPriceEntity.class));

      keys.add(this.createKey(CatalogProductTypeEntity.class));

      keys.add(this.createKey(CustomerCustomerEntity.class));

      keys.add(this.createKey(CustomerGroupEntity.class));

      keys.add(this.createKey(DirectoryCountryEntity.class));

      keys.add(this.createKey(DirectoryRegionEntity.class));

      keys.add(this.createKey(ExistsFaltureEntity.class));

      keys.add(this.createKey(GiftMessageAssociativeProductsEntity.class));

      keys.add(this.createKey(MagentoInfoEntity.class));

      keys.add(this.createKey(SalesOrderAddressEntity.class));

      keys.add(this.createKey(SalesOrderCreditmemoCommentEntity.class));

      keys.add(this.createKey(SalesOrderCreditmemoEntity.class));

      keys.add(this.createKey(SalesOrderCreditmemoItemEntity.class));

      keys.add(this.createKey(SalesOrderEntity.class));

      keys.add(this.createKey(SalesOrderInvoiceCommentEntity.class));

      keys.add(this.createKey(SalesOrderInvoiceEntity.class));

      keys.add(this.createKey(SalesOrderInvoiceItemEntity.class));

      keys.add(this.createKey(SalesOrderItemEntity.class));

      keys.add(this.createKey(SalesOrderListEntity.class));

      keys.add(this.createKey(SalesOrderPaymentEntity.class));

      keys.add(this.createKey(SalesOrderShipmentCommentEntity.class));

      keys.add(this.createKey(SalesOrderShipmentEntity.class));

      keys.add(this.createKey(SalesOrderShipmentItemEntity.class));

      keys.add(this.createKey(SalesOrderShipmentTrackEntity.class));

      keys.add(this.createKey(SalesOrderStatusHistoryEntity.class));

      keys.add(this.createKey(ShoppingCartAddressEntity.class));

      keys.add(this.createKey(ShoppingCartCustomerAddressEntity.class));

      keys.add(this.createKey(ShoppingCartCustomerEntity.class));

      keys.add(this.createKey(ShoppingCartInfoEntity.class));

      keys.add(this.createKey(ShoppingCartItemEntity.class));

      keys.add(this.createKey(ShoppingCartLicenseEntity.class));

      keys.add(this.createKey(ShoppingCartPaymentEntity.class));

      keys.add(this.createKey(ShoppingCartPaymentMethodEntity.class));

      keys.add(this.createKey(ShoppingCartProductEntity.class));

      keys.add(this.createKey(ShoppingCartShippingMethodEntity.class));

      keys.add(this.createKey(ShoppingCartTotalsEntity.class));

      keys.add(this.createKey(StoreEntity.class));

      

      return keys;

    }

   

    @MetaDataRetriever

    public MetaData getMetadata(MetaDataKey key) throws ClassNotFoundException {

         Class<?> clazz = Class.forName(String.format("%s.%s", ENTITY_PACKAGE, key.getId()));

         return new DefaultMetaData(new DefaultPojoMetaDataModel(clazz));

    }

    /**

     * Adds a comment to the shipment.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:addOrderShipmentComment}

     *

     * @param shipmentId            the shipment's increment id

     * @param comment               the comment to add

     * @param sendEmail             if an email must be sent after shipment creation

     * @param includeCommentInEmail if the comment must be sent in the email

     * @return true if it was successful

     */

    @Processor

    public boolean addOrderShipmentComment(String shipmentId,

                                           String comment,

                                           @Optional @Default("false") boolean sendEmail,

                                           @Optional @Default("false") boolean includeCommentInEmail)

    {

        return orderClient.addOrderShipmentComment(shipmentId, comment, sendEmail, includeCommentInEmail);

    }

    /**

     * Adds a new tracking number

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:addOrderShipmentTrack}

     *

     * @param shipmentId  the shipment id

     * @param carrierCode the new track's carrier code

     * @param title       the new track's title

     * @param trackId     the new track's id

     * @return the new track's id

     */

    @Processor

    public int addOrderShipmentTrack(String shipmentId,

                                     String carrierCode,

                                     String title,

                                     String trackId) {

        return orderClient.addOrderShipmentTrack(shipmentId, carrierCode, title, trackId);

    }

    /**

     * Cancels an order

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:cancelOrder}

     *

     * @param orderId the order to cancel

     * @return true if the operation was successful

     */

    @Processor

    public boolean cancelOrder(String orderId) {

        return orderClient.cancelOrder(orderId);

    }

    /**

     * Creates a shipment for order

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:createOrderShipment}

     *

     * @param orderId               the order increment id

     * @param itemsQuantities       orderItemId quantity

     * @param comment               an optional comment

     * @param sendEmail             if an email must be sent after shipment creation

     * @param includeCommentInEmail if the comment must be sent in the email

     * @return the new shipment's id

     */

    @Processor

    public String createOrderShipment(String orderId,

                                      @Optional @Default("#[payload]") @Placement(group = "Item Ids and Quantities") List<OrderItemIdQty> itemsQuantities,

                                      @Optional String comment,

                                      @Optional @Default("false") boolean sendEmail,

                                      @Optional @Default("false") boolean includeCommentInEmail) {

        return orderClient.createOrderShipment(orderId, itemsQuantities, comment, sendEmail, includeCommentInEmail);

    }

    /**

     * Answers the order properties for the given orderId

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:getOrder}

     *

     * @param orderId the order whose properties to fetch

     * @return a string-object map of order properties

     */

    @Processor

    public SalesOrderEntity getOrder(String orderId) {

        return orderClient.getOrder(orderId);

    }

    /**

     * Retrieves order invoice information

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:getOrderInvoice}

     *

     *

     * @param invoiceId the target invoiceId

     * @return the invoice attributes

     */

    @Processor

    public SalesOrderInvoiceEntity getOrderInvoice(String invoiceId) {

        return orderClient.getOrderInvoice(invoiceId);

    }

    /**

     * Retrieves the order shipment carriers.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:getOrderShipmentCarriers}

     *

     * @param orderId the target order id

     * @return a list of {@link Carrier} object

     */

    @Processor

    public List<Carrier> getOrderShipmentCarriers(String orderId) {

        return orderClient.getOrderShipmentCarriers(orderId);

    }

    /**

     * Retrieves the order shipment attributes

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:getOrderShipment}

     *

     *

     * @param shipmentId the id of the shipment

     * @return the shipment attributes

     */

    @Processor

    public SalesOrderShipmentEntity getOrderShipment(String shipmentId) {

        return orderClient.getOrderShipment(shipmentId);

    }

    /**

     * Puts order on hold. This operation can be reverted with unholdOrder.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:holdOrder}

     *

     * @param orderId the order to put on hold state

     * @return true if the operation was successful

     */

    @Processor

    public boolean holdOrder(String orderId) {

        return orderClient.holdOrder(orderId);

    }

    /**

     * Lists order attributes that match the given filtering expression.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listOrders}

     *

     *

     *

     * @param filter optional filtering expression - one or more comma-separated

     *               unary or binary predicates, one for each filter, in the form

     *               filterType(attributeName, value), for binary filters or

     *               filterType(attributeName), for unary filters, where filterType is

     *               istrue, isfalse or any of the Magento standard filters. Non-numeric

     *               values need to be escaped using simple quotes.

     * @return a list of string-object maps

     */

    @Processor

    public List<SalesOrderListEntity> listOrders(@org.mule.api.annotations.Query @Optional String filter) {

        return orderClient.listOrders(filter);

    }

   

    @QueryTranslator

    public String toNativeQuery(Query query) {

      MagentoQueryVisitor visitor = new MagentoQueryVisitor();

      query.getFilterExpression().accept(visitor);

     

      return visitor.toQuery();

    }

    /**

     * Lists order invoices that match the given filtering expression

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listOrdersInvoices}

     *

     *

     * @param filter optional filtering expression - one or more comma-separated

     *               unary or binary predicates, one for each filter, in the form

     *               filterType(attributeName, value), for binary filters or

     *               filterType(attributeName), for unary filters, where filterType is

     *               istrue, isfalse or any of the Magento standard filters. Non-numeric

     *               values need to be escaped using simple quotes.

     * @return list of string-object maps order attributes

     */

    @Processor

    public List<SalesOrderInvoiceEntity> listOrdersInvoices(@org.mule.api.annotations.Query @Optional String filter) {

        return orderClient.listOrdersInvoices(filter);

    }

    /**

     * Lists order shipment atrributes that match the given

     * optional filtering expression

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listOrdersShipments}

     *

     *

     * @param filter optional filtering expression - one or more comma-separated

     *               unary or binary predicates, one for each filter, in the form

     *               filterType(attributeName, value), for binary filters or

     *               filterType(attributeName), for unary filters, where filterType is

     *               istrue, isfalse or any of the Magento standard filters. Non-numeric

     *               values need to be escaped using simple quotes.

     * @return list of string-object map order shipments attributes

     */

    @Processor

    public List<SalesOrderShipmentEntity> listOrdersShipments(@org.mule.api.annotations.Query @Optional String filter) {

        return orderClient.listOrdersShipments(filter);

    }

    /**

     * Deletes the given track of the given order's shipment

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:deleteOrderShipmentTrack}

     *

     * @param shipmentId the target shipment id

     * @param trackId    the id of the track to delete

     * @return if the tracking number is removed from the shipment

     */

    @Processor

    public boolean deleteOrderShipmentTrack(String shipmentId, String trackId) {

        return orderClient.deleteOrderShipmentTrack(shipmentId, trackId);

    }

    /**

     * Adds a comment to the given order id

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:addOrderComment}

     *

     * @param orderId   the order id

     * @param status    the comment status

     * @param comment   the comment

     * @param sendEmail if an email must be sent after shipment creation

     * @return true if the operation was successful

     */

    @Processor

    public boolean addOrderComment(String orderId,

                                   String status,

                                   String comment,

                                   @Optional @Default("false") boolean sendEmail) {

        return orderClient.addOrderComment(orderId, status, comment, sendEmail);

    }

    /**

     * Releases order

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:unholdOrder}

     *

     * @param orderId the id of the order to remove from hold state

     * @return true if the operation was successful

     *

     */

    @Processor

    public boolean unholdOrder(String orderId) {

        return orderClient.unholdOrder(orderId);

    }

    /**

     * Creates an invoice for the given order

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:createOrderInvoice}

     *

     * @param orderId               the id of the order

     * @param itemsQuantities       orderItemId quantity

     * @param comment               an optional comment

     * @param sendEmail             if an email must be sent after shipment creation

     * @param includeCommentInEmail if the comment must be sent in the email

     * @return the new invoice's id

     */

    @Processor

    public String createOrderInvoice(String orderId,

                                     @Optional @Default("#[payload]") @Placement(group = "Item Ids and Quantities") List<OrderItemIdQty> itemsQuantities,

                                     @Optional String comment,

                                     @Optional @Default("false") boolean sendEmail,

                                     @Optional @Default("false") boolean includeCommentInEmail) {

        return orderClient.createOrderInvoice(orderId, itemsQuantities, comment, sendEmail,

                includeCommentInEmail);

    }

    /**

     * Adds a comment to the given order's invoice

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:addOrderInvoiceComment}

     *

     * @param invoiceId             the invoice id

     * @param comment               the comment to add

     * @param sendEmail             if an email must be sent after shipment creation

     * @param includeCommentInEmail if the comment must be sent in the email

     * @return true if it was successful

     */

    @Processor

    public boolean addOrderInvoiceComment(String invoiceId,

                                          String comment,

                                          @Optional @Default("false") boolean sendEmail,

                                          @Optional @Default("false") boolean includeCommentInEmail) {

        return orderClient.addOrderInvoiceComment(invoiceId, comment, sendEmail, includeCommentInEmail);

    }

    /**

     * Captures and invoice

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:captureOrderInvoice}

     *

     * @param invoiceId the invoice to capture

     */

    @Processor

    public void captureOrderInvoice(String invoiceId) {

        orderClient.captureOrderInvoice(invoiceId);

    }

    /**

     * Voids an invoice

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:voidOrderInvoice}

     *

     * @param invoiceId the invoice id

     * @return true if it was successful

     */

    @Processor

    public boolean voidOrderInvoice(String invoiceId) {

        return orderClient.voidOrderInvoice(invoiceId);

    }

    /**

     * Cancels an order's invoice

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:cancelOrderInvoice}

     *

     * @param invoiceId the invoice id

     */

    @Processor

    public void cancelOrderInvoice(String invoiceId) {

        orderClient.cancelOrderInvoice(invoiceId);

    }

    /**

     * Creates a new address for the given customer using the given address

     * attributes

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:createCustomerAddress}

     *

     * @param customerId the customer

     * @param customerAddress the address attributes

     * @return a new customer address id

     */

    @Processor

    public int createCustomerAddress(int customerId, @Optional @Default("#[payload]")

            @Placement(group = "Address Attributes") CustomerAddressEntityCreate customerAddress) {

        return customerClient.createCustomerAddress(customerId, customerAddress);

    }

    /**

     * Creates a customer with the given attributes

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:createCustomer}

     *

     * @param customer the attributes of the new customer

     * @return the new customer id

     */

    @Processor

    public int createCustomer( @Default("#[payload]") @Placement(group = "Customer Attributes") CustomerCustomerEntityToCreate customer) {

        return customerClient.createCustomer(customer);

    }

    /**

     * Deletes a customer given its id

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:deleteCustomer}

     *

     * @param customerId the customer to delete

     * @return if the customer is deleted

     */

    @Processor

    public boolean deleteCustomer(int customerId) {

        return customerClient.deleteCustomer(customerId);

    }

    /**

     * Deletes a Customer Address

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:deleteCustomerAddress}

     *

     * @param addressId the address id to delete

     * @return if the customer address is deleted

     */

    @Processor

    public boolean deleteCustomerAddress(int addressId) {

        return customerClient.deleteCustomerAddress(addressId);

    }

    /**

     * Answers customer attributes for the given id. Only the selected attributes are

     * retrieved

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:getCustomer}

     *

     *

     * @param customerId     the id of the customer to retrieve

     * @param attributeNames the attributes to retrieve. Not empty

     * @return the attributes map

     */

    @Processor

    public CustomerCustomerEntity getCustomer(int customerId, @Placement(group = "Attributes to Retrieve") List<String> attributeNames) {

        return customerClient.getCustomer(customerId, attributeNames);

    }

    /**

     * Answers the customer address attributes

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:getCustomerAddress}

     *

     *

     * @param addressId the id of the address

     * @return the customer address attributes map

     */

    @Processor

    public CustomerAddressEntityItem getCustomerAddress(int addressId) {

        return customerClient.getCustomerAddress(addressId);

    }

    /**

     * Lists the customer address for a given customer id

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listCustomerAddresses}

     *

     *

     * @param customerId the id of the customer

     * @return a listing of addresses

     */

    @Processor

    public List<CustomerAddressEntityItem> listCustomerAddresses(int customerId) {

        return customerClient.listCustomerAddresses(customerId);

    }

    /**

     * Lists all the customer groups

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listCustomerGroups}

     *

     * @return a listing of groups attributes

     */

    @Processor

    public List<CustomerGroupEntity> listCustomerGroups() {

        return customerClient.listCustomerGroups();

    }

    /**

     * Answers a list of customer attributes for the given filter expression.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listCustomers}

     *

     *

     * @param filter optional filtering expression - one or more comma-separated

     *               unary or binary predicates, one for each filter, in the form

     *               filterType(attributeName, value), for binary filters or

     *               filterType(attributeName), for unary filters, where filterType is

     *               istrue, isfalse or any of the Magento standard filters. Non-numeric

     *               values need to be escaped using simple quotes.

     * @return the list of attributes map

     */

    @Processor

    public List<CustomerCustomerEntity> listCustomers(@org.mule.api.annotations.Query @Optional String filter) {

        return customerClient.listCustomers(filter);

    }

    /**

     * Updates the given customer attributes, for the given customer id. Password can

     * not be updated using this method

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:updateCustomer}

     *

     * @param customerId the target customer to update

     * @param customer the customer attributes

     * @return update result

     */

    @Processor

    public boolean updateCustomer(int customerId,

                                  @Optional @Default("#[payload]") @Placement(group = "Customer Attributes to Update") CustomerCustomerEntityToCreate customer) {

        return customerClient.updateCustomer(customerId, customer);

    }

    /**

     * Updates the given map of customer address attributes, for the given customer address

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:updateCustomerAddress}

     *

     * @param addressId  the customer address to update

     * @param customerAddress the address attributes to update

     * @return update result

     */

    @Processor

    public boolean updateCustomerAddress(int addressId,  @Default("#[payload]")  @Placement(group = "Address Attributes to Update") CustomerAddressEntityCreate customerAddress) {

        return customerClient.updateCustomerAddress(addressId, customerAddress);

    }

    /**

     * Retrieve stock data by product ids

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listStockItems}

     *

     *

     * @param productIdOrSkus a not empty list of product ids or skus whose attributes to list

     * @return a list of stock items attributes

     */

    @Processor

    public List<CatalogInventoryStockItemEntity> listStockItems(@Placement(group = "Product Ids or SKUs") List<String> productIdOrSkus) {

        return inventoryClient.listStockItems(productIdOrSkus);

    }

    /**

     * Update product stock data given its id or sku

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:updateStockItem}

     *

     * @param productIdOrSku the product id or sku of the product to update

     * @param stockItem     the attributes to update

     * @return update result

     */

    @Processor

    public int updateStockItem(String productIdOrSku,

                               @Optional @Default("#[payload]") @Placement(group = "Attributes to Update") CatalogInventoryStockItemUpdateEntity stockItem) {

        return inventoryClient.updateStockItem(productIdOrSku, stockItem);

    }

    /**

     * Answers the list of countries

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listDirectoryCountries}

     *

     * @return a collection of countries attributes

     */

    @Processor

    public List<DirectoryCountryEntity> listDirectoryCountries() {

        return directoryClient.listDirectoryCountries();

    }

    /**

     * Answers a list of regions for the given county

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listDirectoryRegions}

     *

     *

     * @param countryId the country code, in ISO2 or ISO3 format

     * @return the collection of regions attributes

     */

    @Processor

    public List<DirectoryRegionEntity> listDirectoryRegions(String countryId) {

        return directoryClient.listDirectoryRegions(countryId);

    }

    /**

     * Links two products, given its source and destination productIdOrSku.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:addProductLink}

     *

     * @param type                 the product type

     * @param productId            the id of the source product. Use it instead of productIdOrSku

     *                             in case you are sure the source product identifier is a

     *                             product id

     * @param productSku           the sku of the source product. Use it instead of productIdOrSku

*                             in case you are sure the source product identifier is a

*                             product sku

     * @param productIdOrSku       the id or sku of the source product.

     * @param linkedProductIdOrSku the destination product id or sku.

     * @param productLinkEntity           the link attributes

     * @return true if the operation was successful

     */

    @Processor

    public boolean addProductLink(String type,

                                  @Optional Integer productId,

                                  @Optional String productSku,

                                  @Optional String productIdOrSku,

                                  String linkedProductIdOrSku,

                                  @Optional @Default("#[payload]") @Placement(group = "Address Attributes to Update") CatalogProductLinkEntity productLinkEntity) {

        return catalogClient.addProductLink(type, ProductIdentifiers.from(productSku, productId, productIdOrSku), linkedProductIdOrSku,

                productLinkEntity);

    }

    /**

     * Creates a new product media. See catalog-product-attribute-media-create SOAP

     * method.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:createProductAttributeMedia}

     *

     * @param productId         the id of the product. Use it instead of productIdOrSku

     *                          in case you are sure the product identifier is a

     *                          product id

     * @param productSku        the sku of the product. Use it instead of productIdOrSku

     *                          in case you are sure the product identifier is a

     *                          product sku

     * @param productIdOrSku    the id or sku of the product.

     * @param catalogProductAttributeMediaEntity        the media attributes

     * @param storeViewIdOrCode the id or code of the target store. Left unspecified for using current store

     * @param payload           the image to upload. It may be a file, an input stream or a byte array

     * @param mimeType          the mimetype

     * @param baseFileName      the base name of the new remote image

     * @return the new image filename

     * @throws FileNotFoundException when the payload object is not a valid file

     */

    @Processor

    public String createProductAttributeMedia(@Optional Integer productId,

                                              @Optional String productSku,

                                              @Optional String productIdOrSku,

                                              @Optional @Default("#[payload]") @Placement(group = "Media Attributes") CatalogProductAttributeMediaCreateEntity catalogProductAttributeMediaEntity,

                                              @Optional String storeViewIdOrCode,

                                              @Payload Object payload,

                                              MediaMimeType mimeType,

                                              @Optional String baseFileName) throws FileNotFoundException {

        return catalogClient.createProductAttributeMedia(ProductIdentifiers.from(productSku, productId, productIdOrSku),

                catalogProductAttributeMediaEntity, createContent(payload), mimeType, baseFileName, storeViewIdOrCode);

    }

    private InputStream createContent(Object content) throws FileNotFoundException {

        if (content instanceof InputStream) {

            return (InputStream) content;

        }

        if (content instanceof File) {

            return new FileInputStream((File) content);

        }

        if (content instanceof byte[]) {

            return new ByteArrayInputStream((byte[]) content);

        }

        throw new IllegalArgumentException("Unsupported Content Type " + content);

    }

    /**

     * Removes a product image. See catalog-product-attribute-media-remove SOAP

     * method.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:deleteProductAttributeMedia}

     *

     * @param productId      the id of the product. Use it instead of productIdOrSku

     *                       in case you are sure the product identifier is a

     *                       product id

     * @param productSku     the sku of the product. Use it instead of productIdOrSku

     *                       in case you are sure the product identifier is a

     *                       product sku

     * @param productIdOrSku the id or sku of the product.

     * @param fileName       the remote media file to delete

     * @return if the image is removed from a product

     */

    @Processor

    public boolean deleteProductAttributeMedia(@Optional Integer productId,

                                            @Optional String productSku,

                                            @Optional String productIdOrSku,

                                            String fileName)

    {

        return catalogClient.deleteProductAttributeMedia(ProductIdentifiers.from(productSku, productId, productIdOrSku), fileName);

    }

    /**

     * Deletes a product's link.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:deleteProductLink}

     *

     * @param type                 link type

     * @param productId            the id of the source product. Use it instead of productIdOrSku

     *                             in case you are sure the source product identifier is a

     *                             product id

     * @param productSku           the sku of the source product. Use it instead of productIdOrSku

     *                             in case you are sure the source product identifier is a

     *                             product sku

     * @param productIdOrSku       the id or sku of the source product.

     * @param linkedProductIdOrSku the linked product id or sku

     * @return if the link is removed from a product

     */

    @Processor

    public boolean deleteProductLink(String type,

                                  @Optional Integer productId,

                                  @Optional String productSku,

                                  @Optional String productIdOrSku,

                                  String linkedProductIdOrSku) {

        return catalogClient.deleteProductLink(type, ProductIdentifiers.from(productSku, productId, productIdOrSku), linkedProductIdOrSku);

    }

    /**

     * Lists linked products to the given product and for the given link type.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:getProductAttributeMedia}

     *

     *

     * @param productId         the id of the product. Use it instead of productIdOrSku in

     *                          case you are sure the product identifier is a product id

     * @param productSku        the sku of the product. Use it instead of productIdOrSku in

     *                          case you are sure the product identifier is a product sku

     * @param productIdOrSku    the id or sku of the product.

     * @param fileName          the name of the file

     * @param storeViewIdOrCode the store view id or code

     * @return the list of links to the product

     */

    @Processor

    public CatalogProductImageEntity getProductAttributeMedia(@Optional Integer productId,

                                                              @Optional String productSku,

                                                              @Optional String productIdOrSku,

                                                              String fileName,

                                                              @Optional String storeViewIdOrCode) {

        return catalogClient.getProductAttributeMedia(ProductIdentifiers.from(productSku, productId, productIdOrSku), fileName, storeViewIdOrCode);

    }

    /**

     * Answers the current default catalog store view id for this session

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:getCatalogCurrentStoreView}

     *

     * @return the current default store view id

     */

    @Processor

    public int getCatalogCurrentStoreView() {

        return catalogClient.getCatalogCurrentStoreView();

    }

    /**

     * Set the default catalog store view for this session

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:updateCategoryAttributeStoreView}

     *

     * @param storeViewIdOrCode the id or code of the target store. Left unspecified for using current store

     *                          the id or code of the store view to set as default for this

     *                          session

     * @return update result

     */

    @Processor

    public int updateCategoryAttributeStoreView(String storeViewIdOrCode) {

        return catalogClient.updateCatalogCurrentStoreView(storeViewIdOrCode);

    }

    /**

     * Retrieve product image types. See catalog-product-attribute-media-types SOAP

     * method.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listCategoryAttributes}

     *

     * @return the list of category attributes

     */

    @Processor

    public List<CatalogAttributeEntity> listCategoryAttributes() {

        return catalogClient.listCategoryAttributes();

    }

    /**

     * Retrieves attribute options. See catalog-category-attribute-options SOAP

     * method.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listCategoryAttributeOptions}

     *

     *

     * @param attributeId       the target attribute whose options will be retrieved

     * @param storeViewIdOrCode the id or code of the target store. Left unspecified for using current store

     * @return the list of category attribute options

     */

    @Processor

    public List<CatalogAttributeOptionEntity> listCategoryAttributeOptions(String attributeId,

                                                                           @Optional String storeViewIdOrCode) {

        return catalogClient.listCategoryAttributeOptions(attributeId, storeViewIdOrCode);

    }

    /**

     * Retrieves product image list. See catalog-product-attribute-media-list SOAP

     * method

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listProductAttributeMedia}

     *

     *

     * @param productId         the id of the product. Use it instead of productIdOrSku in

     *                          case you are sure the product identifier is a product id

     * @param productSku        the sku of the product. Use it instead of productIdOrSku in

     *                          case you are sure the product identifier is a product sku

     * @param productIdOrSku    the id or sku of the product.

     * @param storeViewIdOrCode the id or code of the target store. Left unspecified for using current store

     * @return the list of product images attributes

     */

    @Processor

    public List<CatalogProductImageEntity> listProductAttributeMedia(@Optional Integer productId,

                                                                     @Optional String productSku,

                                                                     @Optional String productIdOrSku,

                                                                     @Optional String storeViewIdOrCode) {

        return catalogClient.listProductAttributeMedia(ProductIdentifiers.from(productSku, productId, productIdOrSku), storeViewIdOrCode);

    }

    /**

     * Retrieve product image types. See catalog-product-attribute-media-types SOAP

     * method.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listProductAttributeMediaTypes}

     *

     *

     * @param setId the setId

     * @return the list of attribute media types

     */

    @Processor

    public List<CatalogProductAttributeMediaTypeEntity> listProductAttributeMediaTypes(int setId) {

        return catalogClient.listProductAttributeMediaTypes(setId);

    }

    /**

     * Answers the product attribute options. See catalog-product-attribute-options

     * SOAP method.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listProductAttributeOptions}

     *

     *

     * @param attributeId       the target attribute whose options will be listed

     * @param storeViewIdOrCode the id or code of the target store. Left unspecified for using current store

     * @return the attributes list

     */

    @Processor

    public List<CatalogAttributeOptionEntity> listProductAttributeOptions(String attributeId,

                                                                          @Optional String storeViewIdOrCode) {

        return catalogClient.listProductAttributeOptions(attributeId, storeViewIdOrCode);

    }

    /**

     * Retrieves product attributes list. See catalog-product-attribute-list SOAP

     * methods

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listProductAttributes}

     *

     *

     * @param setId the set id

     * @return the list of product attributes

     */

    @Processor

    public List<CatalogAttributeEntity> listProductAttributes(int setId) {

        return catalogClient.listProductAttributes(setId);

    }

    /**

     * Retrieves product attribute sets. See catalog-product-attribute-set-list SOAP

     * method.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listProductAttributeSets}

     *

     * @return The list of product attributes sets

     */

    @Processor

    public List<CatalogProductAttributeSetEntity> listProductAttributeSets() {

        return catalogClient.listProductAttributeSets();

    }

    /**

     * Retrieve product tier prices. See catalog-product-attribute-tier-price-info

     * SOAP Method.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listProductAttributeTierPrices}

     *

     *

     * @param productId      the id of the product. Use it instead of productIdOrSku in

     *                       case you are sure the product identifier is a product id

     * @param productSku     the sku of the product. Use it instead of productIdOrSku in

     *                       case you are sure the product identifier is a product sku

     * @param productIdOrSku the id or sku of the product.

     * @return the list of product attributes

     */

    @Processor

    public List<CatalogProductTierPriceEntity> listProductAttributeTierPrices(@Optional Integer productId,

                                                                              @Optional String productSku,

                                                                              @Optional String productIdOrSku) {

        return catalogClient.listProductAttributeTierPrices(ProductIdentifiers.from(productSku, productId, productIdOrSku));

    }

    /**

     * Lists linked products to the given product and for the given link type

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listProductLink}

     *

     *

     * @param type           the link type

     * @param productId      the id of the product. Use it instead of productIdOrSku in

     *                       case you are sure the product identifier is a product id

     * @param productSku     the sku of the product. Use it instead of productIdOrSku in

     *                       case you are sure the product identifier is a product sku

     * @param productIdOrSku the id or sku of the product.

     * @return the list of links to the product

     */

    @Processor

    public List<CatalogProductLinkEntity> listProductLink(String type,

                                                          @Optional Integer productId,

                                                          @Optional String productSku,

                                                          @Optional String productIdOrSku) {

        return catalogClient.listProductLink(type, ProductIdentifiers.from(productSku, productId, productIdOrSku));

    }

    /**

     * Lists all the attributes for the given product link type

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listProductLinkAttributes}

     *

     *

     * @param type the product type

     * @return the listing of product attributes

     */

    @Processor

    public List<CatalogProductLinkAttributeEntity> listProductLinkAttributes(String type) {

        return catalogClient.listProductLinkAttributes(type);

    }

    /**

     * Answers product link types

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listProductLinkTypes}

     *

     * @return the list of product link types

     */

    @Processor

    public List<String> listProductLinkTypes() {

        return catalogClient.listProductLinkTypes();

    }

    /**

     * Answers product types. See catalog-product-type-list SOAP method

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listProductTypes}

     *

     * @return the list of product types

     */

    @Processor

    public List<CatalogProductTypeEntity> listProductTypes() {

        return catalogClient.listProductTypes();

    }

    /**

     * Updates product media. See catalog-product-attribute-media-update

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:updateProductAttributeMedia}

     *

     * @param productId         the id of the product. Use it instead of productIdOrSku in

     *                          case you are sure the product identifier is a product id

     * @param productSku        the sku of the product. Use it instead of productIdOrSku in

     *                          case you are sure the product identifier is a product sku

     * @param productIdOrSku    the id or sku of the product.

     * @param fileName          the name of the remote media file to update

     * @param catalogProductAttributeMediaEntity        the attributes to update

     * @param storeViewIdOrCode the id or code of the target store. Left unspecified for using current store

     * @return update result

     */

    @Processor

    public boolean updateProductAttributeMedia(@Optional Integer productId,

                                               @Optional String productSku,

                                               @Optional String productIdOrSku,

                                               String fileName,

                                               @Optional @Default("#[payload]") @Placement(group = "Media Attributes to Update") CatalogProductAttributeMediaCreateEntity catalogProductAttributeMediaEntity,

                                               @Optional String storeViewIdOrCode) {

        return catalogClient.updateProductAttributeMedia(ProductIdentifiers.from(productSku, productId, productIdOrSku), fileName,

                catalogProductAttributeMediaEntity, storeViewIdOrCode);

    }

    /**

     * Updates a single product tier price. See catalog-product-attribute-tier-price-update

     * SOAP method.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:updateProductAttributeTierPrice}

     *

     * @param productId      the id of the product. Use it instead of productIdOrSku in

     *                       case you are sure the product identifier is a product id

     * @param productSku     the sku of the product. Use it instead of productIdOrSku in

     *                       case you are sure the product identifier is a product sku

     * @param productIdOrSku the id or sku of the product.

     * @param catalogProductTierPriceEntity     the tier price to update.

     * @return update result

     */

    @Processor

    public int updateProductAttributeTierPrice(@Optional Integer productId,

                                               @Optional String productSku,

                                               @Optional String productIdOrSku,

                                               @Optional @Default("#[payload]") @Placement(group = "Tier Price Attributes to Update") CatalogProductTierPriceEntity catalogProductTierPriceEntity) {

        return catalogClient.updateProductAttributeTierPrice(ProductIdentifiers.from(productSku, productId, productIdOrSku), catalogProductTierPriceEntity);

    }

    /**

     * Update product link

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:updateProductLink}

     *

     * @param type                 the link type

     * @param productId            the id of the source product. Use it instead of productIdOrSku

     *                             in case you are sure the source product identifier is a

     *                             product id

     * @param productSku           the sku of the source product. Use it instead of productIdOrSku

*                             in case you are sure the source product identifier is a

*                             product sku

     * @param productIdOrSku       the id or sku of the source product.

     * @param linkedProductIdOrSku the destination product id or sku.

     * @param catalogProductLinkEntity           the link attributes

     * @return update result

     */

    @Processor

    public boolean updateProductLink(String type,

                                     @Optional Integer productId,

                                     @Optional String productSku,

                                     @Optional String productIdOrSku,

                                     String linkedProductIdOrSku,

                                     @Optional @Default("#[payload]") @Placement(group = "Link Attributes to Update") CatalogProductLinkEntity catalogProductLinkEntity) {

        return catalogClient.updateProductLink(type, ProductIdentifiers.from(productSku, productId, productIdOrSku), linkedProductIdOrSku,

                catalogProductLinkEntity);

    }

    /**

     * Lists product of a given category. See  catalog-category-assignedProducts SOAP method.

     * <p/>

     * {@sample.xml ../../../doc/magento-connector.xml.sample magento:listCategoryProducts}

     *

     *

     * @param categoryId the category

     * @return the listing of category products

     */

    @Processor

    public List<CatalogAssignedProduct> listCategoryProducts(int categoryId) {