to.etc.domui.state

Class WindowSession

java.lang.Object

to.etc.domui.state.WindowSession

public final class WindowSession
extends Object

Manages conversations and the shelve stack. A WindowSession is in charge of all conversations within a given window, and maintains all state there.

Author:

Frits Jalvingh Created on Oct 24, 2008

Constructor Summary

Constructors

Constructor and Description
WindowSession(AppSession session)

Method Summary

Modifier and Type	Method and Description
void	acceptNewConversation(ConversationContext cc)
void	addShelveEntry(int depth, IShelvedEntry entry) Add or insert a page to the shelve stack.
void	clearGoto() Clear all goto stuff at request start time.
ConversationContext	createConversation(Class<? extends ConversationContext> clz)
protected void	destroyConversation(ConversationContext cc)
void	dump() Dump all conversations and their resident pages.
ConversationContext	findConversation(String cid) Locate a conversation by ID.
DomApplication	getApplication()
Object	getAttribute(String name) Get a window attribute.
long	getLastUsed()
List<IShelvedEntry>	getShelvedPageStack() Get the current contents of the shelved page stack.
ConversationContext	getTargetConversation()
Class<? extends ConversationContext>	getTargetConversationClass()
MoveMode	getTargetMode()
Class<? extends UrlPage>	getTargetPageClass()
IPageParameters	getTargetPageParameters()
String	getWindowID()
boolean	handleExceptionGoto(RequestContextImpl ctx, Page currentpg, boolean ajax) Goto handling in EXCEPTION handling mode: only Redirect is allowed here.
boolean	handleGoto(RequestContextImpl ctx, Page currentpg, boolean ajax) This checks whether a new page is to be made resident, instead of the current page.
boolean	insertShelveEntry(int depth, Class<? extends UrlPage> clz, IPageParameters parameters) This inserts a (possibly new) entry in the page stack.
void	internalAttachConversations() Call the "attach" method for all conversations, indicating that a new request is going to be handled.
String	internalAttemptReload(javax.servlet.http.HttpSession hs, Class<? extends UrlPage> clz2, PageParameters pageParameters, String oldWindowId) This will try to resurrect a set of windows from a previously stored stack.
void	internalDetachConversations() Detach all conversations, called just before the request is done.
void	internalSetLastPage(Page page)
void	internalSetNextPage(MoveMode m, Class<? extends UrlPage> clz, ConversationContext cc, Class<? extends ConversationContext> ccclz, IPageParameters pp)
void	internalSetRedirect(String targeturl)
boolean	isConversationDestroyed(String ccid) Quickly check if a conversation is (recently) destroyed, this should prevent "event reordering problems" like in etc.to bugzilla bug#3138.
boolean	isPageOnStack(Class<? extends UrlPage> clz, IPageParameters papa)
void	setAttribute(String name, Object val) Set a window attribute.
String	toString()
Page	tryToMakeOrGetPage(IRequestContext rctx, Class<? extends UrlPage> clz, PageParameters papa, String action) Get a valid Page, either from the shelve stack or some other location.

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowSession

public WindowSession(@Nonnull
                     AppSession session)

Method Detail

getApplication

@Nonnull
public final DomApplication getApplication()

getWindowID

@Nonnull
public final String getWindowID()

findConversation

@Nullable
public ConversationContext findConversation(@Nonnull
                                                      String cid)
                                               throws Exception

Locate a conversation by ID. Returns null if the conversation is not found.

Parameters:

cid -

Returns:

Throws:

Exception

internalAttachConversations

public void internalAttachConversations()
                                 throws Exception

Call the "attach" method for all conversations, indicating that a new request is going to be handled.

Throws:

Exception

internalDetachConversations

public void internalDetachConversations()

Detach all conversations, called just before the request is done.

dump

public void dump()

Dump all conversations and their resident pages.

destroyConversation

protected void destroyConversation(@Nonnull
                                   ConversationContext cc)

isConversationDestroyed

public boolean isConversationDestroyed(@Nonnull
                                       String ccid)

Quickly check if a conversation is (recently) destroyed, this should prevent "event reordering problems" like in etc.to bugzilla bug#3138.

Parameters:

ccid -

Returns:

createConversation

public ConversationContext createConversation(@Nonnull
                                              Class<? extends ConversationContext> clz)
                                       throws Exception

Throws:

Exception

acceptNewConversation

public void acceptNewConversation(@Nonnull
                                  ConversationContext cc)
                           throws Exception

Throws:

Exception

getShelvedPageStack

@Nonnull
public List<IShelvedEntry> getShelvedPageStack()

Get the current contents of the shelved page stack.

Returns:

handleExceptionGoto

public boolean handleExceptionGoto(@Nonnull
                                   RequestContextImpl ctx,
                                   @Nonnull
                                   Page currentpg,
                                   boolean ajax)
                            throws Exception

Goto handling in EXCEPTION handling mode: only Redirect is allowed here.

Parameters:

ctx -

currentpg -

ajax -

Returns:

Throws:

Exception

handleGoto

public boolean handleGoto(@Nonnull
                          RequestContextImpl ctx,
                          @Nonnull
                          Page currentpg,
                          boolean ajax)
                   throws Exception

This checks whether a new page is to be made resident, instead of the current page.

Parameters:

ctx -

currentpg - The page that is current (the one that issued the MOVE command).

Returns:

Throws:

Exception

clearGoto

public void clearGoto()

Clear all goto stuff at request start time.

internalSetNextPage

public void internalSetNextPage(@Nonnull
                                MoveMode m,
                                @Nullable
                                Class<? extends UrlPage> clz,
                                @Nullable
                                ConversationContext cc,
                                @Nullable
                                Class<? extends ConversationContext> ccclz,
                                @Nullable
                                IPageParameters pp)

internalSetRedirect

public void internalSetRedirect(@Nonnull
                                String targeturl)

getTargetPageClass

@Nullable
public Class<? extends UrlPage> getTargetPageClass()

getTargetPageParameters

@Nullable
public IPageParameters getTargetPageParameters()

getTargetConversationClass

@Nullable
public Class<? extends ConversationContext> getTargetConversationClass()

getTargetConversation

@Nullable
public ConversationContext getTargetConversation()

getTargetMode

@Nullable
public MoveMode getTargetMode()

tryToMakeOrGetPage

public Page tryToMakeOrGetPage(@Nonnull
                               IRequestContext rctx,
                               @Nonnull
                               Class<? extends UrlPage> clz,
                               @Nullable
                               PageParameters papa,
                               @Nullable
                               String action)
                        throws Exception

Get a valid Page, either from the shelve stack or some other location. If this is for a full page request the 'papa' parameters are from the request and must be non-null. For an AJAX request the page parameters, since they are not repeated in an AJAX request, is null. Also, it can happen that we are handling here AJAX for expired page - in that case we return null as result.

Parameters:

rctx -

clz -

papa -

action - AJAX action

Returns:

Throws:

Exception

isPageOnStack

public boolean isPageOnStack(@Nonnull
                             Class<? extends UrlPage> clz,
                             @Nonnull
                             IPageParameters papa)
                      throws Exception

Throws:

Exception

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

getLastUsed

public long getLastUsed()

internalSetLastPage

public void internalSetLastPage(@Nonnull
                                Page page)

setAttribute

public void setAttribute(@Nonnull
                         String name,
                         @Nullable
                         Object val)

Set a window attribute.

Parameters:

name -

val -

getAttribute

@Nullable
public Object getAttribute(@Nonnull
                                     String name)

Get a window attribute.

Parameters:

name -

Returns:

addShelveEntry

public void addShelveEntry(int depth,
                           @Nonnull
                           IShelvedEntry entry)

Add or insert a page to the shelve stack. Used to shelve non DomUI stack entries.

Parameters:

depth -

entry -

insertShelveEntry

public boolean insertShelveEntry(int depth,
                                 @Nonnull
                                 Class<? extends UrlPage> clz,
                                 @Nonnull
                                 IPageParameters parameters)
                          throws Exception

This inserts a (possibly new) entry in the page stack. If the same page is already there nothing happens and this returns false (stack not modified).

Parameters:

depth -

clz -

parameters -

Throws:

Exception

internalAttemptReload

@Nullable
public String internalAttemptReload(@Nonnull
                                              javax.servlet.http.HttpSession hs,
                                              @Nonnull
                                              Class<? extends UrlPage> clz2,
                                              @Nonnull
                                              PageParameters pageParameters,
                                              @Nonnull
                                              String oldWindowId)

This will try to resurrect a set of windows from a previously stored stack.

Parameters:

string -

sw -

pageParameters -

clz2 -