de.hybris.platform.print.comet

Interface SessionManager

All Known Implementing Classes:

DefaultSessionManager

public interface SessionManager

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

Method Summary

Modifier and Type	Method and Description
void	activateSession(String sessionId) (Re)activates an existing session
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.

Method Detail

login

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

Logs in a Werk II Comet session

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

LogoutResult logout(String sessionId)

Logs out a Werk II Comet session

Parameters:

sessionId - The session ID that shall be closed

Returns:

A LogoutResult

setLanguage

SetLanguageResult setLanguage(String sessionId,
                              String language)

Sets the language for the current Werk II Comet session

Parameters:

sessionId - The session ID for which to change the language

language - The ISO code of the language to use

Returns:

A SetLanguageResult

setSessionLanguage

void setSessionLanguage(SessionContext ctx,
                        String isoCode)

Set the language for the given session context

Parameters:

ctx - The SessionContext in which to change the language

isoCode - The ISO code of the language to use

activateSession

void activateSession(String sessionId)
              throws SessionClosedException

(Re)activates an existing session

Parameters:

sessionId - The ID of the session that shall be activated

Throws:

SessionClosedException - If the session does not exist

deactivateSession

void deactivateSession()

Deactivates the current session.

setPublication

void setPublication(String id)

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

Parameters:

id - id of the publication to be set

setPublication

void setPublication(PrintPublication publication)

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

Parameters:

publication - the Publication which should be used in this session

getPublication

PrintPublication getPublication()

Returns the publication that is currently used in the Comet.

Returns:

the publication that is currently used in the Comet

getCometConfiguration

CometConfiguration getCometConfiguration()

Returns the CometConfiguration

Returns:

the current CometConfiguration

setCometConfiguration

void setCometConfiguration(String configCode)

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

Parameters:

configCode - The code of the CometConfiguration which should be used

setCometConfiguration

void setCometConfiguration(CometConfiguration config)

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

Parameters:

config - The CometConfiguration which should be used

setMediaContext

void setMediaContext(MediaContext context)

Sets the active MediaContext that should be used.

Parameters:

context - The media context which should be used

getMediaContext

MediaContext getMediaContext()

Returns the active MediaContext.

Returns:

The active MediaContext.

setLocalSessionContext

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)

Parameters:

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

unsetLocalSessionContext

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)

getPublicationController

PublicationController getPublicationController()

getImagePath

String getImagePath(String imageName)

getOperatingSystem

OS getOperatingSystem()

setOperatingSystem

void setOperatingSystem(OS os)