|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.faces.application.NavigationHandler org.springframework.web.jsf.DelegatingNavigationHandlerProxy
public class DelegatingNavigationHandlerProxy
JSF NavigationHandler implementation that delegates to a NavigationHandler bean obtained from the Spring root WebApplicationContext.
Configure this handler proxy in your faces-config.xml
file
as follows:
<application> ... <navigation-handler> org.springframework.web.jsf.DelegatingNavigationHandlerProxy </navigation-handler> ... </application>By default, the Spring ApplicationContext will be searched for the NavigationHandler under the bean name "jsfNavigationHandler". In the simplest case, this is a plain Spring bean definition like the following. However, all of Spring's bean configuration power can be applied to such a bean, in particular all flavors of dependency injection.
<bean name="jsfNavigationHandler" class="mypackage.MyNavigationHandler"> <property name="myProperty" ref="myOtherBean"/> </bean>The target NavigationHandler bean will typically extend the standard JSF NavigationHandler class. However, note that decorating the original NavigationHandler (the JSF provider's default handler) is not supported in such a scenario, since we can't inject the original handler in standard JSF style (that is, as constructor argument).
For decorating the original NavigationHandler, make sure that your target bean extends Spring's DecoratingNavigationHandler class. This allows to pass in the original handler as method argument, which this proxy automatically detects. Note that a DecoratingNavigationHandler subclass will still work as standard JSF NavigationHandler as well!
This proxy may be subclassed to change the bean name used to search for the
navigation handler, change the strategy used to obtain the target handler,
or change the strategy used to access the ApplicationContext (normally obtained
via FacesContextUtils.getWebApplicationContext(FacesContext)
).
DecoratingNavigationHandler
Field Summary | |
---|---|
static String |
DEFAULT_TARGET_BEAN_NAME
Default name of the target bean in the Spring application context: "jsfNavigationHandler" |
Constructor Summary | |
---|---|
DelegatingNavigationHandlerProxy()
Create a new DelegatingNavigationHandlerProxy. |
|
DelegatingNavigationHandlerProxy(javax.faces.application.NavigationHandler originalNavigationHandler)
Create a new DelegatingNavigationHandlerProxy. |
Method Summary | |
---|---|
protected BeanFactory |
getBeanFactory(javax.faces.context.FacesContext facesContext)
Retrieve the Spring BeanFactory to delegate bean name resolution to. |
protected javax.faces.application.NavigationHandler |
getDelegate(javax.faces.context.FacesContext facesContext)
Return the target NavigationHandler to delegate to. |
protected String |
getTargetBeanName(javax.faces.context.FacesContext facesContext)
Return the name of the target NavigationHandler bean in the BeanFactory. |
protected WebApplicationContext |
getWebApplicationContext(javax.faces.context.FacesContext facesContext)
Retrieve the web application context to delegate bean name resolution to. |
void |
handleNavigation(javax.faces.context.FacesContext facesContext,
String fromAction,
String outcome)
Handle the navigation request implied by the specified parameters, through delegating to the target bean in the Spring application context. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_TARGET_BEAN_NAME
Constructor Detail |
---|
public DelegatingNavigationHandlerProxy()
public DelegatingNavigationHandlerProxy(javax.faces.application.NavigationHandler originalNavigationHandler)
originalNavigationHandler
- the original NavigationHandlerMethod Detail |
---|
public void handleNavigation(javax.faces.context.FacesContext facesContext, String fromAction, String outcome)
The target bean needs to extend the JSF NavigationHandler class.
If it extends Spring's DecoratingNavigationHandler, the overloaded
handleNavigation
method with the original NavigationHandler
as argument will be used. Else, the standard handleNavigation
method will be called.
handleNavigation
in class javax.faces.application.NavigationHandler
protected javax.faces.application.NavigationHandler getDelegate(javax.faces.context.FacesContext facesContext)
By default, a bean with the name "jsfNavigationHandler" is obtained from the Spring root WebApplicationContext, for every invocation.
facesContext
- the current JSF context
getTargetBeanName(javax.faces.context.FacesContext)
,
getBeanFactory(javax.faces.context.FacesContext)
protected String getTargetBeanName(javax.faces.context.FacesContext facesContext)
facesContext
- the current JSF context
protected BeanFactory getBeanFactory(javax.faces.context.FacesContext facesContext)
Default implementation delegates to getWebApplicationContext
.
Can be overridden to provide an arbitrary BeanFactory reference to resolve
against; usually, this will be a full Spring ApplicationContext.
facesContext
- the current JSF context
null
)getWebApplicationContext(javax.faces.context.FacesContext)
protected WebApplicationContext getWebApplicationContext(javax.faces.context.FacesContext facesContext)
Default implementation delegates to FacesContextUtils.
facesContext
- the current JSF context
null
)FacesContextUtils.getRequiredWebApplicationContext(javax.faces.context.FacesContext)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |