Package org.openxava.controller

Class ModuleContext

java.lang.Object

org.openxava.controller.ModuleContext

All Implemented Interfaces:

Serializable

public class ModuleContext
extends Object
implements Serializable

Context with life of session and private for every module.

Author:

Javier Paniza

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ModuleContext()

Method Summary

Modifier and Type	Method	Description
static void	cleanCurrentWindowId()
void	dontGenerateNewWindowIdNextTime()
boolean	exists(String application, String module, String objectName)
boolean	exists(javax.servlet.http.HttpServletRequest request, String objectName)
Object	get(String application, String module, String objectName)	If does not exist the it create one, as defined in controllers.xml.
Object	get(String application, String module, String objectName, String className)
Object	get(javax.servlet.http.HttpServletRequest request, String objectName)	Return a object associated to the specified module in 'application' and 'module' of request.
Object	get(javax.servlet.http.HttpServletRequest request, String objectName, String className)	Return a object asociate to the specified module in 'application' and 'module' of request.
Collection	getAll(String objectName)	All objects with this name in all the active modules of the user session.
Map	getContext(javax.servlet.http.HttpServletRequest request, String objectName)
String	getCurrentModule(javax.servlet.http.HttpServletRequest request)
String	getWindowId(javax.servlet.http.HttpServletRequest request)
void	put(String application, String module, String objectName, Object value)
void	put(javax.servlet.http.HttpServletRequest request, String objectName, Object value)
void	remove(String application, String module, String objectName)
void	remove(javax.servlet.http.HttpServletRequest request, String objectName)
void	resetAllModulesExceptCurrent(javax.servlet.http.HttpServletRequest request)	Reset all the context state for all the module but the current one.
void	resetModule(javax.servlet.http.HttpServletRequest request)	Reset all the context state for the module.
void	setCurrentWindowId(String id)
void	setCurrentWindowId(javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Constructor Details

ModuleContext

public ModuleContext()

Method Details

get

public Object get(javax.servlet.http.HttpServletRequest request,
 String objectName)
           throws XavaException

Return a object associated to the specified module in 'application' and 'module' of request.

Throws:

XavaException

get

public Object get(javax.servlet.http.HttpServletRequest request,
 String objectName,
 String className)
           throws XavaException

Return a object asociate to the specified module in 'application' and 'module' of request.

Throws:

XavaException

get

public Object get(String application,
 String module,
 String objectName,
 String className)
           throws XavaException

Throws:

XavaException

get

public Object get(String application,
 String module,
 String objectName)
           throws XavaException

If does not exist the it create one, as defined in controllers.xml.

Throws:

XavaException

exists

public boolean exists(String application,
 String module,
 String objectName)
               throws XavaException

Throws:

XavaException

exists

public boolean exists(javax.servlet.http.HttpServletRequest request,
 String objectName)
               throws XavaException

Throws:

XavaException

put

public void put(javax.servlet.http.HttpServletRequest request,
 String objectName,
 Object value)
         throws XavaException

Throws:

XavaException

put

public void put(String application,
 String module,
 String objectName,
 Object value)
         throws XavaException

Throws:

XavaException

remove

public void remove(javax.servlet.http.HttpServletRequest request,
 String objectName)
            throws XavaException

Throws:

XavaException

remove

public void remove(String application,
 String module,
 String objectName)
            throws XavaException

Throws:

XavaException

getCurrentModule

public String getCurrentModule(javax.servlet.http.HttpServletRequest request)

Since:

4.1.2

resetModule

public void resetModule(javax.servlet.http.HttpServletRequest request)
                 throws XavaException

Reset all the context state for the module. Actually reinit the module.

Throws:

XavaException

Since:

6.0

resetAllModulesExceptCurrent

public void resetAllModulesExceptCurrent(javax.servlet.http.HttpServletRequest request)
                                  throws XavaException

Reset all the context state for all the module but the current one. Actually reinit the modules.

Throws:

XavaException

Since:

6.0.2

getContext

public Map getContext(javax.servlet.http.HttpServletRequest request,
 String objectName)
               throws XavaException

Throws:

XavaException

getAll

public Collection getAll(String objectName)

All objects with this name in all the active modules of the user session.

getWindowId

public String getWindowId(javax.servlet.http.HttpServletRequest request)

setCurrentWindowId

public void setCurrentWindowId(javax.servlet.http.HttpServletRequest request)

setCurrentWindowId

public void setCurrentWindowId(String id)

cleanCurrentWindowId

public static void cleanCurrentWindowId()

dontGenerateNewWindowIdNextTime

public void dontGenerateNewWindowIdNextTime()