org.imixs.workflow.magento.rest

Class MagentoRestClient

java.lang.Object

org.imixs.workflow.magento.rest.MagentoRestClient

All Implemented Interfaces:

MagentoClient

public class MagentoRestClient
extends Object
implements MagentoClient

This EJB provides methods to interact with a magento instance through the magento rest api. This service EJB is also used by the MagentoPlugin class. The service initialize the OAuth Data to access the Magento Web Service Rest API. The configuration can be stored in a config Entity 'ConfigMagento' or in the imixs.properties file. The configuration is read during the @PostConstruct call back method. The method getService() returns a OAuthService object.

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_MESSAGE

Constructor Summary

Constructors

Constructor and Description
MagentoRestClient()

Method Summary

Modifier and Type	Method and Description
void	addOrderComment(String orderIncrementId, String status, String comment, boolean notify) adds a comment to an order
void	connect(org.imixs.workflow.ItemCollection magentoConfiguration) Connects the Client to the magento REST API.
void	disconnect() Disconnects the client
org.scribe.model.Token	getAccessToken(org.scribe.model.Token requestToken, String averifier) This method requests a new access token....
String	getAuthorizationUrl(org.scribe.model.Token requestToken) returns a new authorization url...
org.imixs.workflow.ItemCollection	getCustomerById(int id) returns a single itemCollection for a magento product entry The method also lookups the customer addresses and adds a property 'addresses' with the collection of customers addresses Rest URI: http://magentohost/api/rest/customers/:customer_id/addresses
org.imixs.workflow.ItemCollection	getOrderById(String id) returns a single itemCollection for a magento order entity
List<org.imixs.workflow.ItemCollection>	getOrders(String status) This method implements a paging mechanism because the Rest API only returns a maximum of 100 entries per call!
org.imixs.workflow.ItemCollection	getProductBySKU(String sku) returns a single itemCollection for a magento product entry
List<org.imixs.workflow.ItemCollection>	getProducts() returns a List of itemCollection for magento product entries
org.scribe.model.Token	getRequestToken() returns a new request token...
org.scribe.oauth.OAuthService	getService() returns a OAuthService object...

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_MESSAGE

public static final String ERROR_MESSAGE

See Also:

Constant Field Values

Constructor Detail

MagentoRestClient

public MagentoRestClient()

Method Detail

connect

public void connect(org.imixs.workflow.ItemCollection magentoConfiguration)

Connects the Client to the magento REST API. The ItemCollection contains properties needed to establish the connection

Specified by:

connect in interface MagentoClient

disconnect

public void disconnect()

Disconnects the client

Specified by:

disconnect in interface MagentoClient

getService

public org.scribe.oauth.OAuthService getService()

returns a OAuthService object...

Returns:

getRequestToken

public org.scribe.model.Token getRequestToken()

returns a new request token... I cast here to class 'OAuth10aServiceImpl' to be able to use the RequestTuner here.

Returns:

See Also:

https://github.com/fernandezpablo85/scribe-java/issues/504

getAuthorizationUrl

public String getAuthorizationUrl(org.scribe.model.Token requestToken)

returns a new authorization url...

Returns:

getAccessToken

public org.scribe.model.Token getAccessToken(org.scribe.model.Token requestToken,
                                             String averifier)

This method requests a new access token....

Returns:

getProducts

public List<org.imixs.workflow.ItemCollection> getProducts()
                                                    throws MagentoException

Description copied from interface: MagentoClient

returns a List of itemCollection for magento product entries

Specified by:

getProducts in interface MagentoClient

Returns:

Throws:

MagentoException

getProductBySKU

public org.imixs.workflow.ItemCollection getProductBySKU(String sku)

returns a single itemCollection for a magento product entry

Specified by:

getProductBySKU in interface MagentoClient

Parameters:

item_id -

Returns:

Throws:

org.imixs.workflow.exceptions.PluginException

getCustomerById

public org.imixs.workflow.ItemCollection getCustomerById(int id)

returns a single itemCollection for a magento product entry The method also lookups the customer addresses and adds a property 'addresses' with the collection of customers addresses Rest URI: http://magentohost/api/rest/customers/:customer_id/addresses

Specified by:

getCustomerById in interface MagentoClient

Parameters:

item_id -

Returns:

Throws:

org.imixs.workflow.exceptions.PluginException

getOrderById

public org.imixs.workflow.ItemCollection getOrderById(String id)

returns a single itemCollection for a magento order entity

Specified by:

getOrderById in interface MagentoClient

Parameters:

item_id -

Returns:

Throws:

org.imixs.workflow.exceptions.PluginException

getOrders

public List<org.imixs.workflow.ItemCollection> getOrders(String status)
                                                  throws MagentoException

This method implements a paging mechanism because the Rest API only returns a maximum of 100 entries per call!

Specified by:

getOrders in interface MagentoClient

Throws:

MagentoException

addOrderComment

public void addOrderComment(String orderIncrementId,
                            String status,
                            String comment,
                            boolean notify)
                     throws MagentoException

Description copied from interface: MagentoClient

adds a comment to an order

Specified by:

addOrderComment in interface MagentoClient

Throws:

MagentoException