Package de.hybris.platform.cockpit.session.impl

Class UISessionImpl

java.lang.Object

de.hybris.platform.cockpit.session.impl.UISessionImpl

All Implemented Interfaces:

UISession, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class UISessionImpl
extends java.lang.Object
implements UISession, org.springframework.context.ApplicationContextAware

Field Summary

Fields inherited from interface de.hybris.platform.cockpit.session.UISession

PERSPECTIVE_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
UISessionImpl()

Method Summary

Modifier and Type	Method	Description
void	addSessionListener(UISessionListener listener)	Adds a session listener.
void	clearSessionListeners()
protected org.zkoss.zk.ui.sys.IdGenerator	createIdGenerator()
protected void	fireAfterLogin()
protected void	fireBeforeLogout()
protected void	fireDataLanguageChanged()
protected void	firePerspectiveChanged(UICockpitPerspective old)
java.util.List<UICockpitPerspective>	getAvailablePerspectives()	Returns all available perspectives.
UICockpitPerspective	getCurrentPerspective()	Returns the current product cockpit perspective bean.
java.lang.String	getGlobalDataLanguageIso()	Returns the isocode of the current data language.
java.util.Locale	getGlobalDataLocale()
JasperReportsRefresh	getJasperReportsRefresh()	Returns service, which handles all page refresh requirements.
LabelService	getLabelService()
java.lang.String	getLanguageIso()	Returns the isocode of the current session language.
protected java.util.List<UISessionListener>	getListeners(boolean create)
java.util.Locale	getLocale()
LocalizationService	getLocalizationService()
ModelService	getModelService()
NewItemService	getNewItemService()
UICockpitPerspective	getPerspective(java.lang.String uid)
java.util.List<PushCreationContainer>	getPushContainers()
RequestHandler	getRequestHandler()
SavedQueryService	getSavedQueryService()
SearchService	getSearchService()
java.util.List<CatalogVersionModel>	getSelectedCatalogVersions()
java.util.Set<java.lang.String>	getSupportedLanguageIsoCodes()
SystemService	getSystemService()
TypeService	getTypeService()
UIAccessRightService	getUiAccessRightService()
UIConfigurationService	getUiConfigurationService()
UndoManager	getUndoManager()
UserModel	getUser()	Returns the current ui session user.
ObjectValueHandlerRegistry	getValueHandlerRegistry()
void	initSession()
boolean	isCachePerspectivesEnabled()
boolean	isDragOverPerspectivesEnabled()
boolean	isPerspectiveAvailable(java.lang.String uid)
boolean	isUsingTestIDs()
void	login(UserModel user)	Assigns specified user to this session.
void	logout()
void	registerAdditionalPerspectives()	registers additional perspectives
void	registerPerspectiveContainer(org.zkoss.zk.ui.Component comp)
void	removeSessionListener(UISessionListener listener)	Removes session listener.
void	sendGlobalEvent(CockpitEvent event)	Processes given event.
void	sendGlobalEvent(CockpitEvent event, boolean immediate)	Processes given event.
void	setApplicationContext(org.springframework.context.ApplicationContext appCtx)
void	setAvailablePerspectives(java.util.List<UICockpitPerspective> availablePerspectives)
void	setCachePerspectivesEnabled(boolean cachePerspectivesEnabled)
void	setCockpitTypeService(TypeService cockpitTypeService)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setCurrentPerspective(UICockpitPerspective perspective)	Changes the current product perspective bean.
void	setCurrentPerspective(UICockpitPerspective perspective, java.util.Map<java.lang.String,? extends java.lang.Object> params)
void	setDragOverPerspectivesEnabled(boolean dragOverPerspEnabled)
void	setGlobalDataLanguageIso(java.lang.String globalDataLanguageIso)
void	setInitialSessionListeners(java.util.Collection<UISessionListener> listeners)
void	setJasperReportsRefresh(JasperReportsRefresh jasperReportsRefresh)
void	setLabelService(LabelService labelService)
void	setLocalizationService(LocalizationService localizationService)
void	setModelService(ModelService modelService)
void	setNewItemService(NewItemService newItemService)
void	setPushContainers(java.util.List<PushCreationContainer> pushContainers)
void	setRequestHandler(RequestHandler reqHandler)
void	setSavedQueryService(SavedQueryService savedQueryService)
void	setSearchService(SearchService searchService)
void	setSelectedCatalogVersions(java.util.List<CatalogVersionModel> catalogVersions)
void	setSendEventsImmediately(boolean immediately)
boolean	setSessionAttribute(java.lang.String key, java.lang.Object value)
void	setSessionService(SessionService sessionService)
void	setSystemService(SystemService systemService)
void	setUiAccessRightService(UIAccessRightService accessRightService)
void	setUiConfigurationService(UIConfigurationService configurationService)
void	setUndoManager(UndoManager undoManager)
void	setUser(UserModel currentUser)	Changes the current session user.
void	setUserByUID(java.lang.String uid)	Changes the current session user.
void	setUsingTestIDs(boolean value)	Deprecated. since 6.3, this property should be set in 'local.properties'.
void	setValueHandlerRegistry(ObjectValueHandlerRegistry objectValueRegistry)
protected void	updateRestrictedPerspectives()

Methods inherited from class java.lang.Object

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

Constructor Detail

UISessionImpl

public UISessionImpl()

Method Detail

getSelectedCatalogVersions

public java.util.List<CatalogVersionModel> getSelectedCatalogVersions()

Specified by:

getSelectedCatalogVersions in interface UISession

setSelectedCatalogVersions

public void setSelectedCatalogVersions(java.util.List<CatalogVersionModel> catalogVersions)

Specified by:

setSelectedCatalogVersions in interface UISession

getAvailablePerspectives

public java.util.List<UICockpitPerspective> getAvailablePerspectives()

Description copied from interface: UISession

Returns all available perspectives.

Specified by:

getAvailablePerspectives in interface UISession

setAvailablePerspectives

public void setAvailablePerspectives(java.util.List<UICockpitPerspective> availablePerspectives)

setSendEventsImmediately

public void setSendEventsImmediately(boolean immediately)

updateRestrictedPerspectives

protected void updateRestrictedPerspectives()

registerPerspectiveContainer

public void registerPerspectiveContainer(org.zkoss.zk.ui.Component comp)

getCurrentPerspective

public UICockpitPerspective getCurrentPerspective()

Description copied from interface: UISession

Returns the current product cockpit perspective bean.

Specified by:

getCurrentPerspective in interface UISession

setCurrentPerspective

public void setCurrentPerspective(UICockpitPerspective perspective)

Description copied from interface: UISession

Changes the current product perspective bean. Accepts one out of UISession.getAvailablePerspectives(). Triggers UISessionListener.perspectiveChanged(UICockpitPerspective, UICockpitPerspective).

Specified by:

setCurrentPerspective in interface UISession

Parameters:

perspective - the new perspective bean

setCurrentPerspective

public void setCurrentPerspective(UICockpitPerspective perspective,
                                  java.util.Map<java.lang.String,? extends java.lang.Object> params)

Specified by:

setCurrentPerspective in interface UISession

firePerspectiveChanged

protected void firePerspectiveChanged(UICockpitPerspective old)

getListeners

protected java.util.List<UISessionListener> getListeners(boolean create)

setInitialSessionListeners

public void setInitialSessionListeners(java.util.Collection<UISessionListener> listeners)

addSessionListener

public void addSessionListener(UISessionListener listener)

Description copied from interface: UISession

Adds a session listener.

Specified by:

addSessionListener in interface UISession

Parameters:

listener - the new listener

removeSessionListener

public void removeSessionListener(UISessionListener listener)

Description copied from interface: UISession

Removes session listener.

Specified by:

removeSessionListener in interface UISession

Parameters:

listener - the listener to remove

clearSessionListeners

public void clearSessionListeners()

fireAfterLogin

protected void fireAfterLogin()

fireBeforeLogout

protected void fireBeforeLogout()

fireDataLanguageChanged

protected void fireDataLanguageChanged()

getLanguageIso

public java.lang.String getLanguageIso()

Description copied from interface: UISession

Returns the isocode of the current session language. Use UISession.getLocale() instead, if you want the locale before creating your own locale object

Specified by:

getLanguageIso in interface UISession

Returns:

current language iso code.

getSupportedLanguageIsoCodes

public java.util.Set<java.lang.String> getSupportedLanguageIsoCodes()

getUser

public UserModel getUser()

Description copied from interface: UISession

Returns the current ui session user.

Specified by:

getUser in interface UISession

setUser

public void setUser(UserModel currentUser)

Description copied from interface: UISession

Changes the current session user.

Specified by:

setUser in interface UISession

Parameters:

currentUser - the new session user

setUserByUID

public void setUserByUID(java.lang.String uid)

Description copied from interface: UISession

Changes the current session user. This method accepts a user id and fetches the user object automatically.

Specified by:

setUserByUID in interface UISession

login

public void login(UserModel user)

Description copied from interface: UISession

Assigns specified user to this session.

Specified by:

login in interface UISession

logout

public void logout()

Specified by:

logout in interface UISession

getSystemService

public SystemService getSystemService()

Specified by:

getSystemService in interface UISession

setSystemService

public void setSystemService(SystemService systemService)

setNewItemService

public void setNewItemService(NewItemService newItemService)

getNewItemService

public NewItemService getNewItemService()

Specified by:

getNewItemService in interface UISession

setCockpitTypeService

public void setCockpitTypeService(TypeService cockpitTypeService)

Parameters:

cockpitTypeService - the cockpitTypeService to set

setValueHandlerRegistry

public void setValueHandlerRegistry(ObjectValueHandlerRegistry objectValueRegistry)

setLabelService

public void setLabelService(LabelService labelService)

getLabelService

public LabelService getLabelService()

Specified by:

getLabelService in interface UISession

setSessionService

public void setSessionService(SessionService sessionService)

getValueHandlerRegistry

public ObjectValueHandlerRegistry getValueHandlerRegistry()

Specified by:

getValueHandlerRegistry in interface UISession

setGlobalDataLanguageIso

public void setGlobalDataLanguageIso(java.lang.String globalDataLanguageIso)

Specified by:

setGlobalDataLanguageIso in interface UISession

getGlobalDataLanguageIso

public java.lang.String getGlobalDataLanguageIso()

Description copied from interface: UISession

Returns the isocode of the current data language. Use UISession.getGlobalDataLocale() instead, if you want the locale before creating your own locale object

Specified by:

getGlobalDataLanguageIso in interface UISession

Returns:

current data language iso code.

getSearchService

public SearchService getSearchService()

Specified by:

getSearchService in interface UISession

setSearchService

public void setSearchService(SearchService searchService)

getSavedQueryService

public SavedQueryService getSavedQueryService()

Specified by:

getSavedQueryService in interface UISession

setSavedQueryService

public void setSavedQueryService(SavedQueryService savedQueryService)

getUndoManager

public UndoManager getUndoManager()

Specified by:

getUndoManager in interface UISession

setUndoManager

public void setUndoManager(UndoManager undoManager)

sendGlobalEvent

public void sendGlobalEvent(CockpitEvent event,
                            boolean immediate)

Description copied from interface: UISession

Processes given event. It will be dispatched to the current perspective.

Specified by:

sendGlobalEvent in interface UISession

Parameters:

event - the event to be processed

immediate - force to send event immediately (not "on later")

sendGlobalEvent

public void sendGlobalEvent(CockpitEvent event)

Description copied from interface: UISession

Processes given event. It will be dispatched to the current perspective.

Specified by:

sendGlobalEvent in interface UISession

Parameters:

event - the event to be processed

initSession

public void initSession()

registerAdditionalPerspectives

public void registerAdditionalPerspectives()

registers additional perspectives

createIdGenerator

protected org.zkoss.zk.ui.sys.IdGenerator createIdGenerator()

isUsingTestIDs

public boolean isUsingTestIDs()

Specified by:

isUsingTestIDs in interface UISession

setUsingTestIDs

@Deprecated
public void setUsingTestIDs(boolean value)

Deprecated.

since 6.3, this property should be set in 'local.properties'.

getPerspective

public UICockpitPerspective getPerspective(java.lang.String uid)
                                    throws java.lang.IllegalArgumentException

Specified by:

getPerspective in interface UISession

Throws:

java.lang.IllegalArgumentException

setModelService

public void setModelService(ModelService modelService)

getModelService

public ModelService getModelService()

Specified by:

getModelService in interface UISession

isPerspectiveAvailable

public boolean isPerspectiveAvailable(java.lang.String uid)

Specified by:

isPerspectiveAvailable in interface UISession

getRequestHandler

public RequestHandler getRequestHandler()

Specified by:

getRequestHandler in interface UISession

setRequestHandler

public void setRequestHandler(RequestHandler reqHandler)

Specified by:

setRequestHandler in interface UISession

getPushContainers

public java.util.List<PushCreationContainer> getPushContainers()

Specified by:

getPushContainers in interface UISession

setPushContainers

public void setPushContainers(java.util.List<PushCreationContainer> pushContainers)

Specified by:

setPushContainers in interface UISession

setDragOverPerspectivesEnabled

public void setDragOverPerspectivesEnabled(boolean dragOverPerspEnabled)

isDragOverPerspectivesEnabled

public boolean isDragOverPerspectivesEnabled()

Specified by:

isDragOverPerspectivesEnabled in interface UISession

setCachePerspectivesEnabled

public void setCachePerspectivesEnabled(boolean cachePerspectivesEnabled)

isCachePerspectivesEnabled

public boolean isCachePerspectivesEnabled()

Specified by:

isCachePerspectivesEnabled in interface UISession

setUiConfigurationService

public void setUiConfigurationService(UIConfigurationService configurationService)

getUiConfigurationService

public UIConfigurationService getUiConfigurationService()

Specified by:

getUiConfigurationService in interface UISession

setUiAccessRightService

public void setUiAccessRightService(UIAccessRightService accessRightService)

getUiAccessRightService

public UIAccessRightService getUiAccessRightService()

Specified by:

getUiAccessRightService in interface UISession

setSessionAttribute

public boolean setSessionAttribute(java.lang.String key,
                                   java.lang.Object value)

Specified by:

setSessionAttribute in interface UISession

getGlobalDataLocale

public java.util.Locale getGlobalDataLocale()

Specified by:

getGlobalDataLocale in interface UISession

Returns:

the locale for the currently selected data language

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface UISession

Returns:

The locale for the currently selected language

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

setLocalizationService

public void setLocalizationService(LocalizationService localizationService)

getLocalizationService

public LocalizationService getLocalizationService()

setJasperReportsRefresh

public void setJasperReportsRefresh(JasperReportsRefresh jasperReportsRefresh)

getJasperReportsRefresh

public JasperReportsRefresh getJasperReportsRefresh()

Description copied from interface: UISession

Returns service, which handles all page refresh requirements. Currently used for Jasper reports only

Specified by:

getJasperReportsRefresh in interface UISession

getTypeService

public TypeService getTypeService()

Specified by:

getTypeService in interface UISession

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext appCtx)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException