de.innovationgate.wgpublisher.webtml.env

Class WebTMLContextEnvironment

java.lang.Object

de.innovationgate.wgpublisher.webtml.env.WebTMLContextEnvironment

All Implemented Interfaces:

TMLContextEnvironment

public class WebTMLContextEnvironment
extends java.lang.Object
implements TMLContextEnvironment

Nested Class Summary

Nested classes/interfaces inherited from interface de.innovationgate.wgpublisher.webtml.utils.TMLContextEnvironment

TMLContextEnvironment.RootEnvironmentUserData

Constructor Summary

Constructors

Constructor and Description
WebTMLContextEnvironment(TMLContext mainContext, javax.servlet.jsp.PageContext pageContext)

Method Summary

Methods

Modifier and Type	Method and Description
de.innovationgate.webgate.api.WGDatabase	fetchDB(java.lang.String dbKey)
java.util.Map<java.lang.String,TMLAction>	getActionRegistration()
WGACore	getCore()
TMLForm	getForm() Return the "current" form of the WebTML environment
org.apache.log4j.Logger	getLog()
TMLContext	getMainContext()
de.innovationgate.webgate.api.WGDatabase	getMainDesignDB()
javax.servlet.jsp.PageContext	getPageContext()
java.util.Map<java.lang.String,java.lang.Object>	getPageVars()
java.util.Map<java.lang.String,TMLForm>	getPersistentForms()
ProcessContextRegistration	getProcessContextRegistration()
java.lang.String	getPublisherURL()
javax.servlet.http.HttpServletRequest	getRequest()
javax.servlet.http.HttpServletResponse	getResponse()
TMLContextEnvironment.RootEnvironmentUserData	getRootEnvironmentUserData() Returns data about the user that is responsible for creating and using calling this environment Must return null if there this is the root environment.
javax.servlet.http.HttpSession	getSession()
java.util.Map<java.lang.String,de.innovationgate.utils.TransientObjectWrapper<java.lang.Object>>	getSessionVars()
TMLContext	getTMLContextForDocument(TMLContext parentContext, de.innovationgate.webgate.api.WGDocument doc)
java.util.Map<java.lang.String,TMLForm>	getTransientForms()
WGAURLBuilder	getURLBuilder()
TMLUserProfile	getUserProfile(de.innovationgate.webgate.api.WGDatabase db)
java.util.List<Warning>	getWarnings()
void	importEnvironmentData(TMLContext context, boolean includeIntrusiveData) Import data from another context.
boolean	isPageContextAvailable()
boolean	isWebEnvironment()
de.innovationgate.webgate.api.WGDatabase	openDB(de.innovationgate.webgate.api.WGDatabase db)
void	removeForm(java.lang.String id)
void	setForm(TMLForm form)
void	setLog(org.apache.log4j.Logger log)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebTMLContextEnvironment

public WebTMLContextEnvironment(TMLContext mainContext,
                        javax.servlet.jsp.PageContext pageContext)

Method Detail

getActionRegistration

public java.util.Map<java.lang.String,TMLAction> getActionRegistration()

Specified by:

getActionRegistration in interface TMLContextEnvironment

getCore

public WGACore getCore()

Specified by:

getCore in interface TMLContextEnvironment

getForm

public TMLForm getForm()

Description copied from interface: TMLContextEnvironment

Return the "current" form of the WebTML environment

Specified by:

getForm in interface TMLContextEnvironment

getMainContext

public TMLContext getMainContext()

Specified by:

getMainContext in interface TMLContextEnvironment

getSessionVars

public java.util.Map<java.lang.String,de.innovationgate.utils.TransientObjectWrapper<java.lang.Object>> getSessionVars()

Specified by:

getSessionVars in interface TMLContextEnvironment

getTMLContextForDocument

public TMLContext getTMLContextForDocument(TMLContext parentContext,
                                  de.innovationgate.webgate.api.WGDocument doc)

Specified by:

getTMLContextForDocument in interface TMLContextEnvironment

getUserProfile

public TMLUserProfile getUserProfile(de.innovationgate.webgate.api.WGDatabase db)

Specified by:

getUserProfile in interface TMLContextEnvironment

getPageVars

public java.util.Map<java.lang.String,java.lang.Object> getPageVars()

Specified by:

getPageVars in interface TMLContextEnvironment

getWarnings

public java.util.List<Warning> getWarnings()

Specified by:

getWarnings in interface TMLContextEnvironment

importEnvironmentData

public void importEnvironmentData(TMLContext context,
                         boolean includeIntrusiveData)
                           throws TMLException

Description copied from interface: TMLContextEnvironment

Import data from another context. Useful if this environment cannot fetch data from the WebTML request, but relies on its data

Specified by:

importEnvironmentData in interface TMLContextEnvironment

Parameters:

context - The context to read data from.

includeIntrusiveData - Whether to include data from the execution of WebTML code, like vars. False means that just environment information is imported, so the context remains independent.

Throws:

TMLException

setForm

public void setForm(TMLForm form)

Specified by:

setForm in interface TMLContextEnvironment

getPersistentForms

public java.util.Map<java.lang.String,TMLForm> getPersistentForms()

Specified by:

getPersistentForms in interface TMLContextEnvironment

getTransientForms

public java.util.Map<java.lang.String,TMLForm> getTransientForms()

Specified by:

getTransientForms in interface TMLContextEnvironment

isPageContextAvailable

public boolean isPageContextAvailable()

Specified by:

isPageContextAvailable in interface TMLContextEnvironment

isWebEnvironment

public boolean isWebEnvironment()

Specified by:

isWebEnvironment in interface TMLContextEnvironment

getMainDesignDB

public de.innovationgate.webgate.api.WGDatabase getMainDesignDB()

Specified by:

getMainDesignDB in interface TMLContextEnvironment

openDB

public de.innovationgate.webgate.api.WGDatabase openDB(de.innovationgate.webgate.api.WGDatabase db)
                                                throws de.innovationgate.webgate.api.WGException

Specified by:

openDB in interface TMLContextEnvironment

Throws:

de.innovationgate.webgate.api.WGException

fetchDB

public de.innovationgate.webgate.api.WGDatabase fetchDB(java.lang.String dbKey)

Specified by:

fetchDB in interface TMLContextEnvironment

getProcessContextRegistration

public ProcessContextRegistration getProcessContextRegistration()

Specified by:

getProcessContextRegistration in interface TMLContextEnvironment

getRootEnvironmentUserData

public TMLContextEnvironment.RootEnvironmentUserData getRootEnvironmentUserData()

Description copied from interface: TMLContextEnvironment

Returns data about the user that is responsible for creating and using calling this environment Must return null if there this is the root environment.

Specified by:

getRootEnvironmentUserData in interface TMLContextEnvironment

removeForm

public void removeForm(java.lang.String id)

Specified by:

removeForm in interface TMLContextEnvironment

getPageContext

public javax.servlet.jsp.PageContext getPageContext()

Specified by:

getPageContext in interface TMLContextEnvironment

getPublisherURL

public java.lang.String getPublisherURL()

Specified by:

getPublisherURL in interface TMLContextEnvironment

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Specified by:

getRequest in interface TMLContextEnvironment

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Specified by:

getResponse in interface TMLContextEnvironment

getSession

public javax.servlet.http.HttpSession getSession()

Specified by:

getSession in interface TMLContextEnvironment

getURLBuilder

public WGAURLBuilder getURLBuilder()

Specified by:

getURLBuilder in interface TMLContextEnvironment

getLog

public org.apache.log4j.Logger getLog()

Specified by:

getLog in interface TMLContextEnvironment

setLog

public void setLog(org.apache.log4j.Logger log)

Specified by:

setLog in interface TMLContextEnvironment