com.archibus.context

Class Context

java.lang.Object

com.archibus.context.Context

All Implemented Interfaces:

java.lang.Cloneable

public class Context
extends java.lang.Object
implements java.lang.Cloneable

Thread-bound context. Since each HTTP request is handled by a separate thread, each context instance is associated with HTTP request.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.enterprisedt.util.debug.Logger	logger Logger for this class and subclasses

Constructor Summary

Constructors

Constructor and Description
Context()

Method Summary

Modifier and Type	Method and Description
void	addDisabledEventListenerClass(java.lang.Class eventListenerClass)
void	addTableName(java.lang.String name)
java.lang.Object	clone() Returns a copy of this Context instance: some fields are cloned, some are shared.
boolean	containsBean(java.lang.String name) Return true if specified bean exists in the Spring application context.
java.lang.Object	get(java.lang.String beanName)
org.springframework.context.ApplicationContext	getApplicationContext()
java.lang.String	getBaseURL() Getter for the baseURL property.
java.lang.Object	getBean(java.lang.String name) Returns an instance, which may be shared or independent, of the specified bean.
java.util.HashMap<java.lang.String,java.lang.Object>	getBeanNamesToObjects()
com.archibus.config.ConfigManager.Immutable	getConfigManager()
java.lang.String	getContextPath()
com.archibus.config.ContextCacheable.Immutable	getCurrentContext() Gets the currentContext attribute of the Context object
com.archibus.config.Database.Immutable	getDatabase()
com.archibus.db.DbConnection.ThreadSafe	getDbConnection()
java.util.List<java.lang.Class>	getDisabledEventListenerClasses()
java.lang.Object	getEventHandler(java.lang.String name) Returns the event handler specified by name.
EventHandlerContext	getEventHandlerContext()
java.lang.Throwable	getException()
javax.servlet.http.HttpSession	getHttpSession()
JobManager.ThreadSafe	getJobManager() Returns the JobManager instance.
com.archibus.model.licensing.LicenseManager	getLicenseManager()
java.util.Locale	getLocale()
java.lang.String	getNextRequest()
com.archibus.config.Project.Immutable	getProject()
java.lang.String	getRealContextPath()
javax.servlet.http.HttpServletRequest	getRequest()
java.lang.String	getRequestURL()
javax.servlet.http.HttpServletResponse	getResponse()
com.archibus.context.DatabaseRole	getRole()
static com.archibus.context.DatabaseRole[]	getRoles()
com.archibus.servletx.controller.SecurityController	getSecurityController()
com.archibus.context.Session	getSession()
java.util.List<java.lang.String>	getTableNames()
com.archibus.context.TransactionInfos	getTransactionInfos()
com.archibus.context.User	getUser()
com.archibus.security.UserAccount.Immutable	getUserAccount()
com.archibus.config.UserSession.Immutable	getUserSession()
com.archibus.context.UserSessionDto	getUserSessionDto()
com.archibus.config.Version	getVersion() Getter for the version property.
java.lang.String	getWebAppPath()
boolean	isDebug()
void	onUserSessionChange(com.archibus.config.UserSession.Immutable userSession) Description of the Method
void	put(java.lang.String key, java.lang.Object value)
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)
void	remove(java.lang.String beanName)
void	removeDisabledEventListenerClass(java.lang.Class eventListenerClass)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setBaseURL(java.lang.String baseURL) Setter for the baseURL property.
void	setConfigManager(com.archibus.config.ConfigManager.Immutable configManager)
void	setContextPath(java.lang.String contextPath)
void	setDbConnection(com.archibus.db.DbConnection.ThreadSafe dbConnection)
void	setDebug(boolean debug)
void	setEventHandlerContext(EventHandlerContext eventHandlerContext)
void	setException(java.lang.Throwable exception)
void	setHttpSession(javax.servlet.http.HttpSession httpSession)
void	setLicenseManager(com.archibus.model.licensing.LicenseManager licenseManager)
void	setLocale(java.util.Locale locale)
void	setNextRequest(java.lang.String nextRequest)
void	setProject(com.archibus.config.Project.Immutable project)
void	setRealContextPath(java.lang.String realContextPath)
void	setRequest(javax.servlet.http.HttpServletRequest request)
void	setRequestURL(java.lang.String url)
void	setResponse(javax.servlet.http.HttpServletResponse response)
void	setRole(com.archibus.context.DatabaseRole role)
void	setSecurityController(com.archibus.servletx.controller.SecurityController securityController)
void	setSession(com.archibus.context.Session session)
void	setTransactionInfos(com.archibus.context.TransactionInfos transactionInfos)
void	setUser(com.archibus.context.User user)
void	setUserAccount(com.archibus.security.UserAccount.Immutable userAccount)
void	setUserSession(com.archibus.config.UserSession.Immutable userSession)
void	setUserSessionDto(com.archibus.context.UserSessionDto userSessionDto)
void	setVersion(com.archibus.config.Version version) Setter for the version property.
void	setWebAppPath(java.lang.String webAppPath)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final com.enterprisedt.util.debug.Logger logger

Logger for this class and subclasses

Constructor Detail

Context

public Context()

Method Detail

clone

public java.lang.Object clone()

Returns a copy of this Context instance: some fields are cloned, some are shared.

Overrides:

clone in class java.lang.Object

Returns:

a shallow/deep copy of this object.

getRoles

public static com.archibus.context.DatabaseRole[] getRoles()

addDisabledEventListenerClass

public void addDisabledEventListenerClass(java.lang.Class eventListenerClass)

addTableName

public void addTableName(java.lang.String name)

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Returns:

the applicationContext

getBean

public java.lang.Object getBean(java.lang.String name)
                         throws org.springframework.beans.BeansException

Returns an instance, which may be shared or independent, of the specified bean. The call will be delegated to the Spring applicationContext.

BeanFactory.getBean(String)

Parameters:

name - the name of the bean to retrieve.

Returns:

an instance of the bean.

Throws:

org.springframework.beans.factory.NoSuchBeanDefinitionException - if there is no bean definition with the specified name.

org.springframework.beans.BeansException - if the bean could not be obtained.

containsBean

public boolean containsBean(java.lang.String name)

Return true if specified bean exists in the Spring application context. The call will be delegated to the Spring applicationContext.

BeanFactory.containsBean(String)

Parameters:

name - The bean name.

Returns:

True if the bean exists.

getConfigManager

public com.archibus.config.ConfigManager.Immutable getConfigManager()

Returns:

the configManager

getContextPath

public java.lang.String getContextPath()

Returns:

the contextPath

getCurrentContext

public com.archibus.config.ContextCacheable.Immutable getCurrentContext()

Gets the currentContext attribute of the Context object

Returns:

The currentContext value

getDatabase

public com.archibus.config.Database.Immutable getDatabase()

getDbConnection

public com.archibus.db.DbConnection.ThreadSafe getDbConnection()

getDisabledEventListenerClasses

public java.util.List<java.lang.Class> getDisabledEventListenerClasses()

getEventHandler

public java.lang.Object getEventHandler(java.lang.String name)

Returns the event handler specified by name. The event handler can be defined as a Spring service bean, or loaded by the WFR container from the afm-wf_rules table. This methos first checks the Spring application context, and if the bean is not found there, it checks the WFR container.

Parameters:

name - the event handler name, e.q. CostService.

Returns:

the event handler instance

Throws:

com.archibus.utility.ExceptionBase

getEventHandlerContext

public EventHandlerContext getEventHandlerContext()

getException

public java.lang.Throwable getException()

Returns:

the exception

getHttpSession

public javax.servlet.http.HttpSession getHttpSession()

Returns:

the httpSession

getJobManager

public JobManager.ThreadSafe getJobManager()

Returns the JobManager instance.

Parameters:

context -

Returns:

getLicenseManager

public com.archibus.model.licensing.LicenseManager getLicenseManager()

Returns:

the licenseManager

getLocale

public java.util.Locale getLocale()

Returns:

the locale

getNextRequest

public java.lang.String getNextRequest()

Returns:

the nextRequest

getProject

public com.archibus.config.Project.Immutable getProject()

Returns:

the project

getRealContextPath

public java.lang.String getRealContextPath()

Returns:

the realContextPath

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns:

the request

getRequestURL

public java.lang.String getRequestURL()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Returns:

the response

getRole

public com.archibus.context.DatabaseRole getRole()

getSecurityController

public com.archibus.servletx.controller.SecurityController getSecurityController()

Returns:

the securityController

getSession

public com.archibus.context.Session getSession()

Returns:

the session

getTableNames

public java.util.List<java.lang.String> getTableNames()

getTransactionInfos

public com.archibus.context.TransactionInfos getTransactionInfos()

getUser

public com.archibus.context.User getUser()

getUserAccount

public com.archibus.security.UserAccount.Immutable getUserAccount()

Returns:

the userAccount

getUserSession

public com.archibus.config.UserSession.Immutable getUserSession()

Returns:

the userSession

getUserSessionDto

public com.archibus.context.UserSessionDto getUserSessionDto()

Returns:

the userSessionDto

getWebAppPath

public java.lang.String getWebAppPath()

Returns:

the webAppPath

isDebug

public boolean isDebug()

Returns:

the debug

onUserSessionChange

public void onUserSessionChange(com.archibus.config.UserSession.Immutable userSession)

Description of the Method

Parameters:

userSession - Description of the Parameter

removeDisabledEventListenerClass

public void removeDisabledEventListenerClass(java.lang.Class eventListenerClass)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Parameters:

applicationContext - the applicationContext to set

setConfigManager

public void setConfigManager(com.archibus.config.ConfigManager.Immutable configManager)

Parameters:

configManager - the configManager to set

setContextPath

public void setContextPath(java.lang.String contextPath)

Parameters:

contextPath - the contextPath to set

setDbConnection

public void setDbConnection(com.archibus.db.DbConnection.ThreadSafe dbConnection)

setDebug

public void setDebug(boolean debug)

Parameters:

debug - the debug to set

setEventHandlerContext

public void setEventHandlerContext(EventHandlerContext eventHandlerContext)

setException

public void setException(java.lang.Throwable exception)

Parameters:

exception - the exception to set

setHttpSession

public void setHttpSession(javax.servlet.http.HttpSession httpSession)

Parameters:

httpSession - the httpSession to set

setLicenseManager

public void setLicenseManager(com.archibus.model.licensing.LicenseManager licenseManager)

Parameters:

licenseManager - the licenseManager to set

setLocale

public void setLocale(java.util.Locale locale)

Parameters:

locale - the locale to set

setNextRequest

public void setNextRequest(java.lang.String nextRequest)

setProject

public void setProject(com.archibus.config.Project.Immutable project)

Parameters:

project - the project to set

setRealContextPath

public void setRealContextPath(java.lang.String realContextPath)

Parameters:

realContextPath - the realContextPath to set

setRequest

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

Parameters:

request - the request to set

setRequestURL

public void setRequestURL(java.lang.String url)

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse response)

Parameters:

response - the response to set

setRole

public void setRole(com.archibus.context.DatabaseRole role)

setSecurityController

public void setSecurityController(com.archibus.servletx.controller.SecurityController securityController)

Parameters:

securityController - the securityController to set

setSession

public void setSession(com.archibus.context.Session session)

Parameters:

session - the session to set

setTransactionInfos

public void setTransactionInfos(com.archibus.context.TransactionInfos transactionInfos)

setUser

public void setUser(com.archibus.context.User user)

setUserAccount

public void setUserAccount(com.archibus.security.UserAccount.Immutable userAccount)

Parameters:

userAccount - the userAccount to set

setUserSession

public void setUserSession(com.archibus.config.UserSession.Immutable userSession)

Parameters:

userSession - the userSession to set

setUserSessionDto

public void setUserSessionDto(com.archibus.context.UserSessionDto userSessionDto)

setWebAppPath

public void setWebAppPath(java.lang.String webAppPath)

Parameters:

webAppPath - the webAppPath to set

get

public java.lang.Object get(java.lang.String beanName)

remove

public void remove(java.lang.String beanName)

getBeanNamesToObjects

public java.util.HashMap<java.lang.String,java.lang.Object> getBeanNamesToObjects()

Returns:

the beanNamesToObjects

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)

put

public void put(java.lang.String key,
                java.lang.Object value)

getBaseURL

public java.lang.String getBaseURL()

Getter for the baseURL property.

Returns:

the baseURL property.

setBaseURL

public void setBaseURL(java.lang.String baseURL)

Setter for the baseURL property.

Parameters:

baseURL - the baseURL to set.

getVersion

public com.archibus.config.Version getVersion()

Getter for the version property.

Returns:

the version property.

setVersion

public void setVersion(com.archibus.config.Version version)

Setter for the version property.

Parameters:

version - the version to set.