com.hybris.cockpitng.util

Interface CockpitSessionService

All Known Implementing Classes:

DefaultCockpitSessionService

public interface CockpitSessionService

Provides access to the current cockpit session lifecycle and attributes.

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String string) Gets attribute for the given key
default Map<String,WidgetInstance>	getWidgetInstanceMap() Gets widget instance map from the session
void	logout() Performs necessary steps to logout the current user.
void	removeAttribute(String string) Removes the session attribute for the given key, if existing.
void	setAttribute(String string, Object value) Sets the session attribute for the given key to the specified value.
default void	setWidgetInstanceMap(Map<String,WidgetInstance> ret) Puts widget instance map to the session

Method Detail

getAttribute

Object getAttribute(String string)

Gets attribute for the given key

Parameters:

string - key from which to retrieve the attribute

Returns:

the session attribute for the given key or null, if none existing.

removeAttribute

void removeAttribute(String string)

Removes the session attribute for the given key, if existing.

Parameters:

string - key from which to remove the attribute

setAttribute

void setAttribute(String string,
                  Object value)

Sets the session attribute for the given key to the specified value.

Parameters:

string - key from which to set value

value - to store

logout

void logout()

Performs necessary steps to logout the current user.

getWidgetInstanceMap

default Map<String,WidgetInstance> getWidgetInstanceMap()

Gets widget instance map from the session

Returns:

map

setWidgetInstanceMap

default void setWidgetInstanceMap(Map<String,WidgetInstance> ret)

Puts widget instance map to the session

Parameters:

ret - map