com.vaadin.server
Class BootstrapHandler

java.lang.Object
  com.vaadin.server.SynchronizedRequestHandler
      com.vaadin.server.BootstrapHandler

All Implemented Interfaces:

RequestHandler, java.io.Serializable

Direct Known Subclasses:

PortletBootstrapHandler, ServletBootstrapHandler

Deprecated. As of 7.0. Will likely change or be removed in a future version

@Deprecated
public abstract class BootstrapHandler
extends SynchronizedRequestHandler

Since:

7.0.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

protected class

BootstrapHandler.BootstrapContext Deprecated.

Field Summary

static java.lang.String

IGNORE_RESTART_PARAM Deprecated. Parameter that is added to the UI init request if the session has already been restarted when generating the bootstrap HTML and ?restartApplication should thus be ignored when handling the UI init request.

Constructor Summary

BootstrapHandler()
Deprecated.

Method Summary

protected void	appendMainScriptTagContents(BootstrapHandler.BootstrapContext context, java.lang.StringBuilder builder) Deprecated.
protected boolean	canHandleRequest(VaadinRequest request) Deprecated. Check whether a request may be handled by this handler.
java.lang.String	findAndEscapeThemeName(BootstrapHandler.BootstrapContext context) Deprecated. Don not override.
protected org.json.JSONObject	getApplicationParameters(BootstrapHandler.BootstrapContext context) Deprecated.
protected java.lang.String	getMainDivStyle(BootstrapHandler.BootstrapContext context) Deprecated.
protected abstract java.lang.String	getServiceUrl(BootstrapHandler.BootstrapContext context) Deprecated.
java.lang.String	getThemeName(BootstrapHandler.BootstrapContext context) Deprecated. Override if required
java.lang.String	getThemeUri(BootstrapHandler.BootstrapContext context, java.lang.String themeName) Deprecated. Get the URI for the application theme.
java.lang.String	getWidgetsetForUI(BootstrapHandler.BootstrapContext context) Deprecated.
boolean	synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response) Deprecated. Identical to SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse) except the VaadinSession is locked before this is called and unlocked after this has completed.
protected void	writeError(VaadinResponse response, java.lang.Throwable e) Deprecated.

Methods inherited from class com.vaadin.server.SynchronizedRequestHandler

handleRequest

Methods inherited from class java.lang.Object

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

Field Detail

IGNORE_RESTART_PARAM

public static final java.lang.String IGNORE_RESTART_PARAM

Deprecated.

Parameter that is added to the UI init request if the session has already been restarted when generating the bootstrap HTML and ?restartApplication should thus be ignored when handling the UI init request.

See Also:

Constant Field Values

Constructor Detail

BootstrapHandler

public BootstrapHandler()

Deprecated.

Method Detail

canHandleRequest

protected boolean canHandleRequest(VaadinRequest request)

Deprecated.

Description copied from class: SynchronizedRequestHandler

Check whether a request may be handled by this handler. This can be used as an optimization to avoid locking the session just to investigate some method property. The default implementation just returns true which means that all requests will be handled by calling SynchronizedRequestHandler.synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) with the session locked.

Overrides:

canHandleRequest in class SynchronizedRequestHandler

Parameters:

request - the request to handle

Returns:

true if the request handling should continue once the session has been locked; false if there's no need to lock the session since the request would still not be handled.

synchronizedHandleRequest

public boolean synchronizedHandleRequest(VaadinSession session,
                                         VaadinRequest request,
                                         VaadinResponse response)
                                  throws java.io.IOException

Deprecated.

Description copied from class: SynchronizedRequestHandler

Identical to SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse) except the VaadinSession is locked before this is called and unlocked after this has completed.

Specified by:

synchronizedHandleRequest in class SynchronizedRequestHandler

Parameters:

session - The session for the request

request - The request to handle

response - The response object to which a response can be written.

Returns:

true if a response has been written and no further request handlers should be called, otherwise false

Throws:

java.io.IOException - If an IO error occurred

See Also:

SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse)

getMainDivStyle

protected java.lang.String getMainDivStyle(BootstrapHandler.BootstrapContext context)

Deprecated.

getWidgetsetForUI

public java.lang.String getWidgetsetForUI(BootstrapHandler.BootstrapContext context)

Deprecated.

appendMainScriptTagContents

protected void appendMainScriptTagContents(BootstrapHandler.BootstrapContext context,
                                           java.lang.StringBuilder builder)
                                    throws org.json.JSONException,
                                           java.io.IOException

Deprecated.

Throws:

org.json.JSONException

java.io.IOException

getApplicationParameters

protected org.json.JSONObject getApplicationParameters(BootstrapHandler.BootstrapContext context)
                                                throws org.json.JSONException,
                                                       PaintException

Deprecated.

Throws:

org.json.JSONException

PaintException

getServiceUrl

protected abstract java.lang.String getServiceUrl(BootstrapHandler.BootstrapContext context)

Deprecated.

getThemeUri

public java.lang.String getThemeUri(BootstrapHandler.BootstrapContext context,
                                    java.lang.String themeName)

Deprecated.

Get the URI for the application theme. A portal-wide default theme is fetched from the portal shared resource directory (if any), other themes from the portlet.

Parameters:

context -

themeName -

Returns:

getThemeName

public java.lang.String getThemeName(BootstrapHandler.BootstrapContext context)

Deprecated.

Override if required

Parameters:

context -

Returns:

findAndEscapeThemeName

public java.lang.String findAndEscapeThemeName(BootstrapHandler.BootstrapContext context)

Deprecated.

Don not override.

Parameters:

context -

Returns:

writeError

protected void writeError(VaadinResponse response,
                          java.lang.Throwable e)
                   throws java.io.IOException

Deprecated.

Throws:

java.io.IOException