com.vaadin.server.

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

All Implemented Interfaces:

Constants, Serializable, 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, Serializable
```
Portlet 2.0 base class. This replaces the servlet in servlet/portlet 1.0 deployments and handles various portlet requests from the browser.

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`VaadinPortlet.RequestType` Deprecated. As of 7.0. This is no longer used and only provided for backwards compatibility. Each `RequestHandler` can individually decide whether it wants to handle a request or not.
`static class`	`VaadinPortlet.VaadinGateInRequest` Portlet request for GateIn.
`static class`	`VaadinPortlet.VaadinHttpAndPortletRequest` Base class for portlet requests that need access to HTTP servlet requests.
`static class`	`VaadinPortlet.VaadinLiferayRequest` Portlet request for Liferay.
`static class`	`VaadinPortlet.VaadinWebLogicPortalRequest` Portlet request for WebSphere Portal.
`static class`	`VaadinPortlet.VaadinWebSpherePortalRequest` Portlet request for WebSphere Portal.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PORTAL_PARAMETER_VAADIN_THEME` Deprecated. As of 7.0. Will likely change or be removed in a future version
`static String`	`PORTLET_PARAMETER_STYLE` Deprecated. As of 7.0. Will likely change or be removed in a future version
`static String`	`RESOURCE_URL_ID` Deprecated. As of 7.0. Will likely change or be removed in a future version
`static String`	`WRITE_AJAX_PAGE_SCRIPT_WIDGETSET_SHOULD_WRITE` Deprecated. As of 7.0. Will likely change or be removed in a future version

Fields inherited from interface com.vaadin.server.Constants
ATMOSPHERE_MISSING_ERROR, CANNOT_ACQUIRE_CLASSLOADER_SEVERE, DEFAULT_BUFFER_SIZE, DEFAULT_THEME_CACHETIME, DEFAULT_THEME_NAME, DEFAULT_WIDGETSET, ERROR_NO_UI_FOUND, INVALID_ATMOSPHERE_VERSION_WARNING, 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, PORTLET_CONTEXT, PUSH_NOT_SUPPORTED_ERROR, REQUIRED_ATMOSPHERE_RUNTIME_VERSION, SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS, SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION, SERVLET_PARAMETER_HEARTBEAT_INTERVAL, SERVLET_PARAMETER_LEGACY_DESIGN_PREFIX, SERVLET_PARAMETER_PRODUCTION_MODE, SERVLET_PARAMETER_PUSH_MODE, SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING, SERVLET_PARAMETER_RESOURCE_CACHE_TIME, SERVLET_PARAMETER_SENDURLSASPARAMETERS, SERVLET_PARAMETER_SYNC_ID_CHECK, SERVLET_PARAMETER_UI_PROVIDER, THEME_DIR_PATH, URL_PARAMETER_THEME, WARNING_HEARTBEAT_INTERVAL_NOT_NUMERIC, WARNING_PUSH_MODE_NOT_RECOGNIZED, WARNING_RESOURCE_CACHING_TIME_NOT_NUMERIC, WARNING_XSRF_PROTECTION_DISABLED, WIDGETSET_DIR_PATH, WIDGETSET_MISMATCH_INFO

Constructor Summary

Constructors
Constructor and Description

VaadinPortlet()

Method Summary

All Methods
Modifier and Type	Method and Description
`protected DeploymentConfiguration`	`createDeploymentConfiguration(Properties initParameters)`
`protected VaadinPortletService`	`createPortletService(DeploymentConfiguration deploymentConfiguration)`
`protected VaadinPortletRequest`	`createVaadinRequest(javax.portlet.PortletRequest request)` Wraps the request in a (possibly portal specific) Vaadin portlet request.
`void`	`destroy()`
`protected void`	`doDispatch(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)`
`static VaadinPortlet`	`getCurrent()` Gets the currently used Vaadin portlet.
`protected VaadinPortlet.RequestType`	`getRequestType(VaadinPortletRequest vaadinRequest)` Deprecated. As of 7.0. This is no longer used and only provided for backwards compatibility. Each `RequestHandler` can individually decide whether it wants to handle a request or not.
`protected VaadinPortletService`	`getService()`
`protected void`	`handleRequest(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)` Deprecated. As of 7.0. Will likely change or be removed in a future version
`void`	`init(javax.portlet.PortletConfig config)`
`protected void`	`portletInitialized()`
`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 String RESOURCE_URL_ID
```
    Deprecated. As of 7.0. Will likely change or be removed in a future version
    
    See Also:
    
    Constant Field Values
  - PORTLET_PARAMETER_STYLE
```
@Deprecated
public static final String PORTLET_PARAMETER_STYLE
```
    Deprecated. As of 7.0. Will likely change or be removed in a future version
    
    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 String PORTAL_PARAMETER_VAADIN_THEME
```
    Deprecated. As of 7.0. Will likely change or be removed in a future version
    
    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 String WRITE_AJAX_PAGE_SCRIPT_WIDGETSET_SHOULD_WRITE
```
    Deprecated. As of 7.0. Will likely change or be removed in a future version
    
    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
  - portletInitialized
```
protected void portletInitialized()
                           throws javax.portlet.PortletException
```
    Throws:
    
    javax.portlet.PortletException
  - createDeploymentConfiguration
```
protected DeploymentConfiguration createDeploymentConfiguration(Properties initParameters)
```
  - createPortletService
```
protected VaadinPortletService createPortletService(DeploymentConfiguration deploymentConfiguration)
                                             throws ServiceException
```
    Throws:
    
    ServiceException
  - getRequestType
```
@Deprecated
protected VaadinPortlet.RequestType getRequestType(VaadinPortletRequest vaadinRequest)
```
    Deprecated. As of 7.0. This is no longer used and only provided for backwards compatibility. Each RequestHandler can individually decide whether it wants to handle a request or not.
    
    Parameters:
    
    vaadinRequest -
    
    Returns:
  - handleRequest
```
@Deprecated
protected void handleRequest(javax.portlet.PortletRequest request,
                                         javax.portlet.PortletResponse response)
                                  throws javax.portlet.PortletException,
                                         IOException
```
    Deprecated. As of 7.0. Will likely change or be removed in a future version
    
    Parameters:
    
    request -
    
    response -
    
    Throws:
    
    javax.portlet.PortletException
    
    IOException
  - createVaadinRequest
```
protected VaadinPortletRequest createVaadinRequest(javax.portlet.PortletRequest request)
```
    Wraps the request in a (possibly portal specific) Vaadin portlet request.
    
    Parameters:
    
    request - The original PortletRequest
    
    Returns:
    
    A wrapped version of the PortletRequest
  - getService
```
protected VaadinPortletService getService()
```
  - processEvent
```
public void processEvent(javax.portlet.EventRequest request,
                         javax.portlet.EventResponse response)
                  throws javax.portlet.PortletException,
                         IOException
```
    Specified by:
    
    processEvent in interface javax.portlet.EventPortlet
    
    Overrides:
    
    processEvent in class javax.portlet.GenericPortlet
    
    Throws:
    
    javax.portlet.PortletException
    
    IOException
  - processAction
```
public void processAction(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse response)
                   throws javax.portlet.PortletException,
                          IOException
```
    Specified by:
    
    processAction in interface javax.portlet.Portlet
    
    Overrides:
    
    processAction in class javax.portlet.GenericPortlet
    
    Throws:
    
    javax.portlet.PortletException
    
    IOException
  - doDispatch
```
protected void doDispatch(javax.portlet.RenderRequest request,
                          javax.portlet.RenderResponse response)
                   throws javax.portlet.PortletException,
                          IOException
```
    Overrides:
    
    doDispatch in class javax.portlet.GenericPortlet
    
    Throws:
    
    javax.portlet.PortletException
    
    IOException
  - serveResource
```
public void serveResource(javax.portlet.ResourceRequest request,
                          javax.portlet.ResourceResponse response)
                   throws javax.portlet.PortletException,
                          IOException
```
    Specified by:
    
    serveResource in interface javax.portlet.ResourceServingPortlet
    
    Overrides:
    
    serveResource in class javax.portlet.GenericPortlet
    
    Throws:
    
    javax.portlet.PortletException
    
    IOException
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface javax.portlet.Portlet
    
    Overrides:
    
    destroy in class javax.portlet.GenericPortlet
  - getCurrent
```
public static VaadinPortlet getCurrent()
```
    Gets the currently used Vaadin portlet. The current portlet is automatically defined when processing requests related to the service (see ThreadLocal) and in VaadinSession.access(Runnable) and UI.access(Runnable). In other cases, (e.g. from background threads, the current service is not automatically defined. The current portlet is derived from the current service using VaadinService.getCurrent()
    
    Returns:
    
    the current vaadin portlet instance if available, otherwise null
    
    Since:
    
    7.0

com.vaadin.server.

Class VaadinPortlet

Nested Class Summary

Field Summary

Fields inherited from interface com.vaadin.server.Constants

Constructor Summary

Method Summary

Methods inherited from class javax.portlet.GenericPortlet

Methods inherited from class java.lang.Object

Field Detail

RESOURCE_URL_ID

PORTLET_PARAMETER_STYLE

PORTAL_PARAMETER_VAADIN_THEME

WRITE_AJAX_PAGE_SCRIPT_WIDGETSET_SHOULD_WRITE

Constructor Detail

VaadinPortlet

Method Detail

init

portletInitialized

createDeploymentConfiguration

createPortletService

getRequestType

handleRequest

createVaadinRequest

getService

processEvent

processAction

doDispatch

serveResource

destroy

getCurrent