com.hybris.instore.common.impersonation

Class AbstractImpersonationController

java.lang.Object

DefaultWidgetController

com.hybris.instore.common.impersonation.AbstractImpersonationController

Direct Known Subclasses:

CategoryTreeController, ClassificationInfoController, PageableListAdapter, ProductDetailController, QRCodeController, SolrSearchController, VariantSelectorController

public abstract class AbstractImpersonationController
extends DefaultWidgetController

Abstract widget controller that integrates with ImpersonationService to allow controllers to call business logic in the impersonation context suitable for the instore application. To do so, extend from this class and call the facade methods within #executeInContext(de.hybris.platform.commerceservices.impersonation.ImpersonationService.Executor) method.

Constructor Summary

Constructors

Constructor and Description
AbstractImpersonationController()

Method Summary

Modifier and Type	Method and Description
protected ImpersonationContext	createImpersonationContext() Creates ImpersonationContext suitable for instore application.
protected <R,E extends Throwable> R	executeInContext(<any> executor) Executes the given Executor in the context created by createImpersonationContext().
protected CatalogVersionService	getCatalogVersionService()
protected Collection<CatalogVersionModel>	getContextCatalogVersions(BaseStoreModel baseStore, BaseSiteModel baseSite, EmployeeModel employee) Computes product catalogVersions for impersonated execution
protected CurrencyModel	getContextCurrency(EmployeeModel employee, BaseStoreModel baseStore) Computes currency for impersonated execution
protected LanguageModel	getContextLanguage(EmployeeModel employee, BaseSiteModel baseSite, BaseStoreModel baseStore) Computes language for impersonated execution
protected ImpersonationService	getImpersonationService()
protected InStoreService	getInStoreService()
protected SearchRestrictionService	getSearchRestrictionService()
protected SessionService	getSessionService()
protected UserService	getUserService()
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setImpersonationService(ImpersonationService impersonationService)
void	setInStoreService(InStoreService inStoreService)
void	setSearchRestrictionService(SearchRestrictionService searchRestrictionService)
void	setSessionService(SessionService sessionService)
void	setUserService(UserService userService)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractImpersonationController

public AbstractImpersonationController()

Method Detail

createImpersonationContext

protected ImpersonationContext createImpersonationContext()

Creates ImpersonationContext suitable for instore application. The context elements:

• user
• catalogVersions
• language
• currency
• site

are resolved using current user and InStoreService logic (and with search restrictions disabled).

Returns:

ImpersonationContext

getContextCatalogVersions

protected Collection<CatalogVersionModel> getContextCatalogVersions(BaseStoreModel baseStore,
                                                                    BaseSiteModel baseSite,
                                                                    EmployeeModel employee)

Computes product catalogVersions for impersonated execution

Parameters:

baseStore -

baseSite -

employee -

Returns:

Collection of CatalogVersionModel

getContextLanguage

protected LanguageModel getContextLanguage(EmployeeModel employee,
                                           BaseSiteModel baseSite,
                                           BaseStoreModel baseStore)

Computes language for impersonated execution

Parameters:

employee -

baseSite -

baseStore -

Returns:

LanguageModel

getContextCurrency

protected CurrencyModel getContextCurrency(EmployeeModel employee,
                                           BaseStoreModel baseStore)

Computes currency for impersonated execution

Parameters:

employee -

baseStore -

Returns:

CurrencyModel

executeInContext

protected <R,E extends Throwable> R executeInContext(<any> executor)
                                              throws E extends Throwable

Executes the given Executor in the context created by createImpersonationContext().

Type Parameters:

R - - Executor's return type

E - - Exception thrown by executor, if any (Use ImpersonationService.Nothing if your executor doesn't throw a checked exception.)

Parameters:

executor - - Executor to run

Returns:

result of execution.

Throws:

E

E extends Throwable

getInStoreService

protected InStoreService getInStoreService()

Returns:

the inStoreService

setInStoreService

public void setInStoreService(InStoreService inStoreService)

Parameters:

inStoreService - the inStoreService to set

getImpersonationService

protected ImpersonationService getImpersonationService()

Returns:

the impersonationService

setImpersonationService

public void setImpersonationService(ImpersonationService impersonationService)

Parameters:

impersonationService - the impersonationService to set

getUserService

protected UserService getUserService()

Returns:

the userService

setUserService

public void setUserService(UserService userService)

Parameters:

userService - the userService to set

getCatalogVersionService

protected CatalogVersionService getCatalogVersionService()

Returns:

the catalogVersionService

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

Parameters:

catalogVersionService - the catalogVersionService to set

getSessionService

protected SessionService getSessionService()

Returns:

the sessionService

setSessionService

public void setSessionService(SessionService sessionService)

Parameters:

sessionService - the sessionService to set

getSearchRestrictionService

protected SearchRestrictionService getSearchRestrictionService()

Returns:

the searchRestrictionService

setSearchRestrictionService

public void setSearchRestrictionService(SearchRestrictionService searchRestrictionService)

Parameters:

searchRestrictionService - the searchRestrictionService to set