Click or drag to resize
OnPremConnector Class
Connector for on-premise instances of Apptus eSales. All requests to the eSales service are initiated by method calls to a Connector, or an object obtained via the Connector. Use the GetOrCreate(String) or Get(String) method to obtain a OnPremConnector object.
Inheritance Hierarchy
SystemObject
  Apptus.ESales.ConnectorConnector
    Apptus.ESales.ConnectorOnPremConnector

Namespace:  Apptus.ESales.Connector
Assembly:  Apptus.Esales.ConnectorApi (in Apptus.Esales.ConnectorApi.dll) Version: 4.5.0
Syntax
C#
public class OnPremConnector : Connector

The OnPremConnector type exposes the following members.

Methods
  NameDescription
Public methodAvailableAdAttributes
Gets a list of the names of all ad attributes that has been imported to eSales.
Public methodAvailableAttributeTypes
Returns a list of available attribute types from the eSales cluster. Never returns null.
Public methodAvailableMarkets
Returns a list of available markets from the eSales cluster. Never returns null.
(Inherited from Connector.)
Public methodAvailableProductAttributes
Gets a list of the names of all product and variant attributes that has been imported to eSales.
Public methodAvailableScanRules Obsolete.
Always returns an empty list
Public methodAvailableStringRules Obsolete.
Always returns an empty list
Public methodCheckCustomerDataJobStatus
Check the status of a GDPR customer data job.
(Inherited from Connector.)
Public methodCreateExportCustomerDataJob
Start a GDPR job on the cluster to export all data related to the given customer key. "Linked" customer keys will also be exported(i.e.customer keys that have been notified in the same session). Status of the job can be checked with {@link #checkCustomerDataJobStatus(String)} and when the status is , the resulting zip file can be downloaded using
(Inherited from Connector.)
Public methodCreateRemoveCustomerDataJob
Start a GDPR job on the cluster to remove all data related to the given customer key. Data will be removed both from memory and disk. "Linked" customer keys will also be removed(i.e.customer keys that have been notified in the same session).
(Inherited from Connector.)
Public methodStatic memberDefineCluster
Defines a cluster. The format of a cluster string is <host>:<port>;<host>:<port>;...
Public methodDefragment
Defragments the query processors in the eSales cluster.
Public methodDownloadExportCustomerDataJobResult(String)
Download the result of a GDPR export customer data job.
(Inherited from Connector.)
Public methodDownloadExportCustomerDataJobResult(String, String)
Download the result of a GDPR export customer data job.
(Inherited from Connector.)
Public methodEquals (Inherited from Object.)
Public methodExportAds
Exports ad data from the eSales cluster by returning a stream to the caller.
(Inherited from Connector.)
Public methodExportAds(String)
Exports ad data from the eSales cluster to the specified destinationFile.
(Inherited from Connector.)
Public methodExportConfiguration
Exports esales configuration from the eSales cluster by returning a stream to the caller.
(Inherited from Connector.)
Public methodExportConfiguration(String)
Exports esales configuration from the eSales cluster to the specified destinationFile.
(Inherited from Connector.)
Public methodExportPanels
Exports panel configuration from the eSales cluster by returning a stream to the caller.
(Inherited from Connector.)
Public methodExportPanels(String)
Exports panel configuration from the eSales cluster to the specified destinationFile.
(Inherited from Connector.)
Public methodExportProducts
Exports product data from the eSales cluster by returning a stream to the caller.
(Inherited from Connector.)
Public methodExportProducts(String)
Exports product data from the eSales cluster to the specified destinationFile.
(Inherited from Connector.)
Public methodExportProducts(String, String)

Returns an IEnumerable ProductStreamer that allows you to do filtered product exports, conveniently parsed into ResultProduct items. Every new iteration on this class will result in a new request to eSales. Note that the IEnumerator returned by its GetEnumerator method must be disposed when done, but this is done automatically when using foreach iteration.

Note that while iterating, imports will be blocked from completing on a selected eSales server. Imports will not fail but will wait for the iteration to finish. This means that if you fail to close the ProductStreamer you might block imports indefinitely!

(Inherited from Connector.)
Public methodExportSynonyms
Exports synonym data from the eSales cluster by returning a stream to the caller.
(Inherited from Connector.)
Public methodExportSynonyms(String)
Exports synonym data from the eSales cluster to the specified destinationFile.
(Inherited from Connector.)
Protected methodFinalize (Inherited from Object.)
Public methodStatic memberGet(String)

Creates a connector with enabled asynchronous health check, unless already created, provided a cluster URI.

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. 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. Parameter values must be URL encoded in order to avoid ambiguity.
Public methodStatic memberGet(String, Boolean)

Gets a connector, provided a URL specifying the controller of an eSales cluster.

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. 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. Parameter values must be URL encoded in order to avoid ambiguity.
Public methodGetHashCode (Inherited from Object.)
Public methodStatic memberGetOrCreate(String)

Creates a connector, unless already created, provided a cluster URI. A new connector will be created if a connector for the URI already exists but created by calling GetOrCreate(uri, false). Connector created by this method will use System.Threading.ThreadPool for health checks of unavailable servers in the cluster.

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. report_timeout - The report timeout in milliseconds, default 120000 (2 minutes). 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. Parameter values must be URL encoded in order to avoid ambiguity.
Public methodStatic memberGetOrCreate(String, Boolean)

Creates a connector, unless already created, provided a cluster URI. A new connector will be created if a connector for the URI already exists but created with a different asyncHealthCheck flag value. System.Threading.ThreadPool will be used if asyncHealthCheck flag is true.

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. report_timeout - The report timeout in milliseconds, default 120000 (2 minutes). 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. Parameter values must be URL encoded in order to avoid ambiguity.
Public methodGetType (Inherited from Object.)
Protected methodImport(IInputSource, String, String, CompressionMode) (Inherited from Connector.)
Protected methodImport(IInputSource, String, String, CompressionMode, NullableBoolean) (Inherited from Connector.)
Public methodImportAds(Stream, String)
Imports ads from the specified stream to the eSales cluster.
(Inherited from Connector.)
Public methodImportAds(String, String)
Imports ads from the specified importFile to the eSales cluster.
(Inherited from Connector.)
Public methodImportConfiguration(Stream, String)
Imports configuration from the specified stream to the eSales cluster.
(Inherited from Connector.)
Public methodImportConfiguration(String, String)
Imports configuration from the specified importFile to the eSales cluster.
(Inherited from Connector.)
Public methodImportPanels(Stream, String)
Imports panels from the specified stream to the eSales cluster.
(Inherited from Connector.)
Public methodImportPanels(String, String)
Imports panels from the specified importFile to the eSales cluster.
(Inherited from Connector.)
Public methodImportProducts(Stream, String)
Imports products from the specified stream to the eSales cluster.
(Inherited from Connector.)
Public methodImportProducts(String, String)
Imports products from the specified importFile to the eSales cluster.
(Inherited from Connector.)
Public methodImportProducts(Stream, String, NullableBoolean)
Imports products from the specified stream to the eSales cluster.
(Inherited from Connector.)
Public methodImportProducts(String, String, NullableBoolean)
Imports products from the specified importFile to the eSales cluster.
(Inherited from Connector.)
Public methodImportStream(Stream, String, String, String) (Inherited from Connector.)
Public methodImportStream(Stream, String, String, String, NullableBoolean) (Inherited from Connector.)
Public methodImportSynonyms(Stream, String)
Imports synonyms from the specified stream to the eSales cluster.
(Inherited from Connector.)
Public methodImportSynonyms(String, String)
Imports synonyms from the specified importFile to the eSales cluster.
(Inherited from Connector.)
Public methodLatestNotifications
Returns the last 100 notifications received by the eSales cluster.
(Inherited from Connector.)
Public methodLatestNotifications(String)
Returns the last 100 notifications received by the eSales cluster.
(Inherited from Connector.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodQueryStatisics Obsolete.
Public methodQueryStatistics
Returns query statistics from the cluster.
Public methodReporter
Creates a reporter for a market during a specified time interval. The reporter can be used to fetch reports from the eSales cluster.
(Inherited from Connector.)
Public methodReporterForUnknownMarket
Creates a reporter for the unknown market (sessions without a market property), during a specified time interval. The reporter can be used to fetch reports from the eSales cluster.
(Inherited from Connector.)
Public methodServerLog
Gets a log from a server. Server index should be an index in the range [0, number_of_servers - 1]. The servers are indexed in the same order as they appear in the cluster string. The server indexes can also be retrieved from the status command. Name is the name of a log. Available log names can be retrieved from ServerLogNames.
(Inherited from Connector.)
Public methodServerLogNames
Gets a list of available log names.
(Inherited from Connector.)
Public methodSession(String) Obsolete.
Gets a session for the specified sessionKey.
(Inherited from Connector.)
Public methodSession(String, String, String)
Creates a session for the specified session key with the specified customer key and market. Calling this method does not affect the session in the eSales server. A notification or panel query, on the object created by this method, is necessary for the properties to stick to the session. When calling this method with null in place of customerKey and/or market, the server will keep the current values of these properties for this session.
(Inherited from Connector.)
Public methodStatus
Returns a status report from the eSales cluster as an XML document.
(Inherited from Connector.)
Public methodSynchronize
Synchronizes all query processor in the eSales cluster. Will ignore inconsistencies between server nodes in the eSales cluster, by clearing the update history when ignore is set to true.
Public methodTestPanel
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. The arguments is always applied to the entire named panel.
Public methodToString (Inherited from Object.)
Top
See Also