org.imixs.workflow.magento

Class MagentoService

java.lang.Object

org.imixs.workflow.magento.MagentoService

@DeclareRoles(value="org.imixs.ACCESSLEVEL.MANAGERACCESS")
 @RunAs(value="org.imixs.ACCESSLEVEL.MANAGERACCESS")
public class MagentoService
extends Object

This EJB provides methods to interact with a magento instance through the MagentoClient. This service EJB is also used by the MagentoPlugin class. The service initialize a Client Implementation based on a configuration. The Service EJB provides to both client types the MagentoSOAPClient and the MagnetoRestClient. The clients are lazy loaded in the getter methods.

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_MESSAGE
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
MagentoService()

Method Summary

Modifier and Type	Method and Description
org.imixs.workflow.ItemCollection	addMagentoEntity(org.imixs.workflow.ItemCollection workitem, org.imixs.workflow.ItemCollection magentoEntity) This method adds the properties form a magento entity to an existing workitem.
void	clearCache()
List<org.imixs.workflow.ItemCollection>	findAllConfigurations() retruns a list of all existing Magento Shop Configurations
org.imixs.workflow.ItemCollection	findOrderByWorkitem(org.imixs.workflow.ItemCollection workitem) This method finds the magento order entity for a workitem.
org.imixs.workflow.ItemCollection	findWorkitemByOrder(org.imixs.workflow.ItemCollection order) This method finds a workitem for a magento order id.
org.imixs.workflow.ItemCollection	getCustomerById(String id, String configID) returns a single itemCollection for a magento product entry.
MagentoHTMLClient	getHTMLClient(String configID) Returns an instance of a HTMLClient for a specified magento shop configuration
String	getOrderID(org.imixs.workflow.ItemCollection order) this method creates the Magento oder ID to be stored in the property 'txtName'.
org.imixs.workflow.ItemCollection	getProductBySKU(String sku, String configID) returns a single itemCollection for a magento product entry.
MagentoClient	getRestClient(String configID) Returns an instance of a Rest Client for a specified magento shop configuration
MagentoClient	getSOAPClient(String configID) Returns an instance of a SOAPClient for a specified magento shop configuration
void	init() initial setup the magento client implementation
boolean	isWorkitemEqualsToMagentoEntity(org.imixs.workflow.ItemCollection workitem, org.imixs.workflow.ItemCollection magentoEntity) This method compares the data of a Imixs Workitem with the data of a magento entity.
org.imixs.workflow.ItemCollection	loadConfiguration(String id) This method loads a magento configuration.
void	reset() resets the connections

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

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

MagentoService

public MagentoService()

Method Detail

init

@PostConstruct
public void init()

initial setup the magento client implementation

reset

public void reset()

resets the connections

findAllConfigurations

public List<org.imixs.workflow.ItemCollection> findAllConfigurations()

retruns a list of all existing Magento Shop Configurations

Returns:

getSOAPClient

public MagentoClient getSOAPClient(String configID)

Returns an instance of a SOAPClient for a specified magento shop configuration

Parameters:

configID - - id of the shop configuration entity

Returns:

getRestClient

public MagentoClient getRestClient(String configID)

Returns an instance of a Rest Client for a specified magento shop configuration

Parameters:

configID - - id of the shop configuration entity

Returns:

getHTMLClient

public MagentoHTMLClient getHTMLClient(String configID)

Returns an instance of a HTMLClient for a specified magento shop configuration

Parameters:

configID - - id of the shop configuration entity

Returns:

loadConfiguration

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

This method loads a magento configuration. If no configuration entity yet exists the method returns an empty ItemCollection. The method updates the timer details netxtTimeout and timeRemaining of a running timer service. The method uses a caching mechanism to store still loaded conigurations.

Returns:

configuration ItemCollection

findWorkitemByOrder

public org.imixs.workflow.ItemCollection findWorkitemByOrder(org.imixs.workflow.ItemCollection order)

This method finds a workitem for a magento order id. If no worktiem exits the method returns null. The order ID is stored in the proeprty txtName with the following format: magento:order:[SHOPID]:1

Returns:

workitem or null if no workitem exits

findOrderByWorkitem

public org.imixs.workflow.ItemCollection findOrderByWorkitem(org.imixs.workflow.ItemCollection workitem)
                                                      throws MagentoException

This method finds the magento order entity for a workitem. The order ID is stored in the property txtName with the following format: magento:order:1

Returns:

order or null if no order exits

Throws:

MagentoException

getOrderID

public String getOrderID(org.imixs.workflow.ItemCollection order)

this method creates the Magento oder ID to be stored in the property 'txtName'. This property value need to be unique. The key is computed by the shopconfig id and the entity_id of the sales order

getCustomerById

public org.imixs.workflow.ItemCollection getCustomerById(String id,
                                                         String configID)
                                                  throws MagentoException

returns a single itemCollection for a magento product entry. The method uses a cache

Parameters:

id -

configID - - id of the shop configuration entity

Returns:

Throws:

MagentoException

org.imixs.workflow.exceptions.PluginException

getProductBySKU

public org.imixs.workflow.ItemCollection getProductBySKU(String sku,
                                                         String configID)
                                                  throws MagentoException

returns a single itemCollection for a magento product entry. The method uses cache.

Parameters:

sku -

configID - - id of the shop configuration entity

Returns:

Throws:

MagentoException

org.imixs.workflow.exceptions.PluginException

addMagentoEntity

public org.imixs.workflow.ItemCollection addMagentoEntity(org.imixs.workflow.ItemCollection workitem,
                                                          org.imixs.workflow.ItemCollection magentoEntity)

This method adds the properties form a magento entity to an existing workitem. Each property of the magento entity will be prafixed with 'm_'. entity_id => m_entity_id The method also clears all existing magento properties before!

Parameters:

workitem - - a workItem instance

magentoEntity - - holds the properties to be added into the workItem

isWorkitemEqualsToMagentoEntity

public boolean isWorkitemEqualsToMagentoEntity(org.imixs.workflow.ItemCollection workitem,
                                               org.imixs.workflow.ItemCollection magentoEntity)

This method compares the data of a Imixs Workitem with the data of a magento entity. In a imixs worktiem all magento properties are starting with 'm_'

Parameters:

workitem -

magentoEntity -

Returns:

true if all magento properties of workitem equals to magentoEntity

clearCache

public void clearCache()