Package com.apptus.esales.connector

This package provides utilities for communication with an eSales cluster and this package documentation contains information on how to get started.

If the cluster is hosted in a cloud, the CloudConnector should be used. Otherwise, the OnPremConnector should be used.
The connector objects are obtained by calling the static get(String) or getOrCreate(String) methods available in both classes. The getOrCreate method will create an instance if there is no instance using that url already. The get method will not throw any exceptions but if there is no instance using the given url, it will return null.

The Connector instance is used for imports and exports and fetching Session instances.
The Session instance is used to notify eSales and create Panel instances.
The Panel instance is used to execute eSales panels and parse them into subclasses of the Result class.

See Also:

Connector, Session, Panel, Result

Interface Summary

Interface	Description
Cluster	Deprecated.
Result	Base class for results parsed from the replies from an eSales service.
Result.Facet

Class Summary

Class	Description
ArgMap	Convenience class for passing arguments to a panel request.
Authorization	Deprecated. Please use CustomerKeyAuthentication instead.
CloudConnector	Connector for Apptus eSales when hosted in the cloud.
Connector	Abstract super type for CloudConnector and OnPremConnector.
Connector.ConnectorKey
ConnectorSettings
CssClass	Class used to generate the css classes that are required to use automatic notifications or site overlay for web pages.
CustomerKeyAuthentication	A class that should be used for creating personal customer keys when using eSales Web-API.
DynamicPage	A dynamic page consists of a page name and a number of subpanels.
EventDataJobResult	Used to represent the responses from customer data related methods (e.g.
Facets	Class for creating a facets argument, used for check-box navigation.
Filter	A convenience class for filters used as argument to selected functions in the eSales service.
FilterBuilder	A set of static methods for building a filter.
JavaScriptNotifier	A class used by the JavaScript notification system.
MessageAuthentication	A class that is used for signing messages.
OnPremConnector	Connector for on-premise instances of Apptus eSales.
Order	A sale order from a customer session.
Order.Line	An order line in a sale order.
Panel	A panel in the eSales panel hierarchy.
PanelContent	The content of a panel as retrieved from an eSales service.
ProductStreamer	An Iterable ProductStreamer that allows you to do filtered product exports, conveniently parsed into Result.Product items.
Reporter	A Reporter fetches market-specific reports from an eSales cluster.
Result.Ad	Represents a single element in a result having the ad format.
Result.Ads	Represents a result having the ads format.
Result.Attribute	Representation of an attribute for a product, variant, category or ad.
Result.Category	A common abstraction for the Result.CategoryNode and Result.CategoryData classes.
Result.CategoryData	A class representing a category that holds only attribute information.
Result.CategoryList	Represents a result having the category_list format, which is a list of CategoryData objects.
Result.CategoryNode	Represents a result having the category_tree format.
Result.Completion	Represents a single element in a result having the completions format.
Result.Completions	Represents a result having the completions format.
Result.Correction	Represents a single element in a result having the corrections format.
Result.Corrections	Represents a result having the corrections format.
Result.Count	Represents a result having the count format.
Result.FacetList	Represents a result having the facet list format.
Result.FacetRange	Represents a result having the facet_range format.
Result.Phrase	Represents a single element in a result having the phrases format.
Result.Phrases	Represents a result having the phrases format.
Result.Product	Represents a single element in a result having the products format.
Result.Products	Represents a result having the products format.
Result.Value	Represents a single element in a result having the values format.
Result.Values	Represents a result having the values format.
Result.Variant	Represents a product variant.
Session	A session where information is exchanged with an eSales service.
SKUList	Deprecated. As of eSales 3.3, please use Order instead.
Subpanel	A subpanel refers to a public panel, and can be provided to a dynamic page in order to retrieve content from several panels at once without having to predefine a zone.
TimeoutSettings

Enum Summary

Enum	Description
EventDataJobResult.Status
Result.ResultType	Result types

Exception Summary

Exception	Description
ClusterUnavailableException	Signals that a cluster operation gave up since no units seem to be able to process the request.
ControllerConfigurationException	Deprecated. Not used as of eSales 3.3.
DuplicateSubpanelException
FetchClusterException	Exception for errors during cluster configuration loading
InterruptedIterationException	Thrown when an iteration is prematurely interrupted by an exception.
InvalidFilterException	Thrown to signal that an invalid filter was specified using the filter builder.
MissingSubpanelException
PanelException	Thrown when trying to read the result from a panel, if the evaluation resulted in error in the eSales service.
ParseException	Thrown when a response from the eSales service could not be parsed.
ResultTypeException	Thrown when trying to retrieve a result as a specific resultType, which the result does not match.