de.hybris.platform.hmc.webchips

Class MasterServlet

java.lang.Object

HttpServlet

de.hybris.platform.hmc.webchips.MasterServlet

Direct Known Subclasses:

HMCMasterServlet

public abstract class MasterServlet
extends HttpServlet

Processes all requests, manages states and helps testing. Subclasses of this have to be able to return a default Window and to provide l10n data.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALREADYINITIALIZE
static String	EVENT_TRANSLATION_FOOTER
static String	EVENT_TRANSLATION_HEADER
static long	firstContact
static String	LOG_TOPIC
static String	MONITOR
static String	PRGREQUEST
static String	PRGREQUESTPAIR
static long	requestCount
static int	STARTUP_MAX_USERS
static int	STARTUP_WAIT_TIME
static String	STATE
static int	step
static String	UPTODATE_CHECK
static String	WINDOW_ID

Constructor Summary

Constructors

Constructor and Description
MasterServlet()

Method Summary

Modifier and Type	Method and Description
protected DisplayState	createDisplayState(HttpServletRequest request, JaloSession jaloSession)
void	doGet(HttpServletRequest request, HttpServletResponse response)
void	doPost(HttpServletRequest request, HttpServletResponse response)
static void	flush(HttpServletResponse resp)
protected String	getChipPrefix()
protected String	getChipSuffix()
protected Map	getDefaultAttributes() Creates the default attributes for a new DisplayState/Session In subclasses you can use this to set specific attributes.
protected JaloSession	getJaloSession(HttpServletRequest request)
protected long	getNextCounterValue()
protected DisplayState	getSessionDisplayState(HttpServletRequest request, JaloSession jaloSession)
protected String	getWindowIdFromRequest(HttpServletRequest request)
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 HttpServletRequest	initializeRequest(HttpServletRequest request)
protected HttpServletResponse	initializeResponse(HttpServletResponse response, HttpServletRequest req)
protected boolean	isValidWindowId(String windowId)
static void	print(HttpServletResponse resp, byte[] byteArray)
static void	print(HttpServletResponse resp, String string)
static void	println(HttpServletResponse resp, String string)
protected void	processException(HttpServletRequest request, HttpServletResponse response, Exception exception) callback methods that is executed if an exception occurs in the MasterServlet.
protected void	setResponseHeader(HttpServletResponse response)

Methods inherited from class java.lang.Object

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

Field Detail

WINDOW_ID

public static final String WINDOW_ID

See Also:

Constant Field Values

STATE

public static final String STATE

See Also:

Constant Field Values

LOG_TOPIC

public static final String LOG_TOPIC

See Also:

Constant Field Values

UPTODATE_CHECK

public static final String UPTODATE_CHECK

See Also:

Constant Field Values

MONITOR

public static final String MONITOR

See Also:

Constant Field Values

PRGREQUEST

public static final String PRGREQUEST

See Also:

Constant Field Values

PRGREQUESTPAIR

public static final String PRGREQUESTPAIR

See Also:

Constant Field Values

EVENT_TRANSLATION_HEADER

public static final String EVENT_TRANSLATION_HEADER

See Also:

Constant Field Values

EVENT_TRANSLATION_FOOTER

public static final String EVENT_TRANSLATION_FOOTER

See Also:

Constant Field Values

ALREADYINITIALIZE

public static final String ALREADYINITIALIZE

See Also:

Constant Field Values

STARTUP_MAX_USERS

public static final int STARTUP_MAX_USERS

See Also:

Constant Field Values

STARTUP_WAIT_TIME

public static final int STARTUP_WAIT_TIME

See Also:

Constant Field Values

step

public static int step

requestCount

public static long requestCount

firstContact

public static long firstContact

Constructor Detail

MasterServlet

public MasterServlet()

Method Detail

getJaloSession

protected JaloSession getJaloSession(HttpServletRequest request)
                              throws JaloSystemNotInitializedException

Throws:

JaloSystemNotInitializedException

doPost

public final void doPost(HttpServletRequest request,
                         HttpServletResponse response)
                  throws ServletException,
                         IOException

Throws:

ServletException

IOException

doGet

public final void doGet(HttpServletRequest request,
                        HttpServletResponse response)
                 throws ServletException,
                        IOException

Throws:

ServletException

IOException

initializeRequest

protected HttpServletRequest initializeRequest(HttpServletRequest request)

initializeResponse

protected HttpServletResponse initializeResponse(HttpServletResponse response,
                                                 HttpServletRequest req)

setResponseHeader

protected void setResponseHeader(HttpServletResponse response)

getWindowIdFromRequest

protected String getWindowIdFromRequest(HttpServletRequest request)

getSessionDisplayState

protected DisplayState getSessionDisplayState(HttpServletRequest request,
                                              JaloSession jaloSession)

getDefaultAttributes

protected Map getDefaultAttributes()

Creates the default attributes for a new DisplayState/Session In subclasses you can use this to set specific attributes. Must not return null!

Returns:

an empty HashMap

initializeCustomProperties

protected void initializeCustomProperties(JaloSession jaloSession,
                                          HttpServletRequest request)

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.

initializeCustomProcessStart

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

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

return false if you want to stop the request

Throws:

IOException

initializeCustomProcessEnd

protected void initializeCustomProcessEnd(HttpServletRequest request,
                                          HttpServletResponse response)

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

processException

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

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

createDisplayState

protected DisplayState createDisplayState(HttpServletRequest request,
                                          JaloSession jaloSession)

isValidWindowId

protected boolean isValidWindowId(String windowId)

getChipPrefix

protected String getChipPrefix()

getChipSuffix

protected String getChipSuffix()

getNextCounterValue

protected long getNextCounterValue()

println

public static void println(HttpServletResponse resp,
                           String string)
                    throws IOException

Throws:

IOException

print

public static void print(HttpServletResponse resp,
                         String string)
                  throws IOException

Throws:

IOException

print

public static void print(HttpServletResponse resp,
                         byte[] byteArray)
                  throws IOException

Throws:

IOException

flush

public static void flush(HttpServletResponse resp)
                  throws IOException

Throws:

IOException