de.must.markup

Class JspSessionStd

java.lang.Object

de.must.markup.JspSessionStd

public abstract class JspSessionStd
extends java.lang.Object

Manager of the JSP session - independent from Servlet specifications. Provider of "butlers" - one butler for each JSP is produced. May control live cycle of assigned objects: Objects may be particularly freed before the session is completely invalidated. Manages locale specific languages. Avoids visible parameters in URL: if cookies are disabled, only the session ID has to be passed by parameters, all other parameters may be handled here. JavaServerPages which like to use this session option should begin like this:

 <%@ page import = "mypackage.JspSession" %>
 
 <% jspSession.takeNote(request); %>

 <%@ page import = "mypackage.JspNameButler" %>
 <% JspNameButler butler = (JspNameButler)jspSession.getButler(JspNameButler.class); %>

 <% if (butler.workCausesReturn(request, response)) return;%>
 

mypackage.JspSession must extend de.must.markup.JspSessionStd takeNote gives the session the chance to know the specific locale. It's recommended to name the JspNameButler like the JSP plus "Butler".

See Also:

JspButler

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Hashtable<java.lang.String,JspButler>	butlers
protected SessionData	sessionData The session's public data.

Constructor Summary

Constructors

Constructor and Description
JspSessionStd() Constructs a new JSP session.

Method Summary

Modifier and Type	Method and Description
protected abstract void	afterInitialDBConnection()
void	clearButlers() Clears all cached butlers
protected SessionData	createSessionData() Constructs session data.
void	destroy() Destroy this object in order to free resources and weak references more early than garbage collector.
protected void	finalize()
JspButler	getButler(java.lang.Class<? extends JspButler> butlerClass) Creates a singleton JSP butler of the class as specified and returns it.
protected abstract ConnectionSpecification	getConnectionSpecification(java.lang.String realPath)
protected abstract GlobalStd	getGlobal() Returns the application's specific global objects class.
protected abstract java.util.ResourceBundle	getResourceBundle(java.util.Locale locale) Returns the resource bundle for the locale as specified.
boolean	isWindowSeparating() Returns the windowSeparating.
protected void	rebuildDueToNewDBConnection() Things to do after database connection has been rebuild to avoid 'No operations allowed after connection closed
static void	setAutomaticButlerCacheReorganization(boolean newAutomaticButlerCacheReorganization) Determines whether or not butler cache shall be reorganized automatically.
static void	setUseSeperateConnectionsForEachSession(boolean newSeparateConnections) Determines whether each session should use its own database connection or not.
void	setWindowSeparating(boolean windowSeparating) Activates the window separating.
void	takeNote(HttpServletRequest request) To be called by the JSP each time the JSP is loaded.

Methods inherited from class java.lang.Object

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

Field Detail

sessionData

protected SessionData sessionData

The session's public data.

butlers

public java.util.Hashtable<java.lang.String,JspButler> butlers

Constructor Detail

JspSessionStd

public JspSessionStd()

Constructs a new JSP session. If the persistence functionality is to be used, main database connection is created or reactivated.

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

setAutomaticButlerCacheReorganization

public static void setAutomaticButlerCacheReorganization(boolean newAutomaticButlerCacheReorganization)

Determines whether or not butler cache shall be reorganized automatically.

Parameters:

newAutomaticButlerCacheReorganization - whether or not butler cache shall be reorganized automatically

See Also:

JspButler.getButlerFriends()

rebuildDueToNewDBConnection

protected void rebuildDueToNewDBConnection()

Things to do after database connection has been rebuild to avoid 'No operations allowed after connection closed.' - override it if there are any special data objects.

createSessionData

protected SessionData createSessionData()

Constructs session data. Override to assign session data with additional fields for the specific application.

Returns:

session data

isWindowSeparating

public boolean isWindowSeparating()

Returns the windowSeparating.

Returns:

boolean

setWindowSeparating

public void setWindowSeparating(boolean windowSeparating)

Activates the window separating. This feature allows to separate different instances of the same butler class in one session. Thus, the browser's behavior of treating multiple browser windows as a single session can be harmonized with need of separating two butler instances. This is essential if you want to leave two ore more administration JSPs open. Thus, the different GroupOfStorables may remain their individual former values. needs hidden field "windownbr":

Parameters:

windowSeparating - The windowSeparating to set

takeNote

public void takeNote(HttpServletRequest request)

To be called by the JSP each time the JSP is loaded. Helps providing the appropriate resource bundle and the back button among others.

getConnectionSpecification

protected abstract ConnectionSpecification getConnectionSpecification(java.lang.String realPath)

afterInitialDBConnection

protected abstract void afterInitialDBConnection()

clearButlers

public void clearButlers()

Clears all cached butlers

getButler

public JspButler getButler(java.lang.Class<? extends JspButler> butlerClass)

Creates a singleton JSP butler of the class as specified and returns it. Butler's init method is called each time the butler is newly used. This is the case when the previous butler is different and this previous butler is not modal. Sample: an error page may be modal. Thus, values already inputed are may not be initialized, when control comes back to the page.

Parameters:

butlerClass - the wished butlers class

Returns:

a singleton JSP butler

getGlobal

protected abstract GlobalStd getGlobal()

Returns the application's specific global objects class.

Returns:

the application's specific global objects class

getResourceBundle

protected abstract java.util.ResourceBundle getResourceBundle(java.util.Locale locale)

Returns the resource bundle for the locale as specified.

Returns:

the resource bundle

destroy

public void destroy()

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

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable