de.hybris.platform.print.comet

Class DefaultSessionManager

java.lang.Object

de.hybris.platform.print.comet.DefaultSessionManager

All Implemented Interfaces:

SessionManager

public class DefaultSessionManager
extends Object
implements SessionManager

Handles the Werk II Comet Sessions as well as the respective active publication item and the related CometConfiguration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LANGUAGES

Constructor Summary

Constructors

Constructor and Description
DefaultSessionManager()

Method Summary

Modifier and Type	Method and Description
void	activateSession(String sessionId) (Re)activates an existing session
protected void	clearSessionInfo()
void	deactivateSession() Deactivates the current session.
CometConfiguration	getCometConfiguration() Returns the CometConfiguration
String	getImagePath(String imageName)
MediaContext	getMediaContext() Returns the active MediaContext.
OS	getOperatingSystem()
PrintPublication	getPublication() Returns the publication that is currently used in the Comet.
PublicationController	getPublicationController()
LoginResult	login(String login, String passwd, String client, String language) Logs in a Werk II Comet session
LogoutResult	logout(String sessionId) Logs out a Werk II Comet session
void	setCometConfiguration(CometConfiguration config) Sets the active CometConfiguration that should be used.
void	setCometConfiguration(String configCode) Sets the active CometConfiguration that should be used.
SetLanguageResult	setLanguage(String sessionId, String language) Sets the language for the current Werk II Comet session
void	setLocalSessionContext(Language language) Sets the local SessionContext which will be used to retrieve and store values via Placeholders.
void	setMediaContext(MediaContext context) Sets the active MediaContext that should be used.
void	setOperatingSystem(OS os)
void	setPublication(PrintPublication publication) Sets the publication that should be used by Comet in the current session.
void	setPublication(String id) Sets the publication that should be used by Comet in the current session.
void	setSessionLanguage(SessionContext ctx, String isoCode) Set the language for the given session context
void	unsetLocalSessionContext() Removes the local SessionContext set by setLocalSessionContext and also sets the old SessionUser.

Methods inherited from class java.lang.Object

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

Field Detail

LANGUAGES

public static final String LANGUAGES

See Also:

Constant Field Values

Constructor Detail

DefaultSessionManager

public DefaultSessionManager()

Method Detail

login

public LoginResult login(String login,
                         String passwd,
                         String client,
                         String language)

Description copied from interface: SessionManager

Logs in a Werk II Comet session

Specified by:

login in interface SessionManager

Parameters:

login - The user name for which to do the login

passwd - The user's password

client - The client that should be used in the new session

language - The language that should be used in the new session

Returns:

A LoginResult

logout

public LogoutResult logout(String sessionId)

Description copied from interface: SessionManager

Logs out a Werk II Comet session

Specified by:

logout in interface SessionManager

Parameters:

sessionId - The session ID that shall be closed

Returns:

A LogoutResult

setLanguage

public SetLanguageResult setLanguage(String sessionId,
                                     String language)

Description copied from interface: SessionManager

Sets the language for the current Werk II Comet session

Specified by:

setLanguage in interface SessionManager

Parameters:

sessionId - The session ID for which to change the language

language - The ISO code of the language to use

Returns:

A SetLanguageResult

setSessionLanguage

public void setSessionLanguage(SessionContext ctx,
                               String isoCode)

Description copied from interface: SessionManager

Set the language for the given session context

Specified by:

setSessionLanguage in interface SessionManager

Parameters:

ctx - The SessionContext in which to change the language

isoCode - The ISO code of the language to use

activateSession

public void activateSession(String sessionId)
                     throws SessionClosedException

Description copied from interface: SessionManager

(Re)activates an existing session

Specified by:

activateSession in interface SessionManager

Parameters:

sessionId - The ID of the session that shall be activated

Throws:

SessionClosedException - If the session does not exist

deactivateSession

public void deactivateSession()

Description copied from interface: SessionManager

Deactivates the current session.

Specified by:

deactivateSession in interface SessionManager

setPublication

public void setPublication(PrintPublication publication)

Description copied from interface: SessionManager

Sets the publication that should be used by Comet in the current session.

Specified by:

setPublication in interface SessionManager

Parameters:

publication - the Publication which should be used in this session

setPublication

public void setPublication(String id)

Description copied from interface: SessionManager

Sets the publication that should be used by Comet in the current session.

Specified by:

setPublication in interface SessionManager

Parameters:

id - id of the publication to be set

getPublication

public PrintPublication getPublication()

Description copied from interface: SessionManager

Returns the publication that is currently used in the Comet.

Specified by:

getPublication in interface SessionManager

Returns:

the publication that is currently used in the Comet

getCometConfiguration

public CometConfiguration getCometConfiguration()

Description copied from interface: SessionManager

Returns the CometConfiguration

Specified by:

getCometConfiguration in interface SessionManager

Returns:

the current CometConfiguration

clearSessionInfo

protected void clearSessionInfo()

setCometConfiguration

public void setCometConfiguration(CometConfiguration config)

Description copied from interface: SessionManager

Sets the active CometConfiguration that should be used. If the active publication is using another CometConfiguration, the active publication is set to null

Specified by:

setCometConfiguration in interface SessionManager

Parameters:

config - The CometConfiguration which should be used

setCometConfiguration

public void setCometConfiguration(String configCode)

Description copied from interface: SessionManager

Sets the active CometConfiguration that should be used. If the active publication is using another CometConfiguration, the active publication is set to null

Specified by:

setCometConfiguration in interface SessionManager

Parameters:

configCode - The code of the CometConfiguration which should be used

getMediaContext

public MediaContext getMediaContext()

Description copied from interface: SessionManager

Returns the active MediaContext.

Specified by:

getMediaContext in interface SessionManager

Returns:

The active MediaContext.

setMediaContext

public void setMediaContext(MediaContext context)

Description copied from interface: SessionManager

Sets the active MediaContext that should be used.

Specified by:

setMediaContext in interface SessionManager

Parameters:

context - The media context which should be used

setLocalSessionContext

public void setLocalSessionContext(Language language)

Sets the local SessionContext which will be used to retrieve and store values via Placeholders. This method is called at the begin of these methods

• Placeholder.getValue(Placement, SessionContext)
• Placeholder.getValue(Item, SessionContext)

Sets the following SessionContext attributes

• user
• currency
• language fallback by setting setAttribute(LocalizableItem.LANGUAGE_FALLBACK_ENABLED, Boolean.TRUE)

Specified by:

setLocalSessionContext in interface SessionManager

Parameters:

language - Language which should be used, can be null if the current session language should not be changed

unsetLocalSessionContext

public void unsetLocalSessionContext()

Removes the local SessionContext set by setLocalSessionContext and also sets the old SessionUser. This method is called in a finally block at the end of these methods

• Placeholder.getValue(Placement, SessionContext)
• Placeholder.getValue(Item, SessionContext)

Specified by:

unsetLocalSessionContext in interface SessionManager

getPublicationController

public PublicationController getPublicationController()

Specified by:

getPublicationController in interface SessionManager

See Also:

SessionManager.getPublicationController()

getOperatingSystem

public OS getOperatingSystem()

Specified by:

getOperatingSystem in interface SessionManager

setOperatingSystem

public void setOperatingSystem(OS os)

Specified by:

setOperatingSystem in interface SessionManager

getImagePath

public String getImagePath(String imageName)

Specified by:

getImagePath in interface SessionManager