org.imixs.workflow.magento.html

Class MagentoHTMLClient

java.lang.Object

org.imixs.workflow.magento.html.MagentoHTMLClient

public class MagentoHTMLClient
extends Object

This HTMLClient is used to connect into the Magento Backend. The client can read any page to be parsed for content. For example to receive a html page of a specific sales order content the following deep link url pattern can be used. http://[MAGENTO_HOST]/index.php/admin/sales_order/view/order_id/[ORDER_ID] The reason for this client is the fact that some attributes of a customized magento shop are not provided by the Magento Rest API and SOAP API. So this client allows read the html backend data. The method 'readPage() allows to read the content of a page. The method expects the deep link uri, userid and password to login to the backend. The HTMLClient caches a valid session.

Version:

1.0

Author:

Ralph Soika

See Also:

://www.mkyong.com/java/java-httpurlconnection-follow-redirect-example/, http://www.mkyong.com/java/how-to-send-http-request-getpost-in-java/

Constructor Summary

Constructors

Constructor and Description
MagentoHTMLClient(String user, String password, String basisURL) Creates a HTMLCLient instance with backend userid and password.

Method Summary

Modifier and Type	Method and Description
String	getEncoding()
String	getPassword()
String	getUser()
String	readPage(String uri) This method get the content of a GET request.
String	readPage(String uri, boolean redirectWithLogin) This method get the content of a GET request.
void	setBasicAuhtCredentials(String auser, String apw) This method sets additional credentials for a basic Authentification.
void	setEncoding(String aEncoding)
void	setPassword(String password)
void	setUser(String user)

Methods inherited from class java.lang.Object

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

Constructor Detail

MagentoHTMLClient

public MagentoHTMLClient(String user,
                         String password,
                         String basisURL)

Creates a HTMLCLient instance with backend userid and password.

Parameters:

user -

password -

Method Detail

setBasicAuhtCredentials

public void setBasicAuhtCredentials(String auser,
                                    String apw)

This method sets additional credentials for a basic Authentification. This can be used if the magento backend is secured additional with a basic authentification

Parameters:

auser -

apw -

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String aEncoding)

getUser

public String getUser()

setUser

public void setUser(String user)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

readPage

public String readPage(String uri)
                throws Exception

This method get the content of a GET request. If the response is a Magento login form the method will proceed a form base authentication.

Parameters:

uri - - Rest Endpoint URI

Returns:

HTTPResult

Throws:

Exception

readPage

public String readPage(String uri,
                       boolean redirectWithLogin)
                throws Exception

This method get the content of a GET request. If the response is a Magento login form the method will proceed a form base authentication.

Parameters:

uri - - Rest Endpoint URI

redirectWithLogin - - indicates if a form based login form in the response should be processed

Returns:

HTTPResult

Throws:

Exception