com.vaadin.server
Class VaadinPortletSession

java.lang.Object
  com.vaadin.server.VaadinSession
      com.vaadin.server.VaadinPortletSession

All Implemented Interfaces:

java.io.Serializable, java.util.EventListener, javax.servlet.http.HttpSessionBindingListener

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

@Deprecated
public class VaadinPortletSession
extends VaadinSession

TODO Write documentation, fix JavaDoc tags. This is automatically registered as a HttpSessionBindingListener when PortletSession#setAttribute() is called with the context as value.

Author:

peholmst

See Also:

Serialized Form

Nested Class Summary

static interface

VaadinPortletSession.PortletListener Deprecated.

Nested classes/interfaces inherited from class com.vaadin.server.VaadinSession

VaadinSession.FutureAccess, VaadinSession.State

Field Summary

Fields inherited from class com.vaadin.server.VaadinSession

browser, UI_PARAMETER

Constructor Summary

VaadinPortletSession(VaadinPortletService service)
Deprecated. Create a portlet service session for the given portlet service

Method Summary

void	addPortletListener(VaadinPortletSession.PortletListener listener) Deprecated.
void	firePortletActionRequest(UI uI, javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) Deprecated.
void	firePortletEventRequest(UI uI, javax.portlet.EventRequest request, javax.portlet.EventResponse response) Deprecated.
void	firePortletRenderRequest(UI uI, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) Deprecated.
void	firePortletResourceRequest(UI uI, javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response) Deprecated.
javax.portlet.PortletURL	generateActionURL(java.lang.String action) Deprecated. Creates a new action URL.
javax.portlet.PortletConfig	getPortletConfig() Deprecated.
javax.portlet.PortletSession	getPortletSession() Deprecated.
void	removePortletListener(VaadinPortletSession.PortletListener listener) Deprecated.
void	sendPortletEvent(UI uI, javax.xml.namespace.QName name, java.io.Serializable value) Deprecated. Sends a portlet event to the indicated destination.
void	setPortletMode(UI uI, javax.portlet.PortletMode portletMode) Deprecated. Sets the portlet mode.
void	setSharedRenderParameter(UI uI, java.lang.String name, java.lang.String value) Deprecated. Sets a shared portlet parameter.

Methods inherited from class com.vaadin.server.VaadinSession

access, accessSynchronously, addBootstrapListener, addRequestHandler, addUI, addUIProvider, close, createConnectorId, getAllSessions, getAttribute, getAttribute, getBrowser, getCommunicationManager, getConfiguration, getConverterFactory, getCsrfToken, getCumulativeRequestDuration, getCurrent, getDragAndDropService, getErrorHandler, getForSession, getGlobalResourceHandler, getLastRequestDuration, getLastRequestTimestamp, getLocale, getLockInstance, getNextUIid, getPendingAccessQueue, getRequestHandlers, getService, getSession, getState, getUIByEmbedId, getUIById, getUIProviders, getUIs, hasLock, isClosing, lock, modifyBootstrapResponse, removeBootstrapListener, removeFromSession, removeRequestHandler, removeUI, removeUIProvider, setAttribute, setAttribute, setCommunicationManager, setConfiguration, setConverterFactory, setCurrent, setErrorHandler, setLastRequestDuration, setLastRequestTimestamp, setLocale, setState, storeInSession, unlock, valueBound, valueUnbound

Methods inherited from class java.lang.Object

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

Constructor Detail

VaadinPortletSession

public VaadinPortletSession(VaadinPortletService service)

Deprecated.

Create a portlet service session for the given portlet service

Parameters:

service - the portlet service to which the new session belongs

Method Detail

getPortletSession

public javax.portlet.PortletSession getPortletSession()

Deprecated.

getPortletConfig

public javax.portlet.PortletConfig getPortletConfig()

Deprecated.

addPortletListener

public void addPortletListener(VaadinPortletSession.PortletListener listener)

Deprecated.

removePortletListener

public void removePortletListener(VaadinPortletSession.PortletListener listener)

Deprecated.

firePortletRenderRequest

public void firePortletRenderRequest(UI uI,
                                     javax.portlet.RenderRequest request,
                                     javax.portlet.RenderResponse response)

Deprecated.

firePortletActionRequest

public void firePortletActionRequest(UI uI,
                                     javax.portlet.ActionRequest request,
                                     javax.portlet.ActionResponse response)

Deprecated.

firePortletEventRequest

public void firePortletEventRequest(UI uI,
                                    javax.portlet.EventRequest request,
                                    javax.portlet.EventResponse response)

Deprecated.

firePortletResourceRequest

public void firePortletResourceRequest(UI uI,
                                       javax.portlet.ResourceRequest request,
                                       javax.portlet.ResourceResponse response)

Deprecated.

generateActionURL

public javax.portlet.PortletURL generateActionURL(java.lang.String action)

Deprecated.

Creates a new action URL.

Parameters:

action -

Returns:

action URL or null if called outside a MimeRequest (outside a UIDL request or similar)

sendPortletEvent

public void sendPortletEvent(UI uI,
                             javax.xml.namespace.QName name,
                             java.io.Serializable value)
                      throws java.lang.IllegalStateException

Deprecated.

Sends a portlet event to the indicated destination. Internally, an action may be created and opened, as an event cannot be sent directly from all types of requests. The event destinations and values need to be kept in the context until sent. Any memory leaks if the action fails are limited to the session. Event names for events sent and received by a portlet need to be declared in portlet.xml .

Parameters:

uI - a window in which a temporary action URL can be opened if necessary

name - event name

value - event value object that is Serializable and, if appropriate, has a valid JAXB annotation

Throws:

java.lang.IllegalStateException

setSharedRenderParameter

public void setSharedRenderParameter(UI uI,
                                     java.lang.String name,
                                     java.lang.String value)
                              throws java.lang.IllegalStateException

Deprecated.

Sets a shared portlet parameter. Internally, an action may be created and opened, as shared parameters cannot be set directly from all types of requests. The parameters and values need to be kept in the context until sent. Any memory leaks if the action fails are limited to the session. Shared parameters set or read by a portlet need to be declared in portlet.xml .

Parameters:

uI - a window in which a temporary action URL can be opened if necessary

name - parameter identifier

value - parameter value

Throws:

java.lang.IllegalStateException

setPortletMode

public void setPortletMode(UI uI,
                           javax.portlet.PortletMode portletMode)
                    throws java.lang.IllegalStateException,
                           javax.portlet.PortletModeException

Deprecated.

Sets the portlet mode. This may trigger a new render request. Portlet modes used by a portlet need to be declared in portlet.xml .

Parameters:

uI - a window in which the render URL can be opened if necessary

portletMode - the portlet mode to switch to

Throws:

javax.portlet.PortletModeException - if the portlet mode is not allowed for some reason (configuration, permissions etc.)

java.lang.IllegalStateException