Essential Hybris Services

The services listed below are widely used in SAP Hybris development. This is not a complete list of Hybris services, but these are used in almost every project. To prioritize the services, I used the following Bash command, launched in the Hybris home directory:

find . -name *-spring.xml | xargs cat | grep 'property name=' | grep ' ref=' | perl -npe 's/^(.*)ref="(.*)"(.*)$/\2/g' | grep Service | sort | uniq -c | sort -nr

I also extracted beans under @Resource and @Autowired annotations and combined the results with what I got from the Bash script.

The quick reference below helps with understanding the important concepts of how services work and where they are used. For all services, the corresponding beans have the same name and start with a lowercase letter, as per the bean naming convention.

ModelService

• SAP Hybris model management. Creating, loading, and writing Hybris data models (Item).
• Key operations:
  • create,
  • get/get by example,
  • attach/detach,
  • clone,
  • save,
  • remove,
  • enable/disable transactions,
  • get/set attribute value.
• It is a generic interface to the Hybris persistence layer. If you need to retrieve or create an item, you eventually use this interface directly or indirectly.

UserService

• User management, such as employees, customers, etc.
• Key operations:
  • get user by ID,
  • get user group by ID,
  • get/set current session user,
  • get/set passwords.
• Deals primarily with UserModel/EmployeeModel/CustomerModel and UserGroupModel.

CatalogVersionService

• Provides basic catalog version-oriented functionality, such as Online, Staged, etc.
• Key operations:
  • get/set/add session catalog version,
  • fetch catalog version model by catalog and version name,
  • find duplicated IDs,
  • determine whether a user is eligible for read/write operations within the given catalog version.
• Deals primarily with CatalogVersionModel and CatalogModel.

FlexibleSearchService

• SQL-like search on Hybris item types.
• Key operations:
  • search,
  • get model(s) by example,
  • translate to SQL.
• Built on top of Jalo (old) FlexibleSearch.

ProductService

• Product management.
• Key operations:
  • get product by code,
  • catalog version,
  • get product for category,
  • get all products for catalog version.
• Mainly uses ProductDAO as an interface. ProductDAO mainly uses FlexibleSearchService to access the items.

TypeService

• Hybris type management.
• Key operations:
  • get composed/atomic/enumeration type by code/class,
  • get attribute descriptor for a type by qualifier,
  • get all attribute descriptors,
  • get enumeration values,
  • get mandatory/unique attributes,
  • get default values for a type.
• Deals with TypeModel, DescriptorModel.
• Mainly uses TypeDAO as an interface. TypeDAO mainly uses ModelService to access the items.

CommonI18NService

• Country, language, and currency management.
• Key operations:
  • get locale for a language / ISO code,
  • get language for ISO code,
  • get/set current language / currency,
  • get country by ISO code,
  • get region by country and region code,
  • get currency for a currency code,
  • get base currency,
  • get all countries / regions / currencies,
  • convert/round currency.
• Deals with CountryModel, CurrencyModel, LanguageModel, and RegionModel.
• Mainly uses CountryDAO / CurrencyDAO / LanguageDAO / RegionDAO as interfaces to the persistence layer.
• Uses a conversion strategy (redefinable) for convert/round operations.

I18NService (deprecation)

• General international support service, an interface to the Java Internationalization/Localization API: Locale, Currency, TimeZone.
• Key operations:
  • get/set current locale/time zone/currency,
  • get supported locales,
  • get/set language fallback,
  • get fallback locales,
  • get currency by ISO code.
• Deals with CountryModel, CurrencyModel, LanguageModel, and RegionModel.
• Uses the following services:
  • locale service.

BaseSiteService

• Base site management.
• Key operations:
  • get all base sites,
  • get base site for UID,
  • get/set current base site,
  • get product catalogs for a base site.
• Deals with BaseSiteModel.
• Mainly uses BaseSiteDAO as an interface. BaseSiteDAO uses FlexibleSearchService to access the items.
• Uses the following redefinable services:
  • session service.

CartService

• Cart management.
• Key operations:
  • add to cart,
  • get/set/remove session cart,
  • calculate cart,
  • update quantities for a cart,
  • merge carts (append),
  • change user for a cart,
  • create cart from a quote,
  • clone a cart,
  • get/add/remove global discounts,
  • get/add/remove total tax values.
• Deals with CartModel, QuoteModel, ProductModel, OrderModel, OrderEntryModel, and others.
• Uses the following redefinable strategies:
  • add-to-cart strategy,
  • order calculation strategy,
  • create cart from quote strategy.

SessionService

• Session management.
• Key operations:
  • get current session,
  • create new session,
  • close session and close current session,
  • get/set/remove session attribute,
  • get all session attributes,
  • execute code in the local session context (+with params / for a specific user).
• Uses JaloConnection, JaloSession.

ConfigurationService

• Access to Hybris configuration.
• Key operations:
  • retrieve Hybris configuration.

CalculationService

• Calculating orders/carts (entries, discounts, taxes).
• Key operations:
  • (re-)calculate the order (+for a particular date in the past or future),
  • check if calculation is required for an order,
  • calculate totals (faster, does not trigger tax/price/discount calculations),
  • recalculate the cart/order entry.
• Deals mainly with AbstractOrderModel.
• Uses other redefinable services:
  • Model Service,
  • Commerce Price Service,
  • Base Site Service,
  • CommonI18NService.
• Uses the following redefinable strategies:
  • Find Discount Values Strategy,
  • Find Tax Values Strategy,
  • Find Price Strategy,
  • Find Delivery Cost Strategy,
  • Find Payment Cost Strategy,
  • Order Requires Calculation Strategy.

IndexerService

• Solr search index operations.
• Key operations:
  • perform full index,
  • update index (+for a particular type, for particular items, for particular indexed properties),
  • delete index (+of a particular type, particular items).
• Uses the following redefinable strategies:
  • Indexer Strategy (responsible for creating and executing the indexer workers).

CronJobService

• CronJob management.
• Key operations:
  • perform a given CronJob, synchronously or not,
  • request abort CronJob,
  • get CronJob by code,
  • get job by code,
  • CronJob execution status (successful or not, error or not, finished or running),
  • get CronJob logs (as text).
• Deals mainly with CronJobModel, JobModel.
• Uses redefinable services:
  • Tenant Service,
  • Cluster Service.

MediaService

• Media management.
• Key operations:
  • get/set stream/raw data of/to the file from/of the media object,
  • add/remove version streams for media,
  • get/set URL/stream for media version,
  • set media folder for media,
  • get media folder by qualifier,
  • get root folder,
  • get media format by qualifier,
  • move media to folder,
  • copy/duplicate/move data from one media item to another,
  • get media by code/format.

FacetSearchService

• Solr facet search operations.
• Key operations:
  • create search query / create populated search query to use with search,
  • create free search query for a user query to use with search,
  • search query.
• Redefinable strategies:
  • Facet Search Strategy (implementation of search).

OrderService

• Order management.
• Key operations:
  • create order from cart,
  • submit an order,
  • add new entry to an order,
  • clone an order,
  • get/add/remove global discounts,
  • get/add/remove total tax values.
• Uses redefinable strategies:
  • place order strategy,
  • order calculation strategy,
  • create order from cart strategy,
  • submit order strategy.

BusinessProcessService

• Business process management.
• Key operations:
  • create a process,
  • start a process (by process code),
  • get a process by process code,
  • trigger an event,
  • restart the process.

BaseStoreService

• Base store management.
• Key operations:
  • get all base stores,
  • get base store by ID,
  • get current base store.
• Uses a redefinable strategy:
  • baseStoreSelectorStrategy (implements getCurrentBaseStore).

CatalogService

• Catalog management service.
• Key operations:
  • get all catalogs (+of a particular type),
  • get catalog for catalog ID,
  • get default catalog,
  • get session catalog version.
• Uses redefinable services:
  • catalog version service.

SiteConfigService

• Site config management service.
• Key operations:
  • get property by name.
• Uses redefinable services:
  • configuration service,
  • base site service,
  • UI Experience Service.

EventService

• Event management service.
• Key operations:
  • publish an event,
  • register event listener,
  • unregister event listener.
• Uses redefinable services:
  • tenant service,
  • cluster service.

CMSSiteService

• CMS site management service.
• Key operations:
  • get all catalogs of a site,
  • get product catalogs of a site,
  • get all sites,
  • get all classification catalogs of a site,
  • get/set current catalog version,
  • get/set current site,
  • get site for URL,
  • get start page label or ID for a site.
• Uses the following redefinable services:
  • catalog version service.

CategoryService

• Category management service.
• Key operations:
  • get root categories (+for catalog version),
  • get category by code,
  • get categories having the particular code,
  • get category path for a product,
  • get category path for a category,
  • set allowed principals for category / all related categories,
  • get all sub/super categories for category.
• Uses the following redefinable services:
  • catalog version service.
• Uses the following redefinable strategies:
  • categoryPrincipalStrategy.

CMSPageService

• CMS page management service.
• Key operations:
  • get all active page templates,
  • get all content pages,
  • get (own) content slots for a page/page template,
  • get default catalog / category / content / product page,
  • get default page by label,
  • get homepage,
  • get label or ID for a page,
  • get page by catalog / catalog ID / category / category code / ID / label and page statuses / label or ID / product / product code,
  • get pages by page template content slots,
  • get pages for component / content slots / page template component / page template content slots,
  • get sorted multicountry content slots.
• Uses the following redefinable services:
  • CMS restriction service,
  • catalog service,
  • category service,
  • product service,
  • type service,
  • configuration service,
  • catalog version service,
  • CMS catalog level service.

CMSComponentService

• CMS component management service.
• Key operations:
  • get CMS component by code (+and catalog version).
• Uses the following redefinable services:
  • type service,
  • catalog version service.

PromotionsService

• Promotions management service.
• Key operations:
  • get promotions for a product and promotion groups (+for a specific date in the future or in the past),
  • get order promotions (+for a specific date in the future or in the past) (+for a product),
  • update promotions for an order (+by a specific date),
  • get promotion results from the order,
  • delete stored promotion results for a cart,
  • transfer the promotions applied to a cart to a new order,
  • get promotion restrictions,
  • get promotion group.