Package com.apptus.esales.connector

Class OnPremConnector

java.lang.Object

com.apptus.esales.connector.Connector

com.apptus.esales.connector.OnPremConnector

public class OnPremConnector
extends Connector

Connector for on-premise instances of Apptus eSales.

This class acts as a facade to the connector library. All requests to the eSales service are initiated by method calls to a Connector object, or an object obtained via the connector.

Use the getOrCreate(String) method to obtain a OnPremConnector object.

Nested Class Summary

Nested classes/interfaces inherited from class com.apptus.esales.connector.Connector

Connector.ConnectorKey

Method Summary

Modifier and Type	Method	Description
List<String>	availableAdAttributes()	Gets a list of the names of all ad attributes that has been imported to eSales.
List<String>	availableAttributeTypes()	Returns a list of available attribute types from the eSales cluster.
List<String>	availableCategoryAttributes()	Gets a list of the names of all category attributes that has been imported to eSales.
List<String>	availableProductAttributes()	Gets a list of the names of all product and variant attributes that has been imported to eSales.
List<String>	availableScanRules()	Deprecated. No longer serves any purpose.
List<String>	availableStringRules()	Deprecated. No longer serves any purpose.
static OnPremConnector	defineCluster(String clusterString)	Defines a cluster.
static OnPremConnector	defineCluster(String clusterString, ExecutorService asyncTaskExecutor)	Defines a cluster.
void	defragment()	Defragments the eSales Servers in the eSales cluster.
static OnPremConnector	get(String uri)	Gets a connector, provided a cluster URI.
static OnPremConnector	get(String uri, ExecutorService asyncTaskExecutor)	Gets a connector, provided a cluster URI and task executor.
static OnPremConnector	getOrCreate(String uri)	Creates a connector, unless already created, provided a cluster URI.
static OnPremConnector	getOrCreate(String uri, ExecutorService asyncTaskExecutor)	Creates a connector, unless already created, provided a cluster URI.
String	queryStatistics(int qp)	Returns query statistics for the specified eSales Server.
void	synchronize(boolean ignore)	Synchronizes all eSales Servers in the eSales cluster.
String	testPanel(String panelXml, String panel, String role, Map<? extends CharSequence,? extends CharSequence> arguments)	Deprecated. use testPanel(String panelXml, String panel, String role, Map<String, String> arguments, String sessionKey, String market, String customerKey) instead.
String	testPanel(String panelXml, String panel, String role, Map<String,String> arguments, String sessionKey, String market, String customerKey)	Executes a panel from the specified panel definition.
PanelContent	testPanelAndParse(String panelXml, String panel, String role, Map<? extends CharSequence,? extends CharSequence> arguments)	Deprecated. use testPanelAndParse(String panelXml, String panel, String role, Map<String, String> arguments, String sessionKey, String market, String customerKey) instead.
PanelContent	testPanelAndParse(String panelXml, String panel, String role, Map<String,String> arguments, String sessionKey, String market, String customerKey)	Executes a panel from the specified panel definition.

Methods inherited from class com.apptus.esales.connector.Connector

availableMarkets, checkCustomerDataJobStatus, createExportCustomerDataJob, createRemoveCustomerDataJob, downloadExportCustomerDataJobResult, downloadExportCustomerDataJobResult, exportAds, exportAds, exportConfiguration, exportConfiguration, exportPanels, exportPanels, exportProducts, exportProducts, exportProducts, exportSynonyms, exportSynonyms, getVersion, importAds, importAds, importConfiguration, importConfiguration, importFile, importFile, importPanels, importPanels, importProducts, importProducts, importProducts, importProducts, importSynonyms, importSynonyms, latestNotifications, latestNotifications, putStrings, reporter, reporterForUnknownMarket, save, serverLog, serverLogNames, session, session, status

Methods inherited from class java.lang.Object

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

Method Detail

get

public static OnPremConnector get(String uri)

Gets a connector, provided a cluster URI. Equivalent of calling get(String, ExecutorService) with the asyncTaskExecutor set to ForkJoinPool.commonPool().

See getOrCreate(String) for details on the URI format.

Parameters:

uri - The base URI to an eSales cluster

Returns:

A connector, or null if no such connector has been created before.

get

public static OnPremConnector get(String uri,
                                  ExecutorService asyncTaskExecutor)

Gets a connector, provided a cluster URI and task executor.

See getOrCreate(String, ExecutorService) for details on the URI format.

Parameters:

uri - The base URI to an eSales cluster

asyncTaskExecutor - specify executor or null if you want to run healthcheck calls in the same thread

Returns:

A connector, or null if no such connector has been created before.

getOrCreate

public static OnPremConnector getOrCreate(String uri)
                                   throws com.apptus.util.http.ClientCreationException,
                                          FetchClusterException,
                                          MalformedURLException

Creates a connector, unless already created, provided a cluster URI. A new connector will be created if a connector for the uriString already exists but has an executor service associated. (getOrCreate(String, ExecutorService)) Equivalent of calling getOrCreate(String, ExecutorService) with the asyncTaskExecutor set to ForkJoinPool.commonPool(). To disable non-blocking behaviour, call getOrCreate(String, ExecutorService) with asyncTaskExecutor set to null.

The URI should be on the following format: esales://host1[:port1][;host2[:port2][;...]][?parameter1=value1[&parameter2=value2[&...]]]

Example: esales://node1.apptus.com;node2.apptus.com:35811?query_timeout=3500&notification_timeout=3500

Unspecified ports defaults to 35810.

The available parameters are:

• connection_timeout - the connection timeout in milliseconds, default 2000
• query_timeout - the query timeout in milliseconds, default 3000
• export_timeout - the export timeout in milliseconds, default 60000
• import_timeout - the import timeout in milliseconds, default 600000
• notification_timeout - the notification timeout in milliseconds, default 3000
• health_check_timeout - the health check timeout in milliseconds, default is 500
• compression_mode - what compression should be used when sending imports. Available settings:
  • none - No compression. This is the default.
  • gzip - Compress with GZIP.
  • pre_compressed_gzip - Send headers to indicate the import is compressed with GZIP, but don't do any compression. Use this if the file or InputStream you supply is already compressed.
  Note that files with names that end with ".gz" or ".gzip" will behave as if compression_mode=pre_compressed_gzip, regardless of what compression_mode is actually set to.

Parameter values must be URL encoded in order to avoid ambiguity.

Parameters:

uri - The base URI to an eSales cluster.

Returns:

A connector.

Throws:

com.apptus.util.http.ClientCreationException

FetchClusterException

MalformedURLException - if the URL contains errors.

getOrCreate

public static OnPremConnector getOrCreate(String uri,
                                          ExecutorService asyncTaskExecutor)
                                   throws com.apptus.util.http.ClientCreationException,
                                          FetchClusterException,
                                          MalformedURLException

Creates a connector, unless already created, provided a cluster URI. A new connector will be created if a connector for the uriString already exists but has a different executor service associated. Works the same as getOrCreate(String), providing an ExecutorService allows healthcheck calls to unresponsive nodes in a cluster to be run on a separate thread, without blocking other requests.

Parameters:

uri - The base URI to an eSales cluster.

asyncTaskExecutor - Executor for health check tasks.

Returns:

A connector.

Throws:

com.apptus.util.http.ClientCreationException

FetchClusterException

MalformedURLException - if the URL contains errors.

defineCluster

public static OnPremConnector defineCluster(String clusterString)
                                     throws IOException

Defines a cluster. The format of the cluster string is <host>:<port>;<host>:<port>;...

Parameters:

clusterString - A string defining a cluster.

Returns:

An OnPremConnector using the given cluster.

Throws:

com.apptus.util.http.Response.BusyClusterIOException - if the cluster is busy with another task

IOException - if any other I/O error occurs

See Also:

getOrCreate(String)

defineCluster

public static OnPremConnector defineCluster(String clusterString,
                                            ExecutorService asyncTaskExecutor)
                                     throws IOException

Defines a cluster. The format of the cluster string is <host>:<port>;<host>:<port>;...

Parameters:

clusterString - A string defining a cluster.

asyncTaskExecutor - Executor for health check tasks.

Returns:

An OnPremConnector using the given cluster.

Throws:

com.apptus.util.http.Response.BusyClusterIOException - if the cluster is busy with another task

IOException - if any other I/O error occurs

See Also:

getOrCreate(String, ExecutorService)

synchronize

public void synchronize(boolean ignore)
                 throws IOException

Synchronizes all eSales Servers in the eSales cluster.

When ignore is set to true any inconsistencies between eSales Servers in the eSales cluster are ignored by clearing the update history on all servers.

Parameters:

ignore - should be set to true if inconsistencies in the cluster should be ignored

Throws:

com.apptus.util.http.Response.BusyClusterIOException - if the cluster is busy with another task

IOException - if any other I/O error occurs

queryStatistics

public String queryStatistics(int qp)
                       throws IOException

Returns query statistics for the specified eSales Server.

Parameters:

qp - The (0-based) index of the eSales Server

Returns:

A string containing query statistics in the form of an XML document

Throws:

IOException - if there was any problem sending the request.

IndexOutOfBoundsException - if no qp with the given index can be found

defragment

public void defragment()
                throws IOException

Defragments the eSales Servers in the eSales cluster.

Throws:

com.apptus.util.http.Response.BusyClusterIOException - if cluster is busy with another task

IOException - if any other I/O error occurs

availableAttributeTypes

public List<String> availableAttributeTypes()
                                     throws IOException

Returns a list of available attribute types from the eSales cluster. Never returns null.

Returns:

An unmodifiable list of type names

Throws:

IOException - if there was any error getting available attribute types

availableStringRules

@Deprecated
public List<String> availableStringRules()
                                  throws IOException

Deprecated.

No longer serves any purpose.

Always returns an empty list

Returns:

an empty list

Throws:

IOException - it does not, kept for legacy reasons.

availableScanRules

@Deprecated
public List<String> availableScanRules()
                                throws IOException

Deprecated.

No longer serves any purpose.

Always returns an empty list

Returns:

an empty list

Throws:

IOException - it does not, kept for legacy reasons.

availableProductAttributes

public List<String> availableProductAttributes()
                                        throws IOException

Gets a list of the names of all product and variant attributes that has been imported to eSales.

Returns:

A list of product and variant attribute names.

Throws:

IOException - if there was any error getting product and variant attributes

availableAdAttributes

public List<String> availableAdAttributes()
                                   throws IOException

Gets a list of the names of all ad attributes that has been imported to eSales.

Returns:

A list of ad attribute names.

Throws:

IOException - if there was any error getting ad attributes

availableCategoryAttributes

public List<String> availableCategoryAttributes()
                                         throws IOException

Gets a list of the names of all category attributes that has been imported to eSales.

Returns:

A list of category attribute names.

Throws:

IOException - if there was any error getting category attributes

testPanel

@Deprecated
public String testPanel(String panelXml,
                        String panel,
                        String role,
                        Map<? extends CharSequence,? extends CharSequence> arguments)
                 throws IOException

Deprecated.

use testPanel(String panelXml, String panel, String role, Map<String, String> arguments, String sessionKey, String market, String customerKey) instead.

Throws:

IOException

testPanelAndParse

@Deprecated
public PanelContent testPanelAndParse(String panelXml,
                                      String panel,
                                      String role,
                                      Map<? extends CharSequence,? extends CharSequence> arguments)
                               throws IOException,
                                      ParseException

Deprecated.

use testPanelAndParse(String panelXml, String panel, String role, Map<String, String> arguments, String sessionKey, String market, String customerKey) instead.

Throws:

IOException

ParseException

testPanel

public String testPanel(String panelXml,
                        String panel,
                        String role,
                        Map<String,String> arguments,
                        String sessionKey,
                        String market,
                        String customerKey)
                 throws IOException

Executes a panel from the specified panel definition. If a role is specified, then only the part of the panel specified by the role is executed. Intended for test.

The arguments is always applied to the entire named panel.

Parameters:

panelXml - The panel definition, as an XML document

panel - The panel to execute

role - The part of the panel the return results from

arguments - The arguments of the panel

sessionKey - The session key for this request

market - The market for this request

customerKey - The customer key for this request

Returns:

The result as an XML document.

Throws:

IOException - if there was an error executing the panel.

testPanelAndParse

public PanelContent testPanelAndParse(String panelXml,
                                      String panel,
                                      String role,
                                      Map<String,String> arguments,
                                      String sessionKey,
                                      String market,
                                      String customerKey)
                               throws IOException,
                                      ParseException

Executes a panel from the specified panel definition. If a role is specified, then only the part of the panel specified by the role is executed. Intended for test.

The arguments is always applied to the entire named panel.

Parameters:

panelXml - The panel definition, as an XML document

panel - The panel to execute

role - The part of the panel the return results from

arguments - The arguments of the panel

sessionKey - The session key for this request

market - The market for this request

customerKey - The customer key for this request

Returns:

The result as PanelContent.

Throws:

IOException - if there was an error executing the panel.

ParseException - if result couldn't be parsed.