Package com.vaadin.portlet

Class VaadinPortletService

java.lang.Object

com.vaadin.server.VaadinService

com.vaadin.portlet.VaadinPortletService

All Implemented Interfaces:

Serializable

public class VaadinPortletService
extends VaadinService

See Also:

Serialized Form

Field Summary

Fields inherited from class com.vaadin.server.VaadinService

URL_PARAMETER_CLOSE_APPLICATION, URL_PARAMETER_RESTART_APPLICATION

Constructor Summary

Constructors

Constructor	Description
VaadinPortletService(VaadinPortlet portlet, DeploymentConfiguration deploymentConfiguration)

Method Summary

Modifier and Type	Method	Description
protected List<RequestHandler>	createRequestHandlers()
protected VaadinSession	createVaadinSession(VaadinRequest request)
File	getBaseDirectory()
String	getConfiguredTheme(VaadinRequest request)
String	getConfiguredWidgetset(VaadinRequest request)
static javax.portlet.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)
String	getMimeType(String resourceName)
VaadinPortlet	getPortlet()	Retrieves a reference to the portlet associated with this service.
protected VaadinPortlet.RequestType	getRequestType(VaadinRequest request)	Deprecated. As of 7.0.
String	getServiceName()
protected Lock	getSessionLock(WrappedSession wrappedSession)
String	getStaticFileLocation(VaadinRequest request)
InputStream	getThemeResourceAsStream(UI uI, String themeName, String resource)
protected void	handleSessionExpired(VaadinRequest request, VaadinResponse response)
boolean	isStandalone(VaadinRequest request)
boolean	preserveUIOnRefresh(UIProvider provider, UICreateEvent event)	Always preserve UIs in portlets to make portlet actions work.
protected VaadinSession	readFromHttpSession(WrappedSession wrappedSession)
protected void	removeFromHttpSession(WrappedSession wrappedSession)
protected boolean	requestCanCreateSession(VaadinRequest request)
protected void	setSessionLock(WrappedSession wrappedSession, Lock lock)
protected void	writeToHttpSession(WrappedSession wrappedSession, VaadinSession session)

Methods inherited from class com.vaadin.server.VaadinService

accessSession, addServiceDestroyListener, addSessionDestroyListener, addSessionInitListener, cleanupSession, closeSession, createCriticalNotificationJSON, criticalNotification, destroy, ensureAccessQueuePurged, ensurePushAvailable, findUI, findVaadinSession, fireSessionDestroy, generateConnectorId, getApplicationUrl, getClassLoader, getCurrent, getDependencyFilters, getDeploymentConfiguration, getExistingSession, getLockAttributeName, getRequestHandlers, getServiceInitListeners, getSessionAttributeName, getSystemMessages, getSystemMessagesProvider, handleRequest, init, initConnectorIdGenerator, initDependencyFilters, isAtmosphereAvailable, isCsrfTokenValid, isOtherSessionLocked, isUIActive, loadSession, lockSession, reinitializeSession, removeServiceDestroyListener, removeSession, removeSessionDestroyListener, removeSessionInitListener, requestEnd, requestStart, runPendingAccessTasks, setClassLoader, setCurrent, setCurrentInstances, setDefaultClassLoader, setSystemMessagesProvider, storeSession, unlockSession, verifyNoOtherSessionLocked, writeStringResponse, writeUncachedStringResponse

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

Overrides:

createRequestHandlers in class VaadinService

Throws:

ServiceException

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)

Specified by:

getConfiguredWidgetset in class VaadinService

getConfiguredTheme

public String getConfiguredTheme(VaadinRequest request)

Specified by:

getConfiguredTheme in class VaadinService

isStandalone

public boolean isStandalone(VaadinRequest request)

Specified by:

isStandalone in class VaadinService

getStaticFileLocation

public String getStaticFileLocation(VaadinRequest request)

Specified by:

getStaticFileLocation in class VaadinService

getMimeType

public String getMimeType(String resourceName)

Specified by:

getMimeType in class VaadinService

See Also:

PortletContext.getMimeType(String)

getBaseDirectory

public File getBaseDirectory()

Specified by:

getBaseDirectory in class VaadinService

requestCanCreateSession

protected boolean requestCanCreateSession(VaadinRequest request)

Specified by:

requestCanCreateSession in class VaadinService

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 javax.portlet.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

Overrides:

createVaadinSession in class VaadinService

Throws:

ServiceException

getServiceName

public String getServiceName()

Specified by:

getServiceName in class VaadinService

preserveUIOnRefresh

public boolean preserveUIOnRefresh(UIProvider provider,
                                   UICreateEvent event)

Always preserve UIs in portlets to make portlet actions work.

Overrides:

preserveUIOnRefresh in class VaadinService

getThemeResourceAsStream

public InputStream getThemeResourceAsStream(UI uI,
                                            String themeName,
                                            String resource)

Specified by:

getThemeResourceAsStream in class VaadinService

getMainDivId

public String getMainDivId(VaadinSession session,
                           VaadinRequest request,
                           Class<? extends UI> uiClass)

Specified by:

getMainDivId in class VaadinService

handleSessionExpired

protected void handleSessionExpired(VaadinRequest request,
                                    VaadinResponse response)

Overrides:

handleSessionExpired in class VaadinService

writeToHttpSession

protected void writeToHttpSession(WrappedSession wrappedSession,
                                  VaadinSession session)

Overrides:

writeToHttpSession in class VaadinService

readFromHttpSession

protected VaadinSession readFromHttpSession(WrappedSession wrappedSession)

Overrides:

readFromHttpSession in class VaadinService

removeFromHttpSession

protected void removeFromHttpSession(WrappedSession wrappedSession)

Overrides:

removeFromHttpSession in class VaadinService

setSessionLock

protected void setSessionLock(WrappedSession wrappedSession,
                              Lock lock)

Overrides:

setSessionLock in class VaadinService

getSessionLock

protected Lock getSessionLock(WrappedSession wrappedSession)

Overrides:

getSessionLock in class VaadinService