com.vaadin.server
Class VaadinPortlet

java.lang.Object
  javax.portlet.GenericPortlet
      com.vaadin.server.VaadinPortlet

All Implemented Interfaces:

Constants, javax.portlet.EventPortlet, javax.portlet.Portlet, javax.portlet.PortletConfig, javax.portlet.ResourceServingPortlet

Direct Known Subclasses:

LegacyVaadinPortlet

public class VaadinPortlet
extends javax.portlet.GenericPortlet
implements Constants

Portlet 2.0 base class. This replaces the servlet in servlet/portlet 1.0 deployments and handles various portlet requests from the browser. TODO Document me!

Author:

peholmst

Nested Class Summary

static class	VaadinPortlet.AbstractApplicationPortletWrapper
static class	VaadinPortlet.PortletService
class	VaadinPortlet.RequestError
protected static class	VaadinPortlet.RequestType Deprecated. might be refactored or removed before 7.0.0
static class	VaadinPortlet.WrappedGateinRequest
static class	VaadinPortlet.WrappedHttpAndPortletRequest
static class	VaadinPortlet.WrappedLiferayRequest

Field Summary

static java.lang.String	PORTAL_PARAMETER_VAADIN_THEME Deprecated. might be refactored or removed before 7.0.0
static java.lang.String	PORTLET_PARAMETER_STYLE Deprecated. might be refactored or removed before 7.0.0
static java.lang.String	RESOURCE_URL_ID Deprecated. might be refactored or removed before 7.0.0
static java.lang.String	WRITE_AJAX_PAGE_SCRIPT_WIDGETSET_SHOULD_WRITE Deprecated. might be refactored or removed before 7.0.0

Fields inherited from interface com.vaadin.server.Constants

DEFAULT_BUFFER_SIZE, DEFAULT_THEME_CACHETIME, DEFAULT_THEME_NAME, DEFAULT_WIDGETSET, ERROR_NO_UI_FOUND, INVALID_SECURITY_KEY_MSG, MAX_BUFFER_SIZE, NOT_PRODUCTION_MODE_INFO, PARAMETER_VAADIN_RESOURCES, PARAMETER_WIDGETSET, PORTAL_PARAMETER_VAADIN_RESOURCE_PATH, PORTAL_PARAMETER_VAADIN_WIDGETSET, SERVLET_PARAMETER_CLOSE_IDLE_UIS, SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION, SERVLET_PARAMETER_HEARTBEAT_RATE, SERVLET_PARAMETER_PRODUCTION_MODE, SERVLET_PARAMETER_RESOURCE_CACHE_TIME, THEME_DIRECTORY_PATH, URL_PARAMETER_CLOSE_APPLICATION, URL_PARAMETER_REPAINT_ALL, URL_PARAMETER_RESTART_APPLICATION, URL_PARAMETER_THEME, WARNING_HEARTBEAT_INTERVAL_NOT_NUMERIC, WARNING_RESOURCE_CACHING_TIME_NOT_NUMERIC, WARNING_XSRF_PROTECTION_DISABLED, WIDGETSET_DIRECTORY_PATH, WIDGETSET_MISMATCH_INFO

Constructor Summary

VaadinPortlet()

Method Summary

protected DeploymentConfiguration	createDeploymentConfiguration(java.util.Properties initParameters)
protected VaadinPortlet.PortletService	createPortletService(DeploymentConfiguration deploymentConfiguration)
protected WrappedPortletRequest	createWrappedRequest(javax.portlet.PortletRequest request) Wraps the request in a (possibly portal specific) wrapped portlet request.
void	destroy()
protected void	doDispatch(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
protected VaadinPortlet.RequestType	getRequestType(WrappedPortletRequest wrappedRequest) Deprecated. might be refactored or removed before 7.0.0
protected VaadinPortlet.PortletService	getVaadinService()
protected void	handleRequest(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response) Deprecated. might be refactored or removed before 7.0.0
void	init(javax.portlet.PortletConfig config)
protected void	onVaadinSessionStarted(WrappedPortletRequest request, VaadinPortletSession session)
void	processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
void	processEvent(javax.portlet.EventRequest request, javax.portlet.EventResponse response)
void	serveResource(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response)

Methods inherited from class javax.portlet.GenericPortlet

doEdit, doHeaders, doHelp, doView, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, getTitle, init, render

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_URL_ID

@Deprecated
public static final java.lang.String RESOURCE_URL_ID

Deprecated. might be refactored or removed before 7.0.0

See Also:

Constant Field Values

PORTLET_PARAMETER_STYLE

@Deprecated
public static final java.lang.String PORTLET_PARAMETER_STYLE

Deprecated. might be refactored or removed before 7.0.0

This portlet parameter is used to add styles to the main element. E.g "height:500px" generates a style="height:500px" to the main element.

See Also:

Constant Field Values

PORTAL_PARAMETER_VAADIN_THEME

@Deprecated
public static final java.lang.String PORTAL_PARAMETER_VAADIN_THEME

Deprecated. might be refactored or removed before 7.0.0

This portal parameter is used to define the name of the Vaadin theme that is used for all Vaadin applications in the portal.

See Also:

Constant Field Values

WRITE_AJAX_PAGE_SCRIPT_WIDGETSET_SHOULD_WRITE

@Deprecated
public static final java.lang.String WRITE_AJAX_PAGE_SCRIPT_WIDGETSET_SHOULD_WRITE

Deprecated. might be refactored or removed before 7.0.0

See Also:

Constant Field Values

Constructor Detail

VaadinPortlet

public VaadinPortlet()

Method Detail

init

public void init(javax.portlet.PortletConfig config)
          throws javax.portlet.PortletException

Specified by:

init in interface javax.portlet.Portlet

Overrides:

init in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

createDeploymentConfiguration

protected DeploymentConfiguration createDeploymentConfiguration(java.util.Properties initParameters)

createPortletService

protected VaadinPortlet.PortletService createPortletService(DeploymentConfiguration deploymentConfiguration)

destroy

public void destroy()

Specified by:

destroy in interface javax.portlet.Portlet

Overrides:

destroy in class javax.portlet.GenericPortlet

getRequestType

@Deprecated
protected VaadinPortlet.RequestType getRequestType(WrappedPortletRequest wrappedRequest)

Deprecated. might be refactored or removed before 7.0.0

Parameters:

wrappedRequest -

Returns:

handleRequest

@Deprecated
protected void handleRequest(javax.portlet.PortletRequest request,
                                        javax.portlet.PortletResponse response)
                      throws javax.portlet.PortletException,
                             java.io.IOException

Deprecated. might be refactored or removed before 7.0.0

Parameters:

request -

response -

Throws:

javax.portlet.PortletException

java.io.IOException

createWrappedRequest

protected WrappedPortletRequest createWrappedRequest(javax.portlet.PortletRequest request)

Wraps the request in a (possibly portal specific) wrapped portlet request.

Parameters:

request - The original PortletRequest

Returns:

A wrapped version of the PorletRequest

getVaadinService

protected VaadinPortlet.PortletService getVaadinService()

processEvent

public void processEvent(javax.portlet.EventRequest request,
                         javax.portlet.EventResponse response)
                  throws javax.portlet.PortletException,
                         java.io.IOException

Specified by:

processEvent in interface javax.portlet.EventPortlet

Overrides:

processEvent in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

java.io.IOException

processAction

public void processAction(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse response)
                   throws javax.portlet.PortletException,
                          java.io.IOException

Specified by:

processAction in interface javax.portlet.Portlet

Overrides:

processAction in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

java.io.IOException

doDispatch

protected void doDispatch(javax.portlet.RenderRequest request,
                          javax.portlet.RenderResponse response)
                   throws javax.portlet.PortletException,
                          java.io.IOException

Overrides:

doDispatch in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

java.io.IOException

serveResource

public void serveResource(javax.portlet.ResourceRequest request,
                          javax.portlet.ResourceResponse response)
                   throws javax.portlet.PortletException,
                          java.io.IOException

Specified by:

serveResource in interface javax.portlet.ResourceServingPortlet

Overrides:

serveResource in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

java.io.IOException

onVaadinSessionStarted

protected void onVaadinSessionStarted(WrappedPortletRequest request,
                                      VaadinPortletSession session)
                               throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException