de.must.markup

Class SessionStd

java.lang.Object

de.must.markup.SessionStd

public abstract class SessionStd
extends java.lang.Object

Image of the session with its dialog stack. Each dialog is represented by an Invokable. When the session is reused, the current Invokable is asked to check the request; it will induce among others stack movements to previous or new dialog steps. Invokable objects are created as singletons and are kept until the stack place is used by another object.

Field Summary

Fields

Modifier and Type	Field and Description
protected SessionData	sessionData

Constructor Summary

Constructors

Constructor and Description
SessionStd(java.lang.String actionForPost, java.lang.String applicationTitle) Constructs a new session.

Method Summary

Modifier and Type	Method and Description
void	backInvoke() Goes one step back in stack and recovers the appropriate invokable.
void	backInvoke(int steps) Goes one or more steps back in stack and recovers the appropriate invokable.
void	baseInvoke(java.lang.Class<? extends Invokable> classToBeInvoked) Instantiates the class to be invoked, which must implement the interface Invokable, and invokes it as the root of the stack.
void	baseInvoke(LoginDialog login) Invokes the specified menu bar as the root invokable of the stack.
void	baseInvoke(MustMenuBar menuBar) Invokes the specified menu bar as the root invokable of the stack.
protected abstract void	build(SessionData sessionData) Build part to be done by the individual session object.
void	buildAll() Called from MainStd after instantiating the session to build things in arbitrary sequence.
void	destroy() Destroy this object in order to free resources and weak references more early than garbage collector.
protected void	finalize()
protected void	free() Frees (releases) references caused by this frame, particularly static register entries.
java.lang.String	getContextPath() Returns the context path.
protected abstract GlobalStd	getGlobal() Returns the application's global objects class.
java.lang.String	getSessionId() Returns the session's id
protected void	handlePostOrGetWhatever(GeneralizedRequest request, HttpServletResponse response)
void	invoke(Invokable invokable) Invokes an invokable and puts it in the current position of the stack order.
boolean	isOld() Returns true if this session is old.
boolean	isToClose() Returns true if the session is to close.
boolean	seemsToBeUnused() Returns true if this session seems to be unused.
void	setContextPath(java.lang.String contextPath) Sets the context path.
void	setLocale(java.util.Locale locale) Sets the locale of the session.
void	setSessionId(java.lang.String sessionId) Sets the session's id
static void	setUseSeperateConnectionsForEachSession(boolean newSeparateConnections) Determines whether each session should use its own database connection or not.
void	subInvoke(Invokable invokable) Invokes an invokable and puts it in the next position of stack order.

Methods inherited from class java.lang.Object

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

Field Detail

sessionData

protected SessionData sessionData

Constructor Detail

SessionStd

public SessionStd(java.lang.String actionForPost,
                  java.lang.String applicationTitle)

Constructs a new session.

Parameters:

actionForPost - the action for the post operation, which is typically the one and only servlet class, e.g. "de.jugs.cookbook.Main"

applicationTitle - the title of the application

Method Detail

setUseSeperateConnectionsForEachSession

public static void setUseSeperateConnectionsForEachSession(boolean newSeparateConnections)

Determines whether each session should use its own database connection or not. Should be set to true, if commit / rollback is to be used.

Parameters:

separateConnections - whether each session should use its own database connection or not

getGlobal

protected abstract GlobalStd getGlobal()

Returns the application's global objects class.

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale of the session.

Parameters:

locale - the locale of the session

setContextPath

public void setContextPath(java.lang.String contextPath)

Sets the context path.

Parameters:

contextPath - the context path

getContextPath

public java.lang.String getContextPath()

Returns the context path.

Returns:

the context path

setSessionId

public void setSessionId(java.lang.String sessionId)

Sets the session's id

Parameters:

sessionId - the session's id

getSessionId

public java.lang.String getSessionId()

Returns the session's id

Returns:

the session's id

buildAll

public void buildAll()

Called from MainStd after instantiating the session to build things in arbitrary sequence.

build

protected abstract void build(SessionData sessionData)

Build part to be done by the individual session object.

Parameters:

sessionData - the session's public data

handlePostOrGetWhatever

protected void handlePostOrGetWhatever(GeneralizedRequest request,
                                       HttpServletResponse response)
                                throws java.io.IOException,
                                       ServletException

Throws:

java.io.IOException

ServletException

isToClose

public boolean isToClose()

Returns true if the session is to close.

Returns:

true if the session is to close

baseInvoke

public void baseInvoke(MustMenuBar menuBar)

Invokes the specified menu bar as the root invokable of the stack.

Parameters:

menuBar - the menu bar to invoke as root

baseInvoke

public void baseInvoke(LoginDialog login)

Invokes the specified menu bar as the root invokable of the stack.

Parameters:

menuBar - the menu bar to invoke as root

baseInvoke

public void baseInvoke(java.lang.Class<? extends Invokable> classToBeInvoked)

Instantiates the class to be invoked, which must implement the interface Invokable, and invokes it as the root of the stack.

Parameters:

classToBeInvoked - the class to be invoked

See Also:

Invokable

subInvoke

public void subInvoke(Invokable invokable)

Invokes an invokable and puts it in the next position of stack order.

Parameters:

invokable - to be invoked

backInvoke

public void backInvoke()

Goes one step back in stack and recovers the appropriate invokable.

backInvoke

public void backInvoke(int steps)

Goes one or more steps back in stack and recovers the appropriate invokable.

Parameters:

steps - the amount of steps to go back in stack

invoke

public void invoke(Invokable invokable)

Invokes an invokable and puts it in the current position of the stack order.

Parameters:

invokable - to be invoked

seemsToBeUnused

public boolean seemsToBeUnused()

Returns true if this session seems to be unused.

Returns:

true if this session seems to be unused

isOld

public boolean isOld()

Returns true if this session is old. Why do we check this? We do not kill a one and only session even if it seems to be unused. But MySQL loves to renew connections once a day. Therefore, an old session might have open tables with connection no longer valid.

Returns:

true if this session is old

destroy

public void destroy()

Destroy this object in order to free resources and weak references more early than garbage collector.

free

protected void free()

Frees (releases) references caused by this frame, particularly static register entries. To be called via destroy() to prevent multiple call. Override it to do additional releases and don't forget to call super.free() at the end.

See Also:

destroy()

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable