|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.web.jsf.FacesContextUtils
public abstract class FacesContextUtils
Convenience methods to retrieve the root WebApplicationContext for a given FacesContext. This is e.g. useful for accessing a Spring context from custom JSF code.
Analogous to Spring's WebApplicationContextUtils for the ServletContext.
ContextLoader
,
WebApplicationContextUtils
Constructor Summary | |
---|---|
FacesContextUtils()
|
Method Summary | |
---|---|
static WebApplicationContext |
getRequiredWebApplicationContext(javax.faces.context.FacesContext fc)
Find the root WebApplicationContext for this web app, which is typically loaded via ContextLoaderListener or ContextLoaderServlet. |
static Object |
getSessionMutex(javax.faces.context.FacesContext fc)
Return the best available mutex for the given session: that is, an object to synchronize on for the given session. |
static WebApplicationContext |
getWebApplicationContext(javax.faces.context.FacesContext fc)
Find the root WebApplicationContext for this web app, which is typically loaded via ContextLoaderListener or ContextLoaderServlet. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FacesContextUtils()
Method Detail |
---|
public static WebApplicationContext getWebApplicationContext(javax.faces.context.FacesContext fc)
Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.
fc
- the FacesContext to find the web application context for
null
if noneWebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE
public static WebApplicationContext getRequiredWebApplicationContext(javax.faces.context.FacesContext fc) throws IllegalStateException
Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.
fc
- the FacesContext to find the web application context for
IllegalStateException
- if the root WebApplicationContext could not be foundWebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE
public static Object getSessionMutex(javax.faces.context.FacesContext fc)
Returns the session mutex attribute if available; usually,
this means that the HttpSessionMutexListener needs to be defined
in web.xml
. Falls back to the Session reference itself
if no mutex attribute found.
The session mutex is guaranteed to be the same object during
the entire lifetime of the session, available under the key defined
by the SESSION_MUTEX_ATTRIBUTE
constant. It serves as a
safe reference to synchronize on for locking on the current session.
In many cases, the Session reference itself is a safe mutex as well, since it will always be the same object reference for the same active logical session. However, this is not guaranteed across different servlet containers; the only 100% safe way is a session mutex.
fc
- the FacesContext to find the session mutex for
null
)WebUtils.SESSION_MUTEX_ATTRIBUTE
,
HttpSessionMutexListener
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |