de.hybris.platform.hmc

Class HMCMasterServlet

java.lang.Object

HttpServlet

de.hybris.platform.hmc.webchips.MasterServlet

de.hybris.platform.hmc.HMCMasterServlet

public class HMCMasterServlet
extends MasterServlet

HMC specific subclass of MasterServlet.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CHIP_PREFIX
static String	MASTERSERVLET

Fields inherited from class de.hybris.platform.hmc.webchips.MasterServlet

ALREADYINITIALIZE, EVENT_TRANSLATION_FOOTER, EVENT_TRANSLATION_HEADER, firstContact, LOG_TOPIC, MONITOR, PRGREQUEST, PRGREQUESTPAIR, requestCount, STARTUP_MAX_USERS, STARTUP_WAIT_TIME, STATE, step, UPTODATE_CHECK, WINDOW_ID

Constructor Summary

Constructors

Constructor and Description
HMCMasterServlet()

Method Summary

Modifier and Type	Method and Description
static Set<Language>	getAllDialogLanguages() Deprecated. since 3.0u1 use HMCManager.getAllDialogLanguages() instead
static Set<Language>	getAllLanguages() Deprecated. use HMCManager.getAllLanguages()
static Set<Language>	getAllReadableLanguages() Deprecated. since 3.0u1 use HMCManager.getAllReadableLanguages() instead
static Set<Language>	getAllWritableLanguages() Deprecated. since 3.0u1 use HMCManager.getAllWritableLanguages() instead
protected String	getChipPrefix()
protected void	initializeCustomProcessEnd(HttpServletRequest request, HttpServletResponse response) callback methods that is executed just before the process method returns.
protected boolean	initializeCustomProcessStart(HttpServletRequest request, HttpServletResponse response) callback methods that is executed just after the process method starts.
protected void	initializeCustomProperties(JaloSession jaloSession, HttpServletRequest request) The implementation of this method is called right after the JaloSession is created.
protected void	processException(HttpServletRequest request, HttpServletResponse response, Exception exception) callback methods that is executed if an exception occurs in the MasterServlet.
static void	setAllDialogLanguages(Set<Language> languages) Deprecated. since 3.0u1 will have no effect anymore
static void	setAllReadableLanguages(Set<Language> languages) Deprecated. since 3.0u1 will have no effect anymore
static void	setAllWritableLanguages(Set<Language> languages) Deprecated. since 3.0u1 will have no effect anymore

Methods inherited from class de.hybris.platform.hmc.webchips.MasterServlet

createDisplayState, doGet, doPost, flush, getChipSuffix, getDefaultAttributes, getJaloSession, getNextCounterValue, getSessionDisplayState, getWindowIdFromRequest, initializeRequest, initializeResponse, isValidWindowId, print, print, println, setResponseHeader

Methods inherited from class java.lang.Object

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

Field Detail

MASTERSERVLET

public static final String MASTERSERVLET

See Also:

Constant Field Values

CHIP_PREFIX

protected static final String CHIP_PREFIX

See Also:

Constant Field Values

Constructor Detail

HMCMasterServlet

public HMCMasterServlet()

Method Detail

initializeCustomProperties

protected void initializeCustomProperties(JaloSession jaloSession,
                                          HttpServletRequest request)

Description copied from class: MasterServlet

The implementation of this method is called right after the JaloSession is created. Use it to set custom properties like the default language or staging.

Overrides:

initializeCustomProperties in class MasterServlet

initializeCustomProcessStart

protected boolean initializeCustomProcessStart(HttpServletRequest request,
                                               HttpServletResponse response)
                                        throws IOException

Description copied from class: MasterServlet

callback methods that is executed just after the process method starts.

return false if you want to stop the request

Overrides:

initializeCustomProcessStart in class MasterServlet

Throws:

IOException

initializeCustomProcessEnd

protected void initializeCustomProcessEnd(HttpServletRequest request,
                                          HttpServletResponse response)

Description copied from class: MasterServlet

callback methods that is executed just before the process method returns. it is even executed if there was an error/exception

Overrides:

initializeCustomProcessEnd in class MasterServlet

getChipPrefix

protected String getChipPrefix()

Overrides:

getChipPrefix in class MasterServlet

processException

protected void processException(HttpServletRequest request,
                                HttpServletResponse response,
                                Exception exception)

Description copied from class: MasterServlet

callback methods that is executed if an exception occurs in the MasterServlet.

Overrides:

processException in class MasterServlet

getAllLanguages

@Deprecated
public static Set<Language> getAllLanguages()

Deprecated. use HMCManager.getAllLanguages()

Returns all existing Language objects for the given JaloSession.

Returns:

a Set containing all existing Language objects for the given JaloSession.

getAllDialogLanguages

@Deprecated
public static Set<Language> getAllDialogLanguages()

Deprecated. since 3.0u1 use HMCManager.getAllDialogLanguages() instead

Returns a Set containing all dialog (language for naming and so) languages for the current user. Is composed out of all readable languages but without user profile restrictions. Note: This set will be cached and rebuild

Returns:

a Set containing all 'dialog languages' for the current user.

setAllDialogLanguages

@Deprecated
public static void setAllDialogLanguages(Set<Language> languages)

Deprecated. since 3.0u1 will have no effect anymore

Parameters:

languages - The language to set.

getAllWritableLanguages

@Deprecated
public static Set<Language> getAllWritableLanguages()

Deprecated. since 3.0u1 use HMCManager.getAllWritableLanguages() instead

Returns a Set containing all 'writable languages' for the current user. All groups which the user is a member of will be searched for a property called 'writablelanguages' (which should contain Collections of Languages) and if such properties exist, all contained languages are returned.
Note: This set will be cached and rebuild

Returns:

a Set containing all 'writable languages' for the current user.

setAllWritableLanguages

@Deprecated
public static void setAllWritableLanguages(Set<Language> languages)

Deprecated. since 3.0u1 will have no effect anymore

Parameters:

languages - The language to set.

getAllReadableLanguages

@Deprecated
public static Set<Language> getAllReadableLanguages()

Deprecated. since 3.0u1 use HMCManager.getAllReadableLanguages() instead

Returns a Set containing all 'readable languages' for the current user. All groups which the user is a member of will be searched for a property called 'readablelanguages' (which should contain Collections of Languages) and if such properties exist, all contained languages are returned.
Note: This set will be cached and rebuild

Returns:

a Set containing all 'readable languages' for the current user.

setAllReadableLanguages

@Deprecated
public static void setAllReadableLanguages(Set<Language> languages)

Deprecated. since 3.0u1 will have no effect anymore

Parameters:

languages - The language to set.