de.innovationgate.wgpublisher.webtml.portlet

Class TMLPortletStateTransientStorage

java.lang.Object

de.innovationgate.wgpublisher.webtml.portlet.TMLPortletStateTransientStorage

All Implemented Interfaces:

TMLPortletStateStorage

public class TMLPortletStateTransientStorage
extends java.lang.Object
implements TMLPortletStateStorage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TMLPortletStateTransientStorage.TMLPortletStateTypeAdapterFactory

Constructor Summary

Constructors

Constructor and Description
TMLPortletStateTransientStorage(WGACore core, de.innovationgate.webgate.api.WGUserProfile wgUserProfile, javax.servlet.http.HttpServletRequest req, TMLForm.MultipartFormData formData, boolean ajaxRequest)

Method Summary

Methods

Modifier and Type	Method and Description
TMLPortletState	deserializePortletState(java.lang.String str)
void	disposeChildState(java.lang.String appDb, java.lang.String portletKey, java.lang.String childName) Removes the state of a child portlet of addressed portlet from the storage, based on its name.
void	disposeState(java.lang.String appDb, java.lang.String portletKey) Removes the state of the addressed portlet from the storage
java.util.Collection<TMLPortletState>	getAllStates()
java.util.Set<java.lang.String>	getDisposedStates()
java.util.Set<java.lang.String>	getProcessIdsSentByClient()
TMLPortletState	getState(TMLPortlet portlet) Retrieves the state for the given portlet
boolean	isStoreSessionVarsAtState() Returns if portlet states in this storage should store their session vars at the TMLPortletState object.
boolean	isTransient()
void	readStates(WGACore core)
java.lang.String	serializePortletState(TMLPortletState state)

Methods inherited from class java.lang.Object

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

Constructor Detail

TMLPortletStateTransientStorage

public TMLPortletStateTransientStorage(WGACore core,
                               de.innovationgate.webgate.api.WGUserProfile wgUserProfile,
                               javax.servlet.http.HttpServletRequest req,
                               TMLForm.MultipartFormData formData,
                               boolean ajaxRequest)
                                throws java.io.UnsupportedEncodingException,
                                       de.innovationgate.webgate.api.WGAPIException

Throws:

java.io.UnsupportedEncodingException

de.innovationgate.webgate.api.WGAPIException

Method Detail

readStates

public void readStates(WGACore core)
                throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getState

public TMLPortletState getState(TMLPortlet portlet)
                         throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: TMLPortletStateStorage

Retrieves the state for the given portlet

Specified by:

getState in interface TMLPortletStateStorage

Throws:

de.innovationgate.webgate.api.WGAPIException

disposeState

public void disposeState(java.lang.String appDb,
                java.lang.String portletKey)

Description copied from interface: TMLPortletStateStorage

Removes the state of the addressed portlet from the storage

Specified by:

disposeState in interface TMLPortletStateStorage

Parameters:

appDb - App id of the portlet, like given from the portlet registry

portletKey - Key of the portlet

getAllStates

public java.util.Collection<TMLPortletState> getAllStates()

isTransient

public boolean isTransient()

getDisposedStates

public java.util.Set<java.lang.String> getDisposedStates()

disposeChildState

public void disposeChildState(java.lang.String appDb,
                     java.lang.String portletKey,
                     java.lang.String childName)
                       throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: TMLPortletStateStorage

Removes the state of a child portlet of addressed portlet from the storage, based on its name. This is an optional operations, only possible if the child name can be used to resolve its state. Implementations not supporting this should throw WGNotSupportedException.

Specified by:

disposeChildState in interface TMLPortletStateStorage

Parameters:

appDb - App id of the portlet, like given from the portlet registry

portletKey - Key of the parent portlet

childName - Name of the child portlet whose state is to be dropped

Throws:

de.innovationgate.webgate.api.WGAPIException

getProcessIdsSentByClient

public java.util.Set<java.lang.String> getProcessIdsSentByClient()

deserializePortletState

public TMLPortletState deserializePortletState(java.lang.String str)
                                        throws java.io.IOException

Throws:

java.io.IOException

serializePortletState

public java.lang.String serializePortletState(TMLPortletState state)
                                       throws java.io.IOException

Throws:

java.io.IOException

isStoreSessionVarsAtState

public boolean isStoreSessionVarsAtState()

Description copied from interface: TMLPortletStateStorage

Returns if portlet states in this storage should store their session vars at the TMLPortletState object. Otherwise they are stored at accompanying TMLFormProcessContext objects on the server.

Specified by:

isStoreSessionVarsAtState in interface TMLPortletStateStorage