Package com.apptus.esales.connector

Class CloudConnector

java.lang.Object

com.apptus.esales.connector.Connector

com.apptus.esales.connector.CloudConnector

public class CloudConnector
extends Connector

Connector for Apptus eSales when hosted in the cloud.

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

Use the getOrCreate(String) or get(String) method to obtain a CloudConnector object.

Author:

Thomas Raneland

Nested Class Summary

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

Connector.ConnectorKey

Method Summary

Modifier and Type	Method	Description
static CloudConnector	get(String uri)	Gets a connector, provided an eSales cluster URI.
static CloudConnector	get(String uri, ExecutorService asyncTaskExecutor)	Gets a connector, provided an eSales cluster URI.
static CloudConnector	getOrCreate(String uriString)	Creates a connector, unless already created, provided an eSales cluster URI.
static CloudConnector	getOrCreate(String uriString, ExecutorService asyncTaskExecutor)	Creates a connector, unless already created, provided an eSales cluster URI.

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, importPanels, importPanels, 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 CloudConnector get(String uri)

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

See the 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 CloudConnector get(String uri,
                                 ExecutorService asyncTaskExecutor)

Gets a connector, provided an eSales cluster URI.

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

Parameters:

uri - The base URI to an eSales cluster.

asyncTaskExecutor - executor to be used for non-blocking health-check requests. Set to null if you want to have blocking behaviour.

Returns:

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

getOrCreate

public static CloudConnector getOrCreate(String uriString)
                                  throws MalformedURLException

Creates a connector, unless already created, provided an eSales 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://username:password[@host[:port][;...]][?parameter1=value1[&parameter2=value2[&...]]]

Example 1: esales://john:doe

Example 2: esales://john:doe?query_timeout=3500&;notification_timeout=3500

Example 3: esales://john:doe@cirrus.esales.apptus.com;stratus.esales.apptus.com?query_timeout=3500&notification_timeout=3500

Unspecified ports defaults to 35000.

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
• report_timeout - the report timeout in milliseconds, default 120000 (2 minutes)
• 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.
  • gzip - Compress with GZIP. This is the default.
  • 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.

Parameters:

uriString - The base URI to an eSales cluster.

Returns:

A connector.

Throws:

MalformedURLException - if the URL contains errors.

getOrCreate

public static CloudConnector getOrCreate(String uriString,
                                         ExecutorService asyncTaskExecutor)
                                  throws MalformedURLException

Creates a connector, unless already created, provided an eSales 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:

uriString - The base URI to an eSales cluster.

asyncTaskExecutor - Executor for health check tasks, or null for healthchecks in same thread.

Returns:

A connector.

Throws:

MalformedURLException - if the URL contains errors. Works like getOrCreate(String), but provide executor service for async