Method Summary

All Methods
Modifier and Type	Method and Description
`protected List<RequestHandler>`	`createRequestHandlers()` Called during initialization to add the request handlers for the service.
`protected VaadinSession`	`createVaadinSession(VaadinRequest request)` Creates a new Vaadin session for this service and request
`File`	`getBaseDirectory()` Returns the context base directory.
`String`	`getConfiguredTheme(VaadinRequest request)` Gets the theme that is configured for this deployment, e.g.
`String`	`getConfiguredWidgetset(VaadinRequest request)` Gets the widgetset that is configured for this deployment, e.g.
`static PortletRequest`	`getCurrentPortletRequest()` Gets the currently processed portlet request.
`static VaadinPortletRequest`	`getCurrentRequest()` Gets the currently processed Vaadin portlet request.
`static VaadinPortletResponse`	`getCurrentResponse()` Gets the currently processed Vaadin portlet response.
`String`	`getMainDivId(VaadinSession session, VaadinRequest request, Class<? extends UI> uiClass)` Creates and returns a unique ID for the DIV where the UI is to be rendered.
`String`	`getMimeType(String resourceName)` Returns the MIME type of the specified file, or null if the MIME type is not known.
`VaadinPortlet`	`getPortlet()` Retrieves a reference to the portlet associated with this service.
`protected VaadinPortlet.RequestType`	`getRequestType(VaadinRequest request)` Deprecated. As of 7.0. Will likely change or be removed in a future version
`String`	`getServiceName()` Gets a unique name for this service.
`String`	`getStaticFileLocation(VaadinRequest request)` Return the URL from where static files, e.g.
`InputStream`	`getThemeResourceAsStream(UI uI, String themeName, String resource)` Finds the given theme resource from the web content folder or using the class loader and returns a stream for it
`protected void`	`handleSessionExpired(VaadinRequest request, VaadinResponse response)` Called when the session has expired and the request handling is therefore aborted.
`boolean`	`isStandalone(VaadinRequest request)` Checks whether the UI will be rendered on its own in the browser or whether it will be included into some other context.
`boolean`	`preserveUIOnRefresh(UIProvider provider, UICreateEvent event)` Always preserve UIs in portlets to make portlet actions work.
`protected VaadinSession`	`readFromHttpSession(WrappedSession wrappedSession)` Performs the actual read of the VaadinSession from the underlying HTTP session after sanity checks have been performed.
`protected void`	`removeFromHttpSession(WrappedSession wrappedSession)` Performs the actual removal of the VaadinSession from the underlying HTTP session after sanity checks have been performed
`protected boolean`	`requestCanCreateSession(VaadinRequest request)` Checks whether it's valid to create a new service session as a result of the given request.
`protected void`	`writeToHttpSession(WrappedSession wrappedSession, VaadinSession session)` Performs the actual write of the VaadinSession to the underlying HTTP session after sanity checks have been performed.

Methods inherited from class com.vaadin.server.VaadinService
accessSession, addServiceDestroyListener, addSessionDestroyListener, addSessionInitListener, closeSession, createCriticalNotificationJSON, criticalNotification, destroy, ensureAccessQueuePurged, ensurePushAvailable, findUI, findVaadinSession, fireSessionDestroy, getApplicationUrl, getClassLoader, getCurrent, getDeploymentConfiguration, getExistingSession, getRequestHandlers, getSessionAttributeName, getSessionLock, getSystemMessages, getSystemMessagesProvider, handleRequest, init, isAtmosphereAvailable, isCsrfTokenValid, isOtherSessionLocked, loadSession, lockSession, reinitializeSession, removeServiceDestroyListener, removeSession, removeSessionDestroyListener, removeSessionInitListener, requestEnd, requestStart, runPendingAccessTasks, setClassLoader, setCurrent, setCurrentInstances, setDefaultClassLoader, setSystemMessagesProvider, storeSession, unlockSession, verifyNoOtherSessionLocked, writeStringResponse

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VaadinPortletService
```
public VaadinPortletService(VaadinPortlet portlet,
                            DeploymentConfiguration deploymentConfiguration)
                     throws ServiceException
```
    Throws:
    
    ServiceException
- Method Detail
  - createRequestHandlers
```
protected List<RequestHandler> createRequestHandlers()
                                              throws ServiceException
```
    Description copied from class: VaadinService
    
    Called during initialization to add the request handlers for the service. Note that the returned list will be reversed so the last handler will be called first. This enables overriding this method and using add on the returned list to add a custom request handler which overrides any predefined handler.
    
    Overrides:
    
    createRequestHandlers in class VaadinService
    
    Returns:
    
    The list of request handlers used by this service.
    
    Throws:
    
    ServiceException - if a problem occurs when creating the request handlers
  - getPortlet
```
public VaadinPortlet getPortlet()
```
    Retrieves a reference to the portlet associated with this service.
    
    Returns:
    
    A reference to the VaadinPortlet this service is using
  - getConfiguredWidgetset
```
public String getConfiguredWidgetset(VaadinRequest request)
```
    Description copied from class: VaadinService
    
    Gets the widgetset that is configured for this deployment, e.g. from a parameter in web.xml.
    
    Specified by:
    
    getConfiguredWidgetset in class VaadinService
    
    Parameters:
    
    request - the request for which a widgetset is required
    
    Returns:
    
    the name of the widgetset
  - getConfiguredTheme
```
public String getConfiguredTheme(VaadinRequest request)
```
    Description copied from class: VaadinService
    
    Gets the theme that is configured for this deployment, e.g. from a portal parameter or just some sensible default value.
    
    Specified by:
    
    getConfiguredTheme in class VaadinService
    
    Parameters:
    
    request - the request for which a theme is required
    
    Returns:
    
    the name of the theme
  - isStandalone
```
public boolean isStandalone(VaadinRequest request)
```
    Description copied from class: VaadinService
    
    Checks whether the UI will be rendered on its own in the browser or whether it will be included into some other context. A standalone UI may do things that might interfere with other parts of a page, e.g. changing the page title and requesting focus upon loading.
    
    Specified by:
    
    isStandalone in class VaadinService
    
    Parameters:
    
    request - the request for which the UI is loaded
    
    Returns:
    
    a boolean indicating whether the UI should be standalone
  - getStaticFileLocation
```
public String getStaticFileLocation(VaadinRequest request)
```
    Description copied from class: VaadinService
    
    Return the URL from where static files, e.g. the widgetset and the theme, are served. In a standard configuration the VAADIN folder inside the returned folder is what is used for widgetsets and themes. The returned folder is usually the same as the context path and independent of e.g. the servlet mapping.
    
    Specified by:
    
    getStaticFileLocation in class VaadinService
    
    Parameters:
    
    request - the request for which the location should be determined
    
    Returns:
    
    The location of static resources (should contain the VAADIN directory). Never ends with a slash (/).
  - getMimeType
```
public String getMimeType(String resourceName)
```
    Description copied from class: VaadinService
    
    Returns the MIME type of the specified file, or null if the MIME type is not known. The MIME type is determined by the configuration of the container, and may be specified in a deployment descriptor. Common MIME types are "text/html" and "image/gif".
    
    Specified by:
    
    getMimeType in class VaadinService
    
    Parameters:
    
    resourceName - a String specifying the name of a file
    
    Returns:
    
    a String specifying the file's MIME type
    
    See Also:
    
    ServletContext.getMimeType(String), PortletContext#getMimeType(String)
  - getBaseDirectory
```
public File getBaseDirectory()
```
    Description copied from class: VaadinService
    
    Returns the context base directory. Typically an application is deployed in a such way that is has an application directory. For web applications this directory is the root directory of the web applications. In some cases applications might not have an application directory (for example web applications running inside a war).
    
    Specified by:
    
    getBaseDirectory in class VaadinService
    
    Returns:
    
    The application base directory or null if the application has no base directory.
  - requestCanCreateSession
```
protected boolean requestCanCreateSession(VaadinRequest request)
```
    Description copied from class: VaadinService
    
    Checks whether it's valid to create a new service session as a result of the given request.
    
    Specified by:
    
    requestCanCreateSession in class VaadinService
    
    Parameters:
    
    request - the request
    
    Returns:
    
    true if it's valid to create a new service session for the request; else false
  - getRequestType
```
@Deprecated
protected VaadinPortlet.RequestType getRequestType(VaadinRequest request)
```
    Deprecated. As of 7.0. Will likely change or be removed in a future version
    
    Gets the request type for the request.
    
    Parameters:
    
    request - the request to get a request type for
    
    Returns:
    
    the request type
  - getCurrentPortletRequest
```
public static PortletRequest getCurrentPortletRequest()
```
    Gets the currently processed portlet request. The current portlet request is automatically defined when the request is started. The current portlet request can not be used in e.g. background threads because of the way server implementations reuse request instances.
    
    Returns:
    
    the current portlet request instance if available, otherwise null
  - getCurrentRequest
```
public static VaadinPortletRequest getCurrentRequest()
```
    Gets the currently processed Vaadin portlet request. The current request is automatically defined when the request is started. The current request can not be used in e.g. background threads because of the way server implementations reuse request instances.
    
    Returns:
    
    the current Vaadin portlet request instance if available, otherwise null
  - getCurrentResponse
```
public static VaadinPortletResponse getCurrentResponse()
```
    Gets the currently processed Vaadin portlet response. The current response is automatically defined when the request is started. The current response can not be used in e.g. background threads because of the way server implementations reuse response instances.
    
    Returns:
    
    the current Vaadin portlet response instance if available, otherwise null
  - createVaadinSession
```
protected VaadinSession createVaadinSession(VaadinRequest request)
                                     throws ServiceException
```
    Description copied from class: VaadinService
    
    Creates a new Vaadin session for this service and request
    
    Overrides:
    
    createVaadinSession in class VaadinService
    
    Parameters:
    
    request - The request for which to create a VaadinSession
    
    Returns:
    
    A new VaadinSession
    
    Throws:
    
    ServiceException
  - getServiceName
```
public String getServiceName()
```
    Description copied from class: VaadinService
    
    Gets a unique name for this service. The name should be unique among different services of the same type but the same for corresponding instances running in different JVMs in a cluster. This is typically based on e.g. the configured servlet's or portlet's name.
    
    Specified by:
    
    getServiceName in class VaadinService
    
    Returns:
    
    the unique name of this service instance.
  - preserveUIOnRefresh
```
public boolean preserveUIOnRefresh(UIProvider provider,
                                   UICreateEvent event)
```
    Always preserve UIs in portlets to make portlet actions work.
    
    Overrides:
    
    preserveUIOnRefresh in class VaadinService
    
    Parameters:
    
    provider - the UI provider responsible for the UI
    
    event - the UI create event with details about the UI
    
    Returns:
    
    true if the UI should be preserved on refresh; false if a new UI instance should be initialized on refreshed.
  - getThemeResourceAsStream
```
public InputStream getThemeResourceAsStream(UI uI,
                                            String themeName,
                                            String resource)
```
    Description copied from class: VaadinService
    
    Finds the given theme resource from the web content folder or using the class loader and returns a stream for it
    
    Specified by:
    
    getThemeResourceAsStream in class VaadinService
    
    Parameters:
    
    uI - The ui for which to find the resource
    
    themeName - The name of the theme
    
    resource - The name of the resource, e.g. "layouts/mycustomlayout.html"
    
    Returns:
    
    A stream for the resource or null if the resource was not found
  - getMainDivId
```
public String getMainDivId(VaadinSession session,
                           VaadinRequest request,
                           Class<? extends UI> uiClass)
```
    Description copied from class: VaadinService
    
    Creates and returns a unique ID for the DIV where the UI is to be rendered.
    
    Specified by:
    
    getMainDivId in class VaadinService
    
    Parameters:
    
    session - The service session to which the bootstrapped UI will belong.
    
    request - The request for which a div id is needed
    
    uiClass - The class of the UI that will be bootstrapped
    
    Returns:
    
    the id to use in the DOM
  - handleSessionExpired
```
protected void handleSessionExpired(VaadinRequest request,
                                    VaadinResponse response)
```
    Description copied from class: VaadinService
    
    Called when the session has expired and the request handling is therefore aborted.
    
    Overrides:
    
    handleSessionExpired in class VaadinService
    
    Parameters:
    
    request - The request
    
    response - The response
  - writeToHttpSession
```
protected void writeToHttpSession(WrappedSession wrappedSession,
                                  VaadinSession session)
```
    Description copied from class: VaadinService
    
    Performs the actual write of the VaadinSession to the underlying HTTP session after sanity checks have been performed.
    Called by VaadinService.storeSession(VaadinSession, WrappedSession)
    
    Overrides:
    
    writeToHttpSession in class VaadinService
    
    Parameters:
    
    wrappedSession - the underlying HTTP session
    
    session - the VaadinSession to store
  - readFromHttpSession
```
protected VaadinSession readFromHttpSession(WrappedSession wrappedSession)
```
    Description copied from class: VaadinService
    
    Performs the actual read of the VaadinSession from the underlying HTTP session after sanity checks have been performed.
    Called by VaadinService.loadSession(WrappedSession).
    
    Overrides:
    
    readFromHttpSession in class VaadinService
    
    Parameters:
    
    wrappedSession - the underlying HTTP session
    
    Returns:
    
    the VaadinSession or null if no session was found
  - removeFromHttpSession
```
protected void removeFromHttpSession(WrappedSession wrappedSession)
```
    Description copied from class: VaadinService
    
    Performs the actual removal of the VaadinSession from the underlying HTTP session after sanity checks have been performed
    
    Overrides:
    
    removeFromHttpSession in class VaadinService
    
    Parameters:
    
    wrappedSession - the underlying HTTP session

com.vaadin.server.

Class VaadinPortletService

Field Summary

Fields inherited from class com.vaadin.server.VaadinService

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.server.VaadinService

Methods inherited from class java.lang.Object

Constructor Detail

VaadinPortletService

Method Detail

createRequestHandlers

getPortlet

getConfiguredWidgetset

getConfiguredTheme

isStandalone

getStaticFileLocation

getMimeType

getBaseDirectory

requestCanCreateSession

getRequestType

getCurrentPortletRequest

getCurrentRequest

getCurrentResponse

createVaadinSession

getServiceName

preserveUIOnRefresh

getThemeResourceAsStream

getMainDivId

handleSessionExpired

writeToHttpSession

readFromHttpSession

removeFromHttpSession