Package de.hybris.platform.servicelayer.session.impl

Class DefaultSessionService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.session.impl.DefaultSessionService

All Implemented Interfaces:

SessionService, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

MockSessionService

public class DefaultSessionService
extends AbstractService
implements SessionService

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Nested classes/interfaces inherited from interface de.hybris.platform.servicelayer.session.SessionService

SessionService.SessionAttributeLoader<T>

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor	Description
DefaultSessionService()

Method Summary

Modifier and Type	Method	Description
void	closeCurrentSession()	Close the current Session
void	closeSession(Session session)	Closed the given Session
Session	createNewSession()	Creates a new Session.
Session	createSession()	Must be overwritten! Use <lookup-method> in spring.
Object	executeInLocalView(SessionExecutionBody body)	Executes the given SessionExecutionBody in a local SessionContext
Object	executeInLocalView(SessionExecutionBody body, UserModel model)	Executes the given SessionExecutionBody in a local SessionContext and sets session user to given UserModel.
<T> T	executeInLocalViewWithParams(Map<String,Object> localViewParameters, SessionExecutionBody body)	Executes the given SessionExecutionBody in a local SessionContext that is populated with parameters provided in the map.
<T> Map<String,T>	getAllAttributes()	shortcut to getCurrentSession().getAllAttributes().
<T> T	getAttribute(String name)	shortcut to getCurrentSession().getAttribute(String).
Session	getBoundSession(Object rawSession)	Returns service layer session bound to given JaloSession or creates new session (if no session is bound to given JaloSession) and returns it.
Session	getCurrentSession()
<T> T	getOrLoadAttribute(String name, SessionService.SessionAttributeLoader<T> loader)	Returns for the given name the content which is stored in the current Session or loads a new value atomically by calling the loader instance.
Object	getRawSession(Session session)	Returns JaloSession bound to given service layer session.
Session	getSession(String sessionID)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.5.1 session management was changed and this method always returns current session or null
boolean	hasCurrentSession()	Check if current session exists and neither closed nor inactive.
void	removeAttribute(String name)	Removes the given attribute from the current session.
void	setAttribute(String name, Object value)	shortcut to getCurrentSession().setAttribute(String,Object).
void	setModelService(ModelService modelService)

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultSessionService

public DefaultSessionService()

Method Details

getCurrentSession

public Session getCurrentSession()

Specified by:

getCurrentSession in interface SessionService

Returns:

the current Session

getSession

@Deprecated(since="5.5.1",
            forRemoval=true)
public Session getSession(String sessionID)

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.5.1 session management was changed and this method always returns current session or null

Description copied from interface: SessionService

Get Session by given id

Specified by:

getSession in interface SessionService

createNewSession

public Session createNewSession()

Description copied from interface: SessionService

Creates a new Session.

Specified by:

createNewSession in interface SessionService

executeInLocalView

public Object executeInLocalView(SessionExecutionBody body)

Description copied from interface: SessionService

Executes the given SessionExecutionBody in a local SessionContext

Specified by:

executeInLocalView in interface SessionService

executeInLocalViewWithParams

public <T> T executeInLocalViewWithParams(Map<String,Object> localViewParameters,
 SessionExecutionBody body)

Description copied from interface: SessionService

Executes the given SessionExecutionBody in a local SessionContext that is populated with parameters provided in the map.

Specified by:

executeInLocalViewWithParams in interface SessionService

Parameters:

localViewParameters - parameters that will be set in local view

body - callback to be invoked

Returns:

callback result

executeInLocalView

public Object executeInLocalView(SessionExecutionBody body,
 UserModel model)

Description copied from interface: SessionService

Executes the given SessionExecutionBody in a local SessionContext and sets session user to given UserModel.

Specified by:

executeInLocalView in interface SessionService

closeSession

public void closeSession(Session session)

Description copied from interface: SessionService

Closed the given Session

Specified by:

closeSession in interface SessionService

Parameters:

session - the session which will be closed

closeCurrentSession

public void closeCurrentSession()

Description copied from interface: SessionService

Close the current Session

Specified by:

closeCurrentSession in interface SessionService

setAttribute

public void setAttribute(String name,
 Object value)

shortcut to getCurrentSession().setAttribute(String,Object). this method is just a delegate to the Session object and it should not be overwritten.

Specified by:

setAttribute in interface SessionService

Parameters:

name - name of the attribute

value - the value to be set

removeAttribute

public void removeAttribute(String name)

Description copied from interface: SessionService

Removes the given attribute from the current session. Do nothing if the attribute doesn't exists in the session.

Specified by:

removeAttribute in interface SessionService

Parameters:

name - the attribute name

getAttribute

public <T> T getAttribute(String name)

shortcut to getCurrentSession().getAttribute(String). this method is just a delegate to the Session object and it should not be overwritten

Specified by:

getAttribute in interface SessionService

Parameters:

name - the attribute name

Returns:

null if such attribute don't exist in the current session.

getOrLoadAttribute

public <T> T getOrLoadAttribute(String name,
 SessionService.SessionAttributeLoader<T> loader)

Description copied from interface: SessionService

Returns for the given name the content which is stored in the current Session or loads a new value atomically by calling the loader instance.

Specified by:

getOrLoadAttribute in interface SessionService

getAllAttributes

public <T> Map<String,T> getAllAttributes()

shortcut to getCurrentSession().getAllAttributes(). this method is just a delegate to the Session object and it should not be overwritten

Specified by:

getAllAttributes in interface SessionService

Returns:

all attributes from the current Session as Map.

hasCurrentSession

public boolean hasCurrentSession()

Description copied from interface: SessionService

Check if current session exists and neither closed nor inactive. KAM-158: Replacement for JaloSession.hasCurrentSession()

Specified by:

hasCurrentSession in interface SessionService

setModelService

public void setModelService(ModelService modelService)

createSession

public Session createSession()

Must be overwritten! Use <lookup-method> in spring.

getBoundSession

public Session getBoundSession(Object rawSession)

Description copied from interface: SessionService

Returns service layer session bound to given JaloSession or creates new session (if no session is bound to given JaloSession) and returns it.

Specified by:

getBoundSession in interface SessionService

getRawSession

public Object getRawSession(Session session)

Description copied from interface: SessionService

Returns JaloSession bound to given service layer session.

Specified by:

getRawSession in interface SessionService