Juergen Hoeller
13 years ago
10 changed files with 29 additions and 459 deletions
@ -1,173 +0,0 @@
@@ -1,173 +0,0 @@
|
||||
/* |
||||
* Copyright 2002-2012 the original author or authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
*/ |
||||
|
||||
package org.springframework.web.jsf; |
||||
|
||||
import javax.faces.context.FacesContext; |
||||
import javax.faces.el.EvaluationException; |
||||
import javax.faces.el.VariableResolver; |
||||
|
||||
import org.apache.commons.logging.Log; |
||||
import org.apache.commons.logging.LogFactory; |
||||
|
||||
import org.springframework.beans.factory.BeanFactory; |
||||
import org.springframework.util.Assert; |
||||
import org.springframework.web.context.WebApplicationContext; |
||||
|
||||
/** |
||||
* JSF 1.1 {@code VariableResolver} that first delegates to the |
||||
* original resolver of the underlying JSF implementation (for resolving |
||||
* managed-bean objects as defined in {@code faces-config.xml} |
||||
* as well as well-known implicit EL attributes), then to the Spring |
||||
* root {@code WebApplicationContext} (for resolving Spring beans). |
||||
* |
||||
* <p>Configure this resolver in your {@code faces-config.xml} file as follows: |
||||
* |
||||
* <pre> |
||||
* <application> |
||||
* ... |
||||
* <variable-resolver>org.springframework.web.jsf.DelegatingVariableResolver</variable-resolver> |
||||
* </application></pre> |
||||
* |
||||
* All your JSF expressions can then implicitly refer to the names of |
||||
* Spring-managed service layer beans, for example in property values of |
||||
* JSF-managed beans: |
||||
* |
||||
* <pre> |
||||
* <managed-bean> |
||||
* <managed-bean-name>myJsfManagedBean</managed-bean-name> |
||||
* <managed-bean-class>example.MyJsfManagedBean</managed-bean-class> |
||||
* <managed-bean-scope>session</managed-bean-scope> |
||||
* <managed-property> |
||||
* <property-name>mySpringManagedBusinessObject</property-name> |
||||
* <value>#{mySpringManagedBusinessObject}</value> |
||||
* </managed-property> |
||||
* </managed-bean></pre> |
||||
* |
||||
* with "mySpringManagedBusinessObject" defined as Spring bean in |
||||
* applicationContext.xml: |
||||
* |
||||
* <pre> |
||||
* <bean id="mySpringManagedBusinessObject" class="example.MySpringManagedBusinessObject"> |
||||
* ... |
||||
* </bean></pre> |
||||
* |
||||
* @author Juergen Hoeller |
||||
* @since 1.1 |
||||
* @see WebApplicationContextVariableResolver |
||||
* @see FacesContextUtils#getRequiredWebApplicationContext |
||||
* @deprecated as of Spring 3.2, in favor of the JSF 1.2 based |
||||
* {@link org.springframework.web.jsf.el.SpringBeanFacesELResolver} |
||||
*/ |
||||
@Deprecated |
||||
public class DelegatingVariableResolver extends VariableResolver { |
||||
|
||||
/** Logger available to subclasses */ |
||||
protected final Log logger = LogFactory.getLog(getClass()); |
||||
|
||||
protected final VariableResolver originalVariableResolver; |
||||
|
||||
|
||||
/** |
||||
* Create a new DelegatingVariableResolver, using the given original VariableResolver. |
||||
* <p>A JSF implementation will automatically pass its original resolver into the |
||||
* constructor of a configured resolver, provided that there is a corresponding |
||||
* constructor argument. |
||||
* @param originalVariableResolver the original VariableResolver |
||||
*/ |
||||
public DelegatingVariableResolver(VariableResolver originalVariableResolver) { |
||||
Assert.notNull(originalVariableResolver, "Original JSF VariableResolver must not be null"); |
||||
this.originalVariableResolver = originalVariableResolver; |
||||
} |
||||
|
||||
/** |
||||
* Return the original JSF VariableResolver that this resolver delegates to. |
||||
* Used to resolve standard JSF-managed beans. |
||||
*/ |
||||
protected final VariableResolver getOriginalVariableResolver() { |
||||
return this.originalVariableResolver; |
||||
} |
||||
|
||||
|
||||
/** |
||||
* Delegate to the original VariableResolver first, then try to |
||||
* resolve the variable as Spring bean in the root WebApplicationContext. |
||||
*/ |
||||
@Override |
||||
public Object resolveVariable(FacesContext facesContext, String name) throws EvaluationException { |
||||
Object value = resolveOriginal(facesContext, name); |
||||
if (value != null) { |
||||
return value; |
||||
} |
||||
Object bean = resolveSpringBean(facesContext, name); |
||||
if (bean != null) { |
||||
return bean; |
||||
} |
||||
return null; |
||||
} |
||||
|
||||
/** |
||||
* Resolve the attribute via the original JSF VariableResolver. |
||||
*/ |
||||
protected Object resolveOriginal(FacesContext facesContext, String name) { |
||||
Object value = getOriginalVariableResolver().resolveVariable(facesContext, name); |
||||
if (value != null && logger.isTraceEnabled()) { |
||||
logger.trace("Successfully resolved variable '" + name + "' via original VariableResolver"); |
||||
} |
||||
return value; |
||||
} |
||||
|
||||
/** |
||||
* Resolve the attribute as a Spring bean in the ApplicationContext. |
||||
*/ |
||||
protected Object resolveSpringBean(FacesContext facesContext, String name) { |
||||
BeanFactory bf = getBeanFactory(facesContext); |
||||
if (bf.containsBean(name)) { |
||||
if (logger.isTraceEnabled()) { |
||||
logger.trace("Successfully resolved variable '" + name + "' in Spring BeanFactory"); |
||||
} |
||||
return bf.getBean(name); |
||||
} |
||||
else { |
||||
return null; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Retrieve the Spring BeanFactory to delegate bean name resolution to. |
||||
* <p>The default implementation delegates to {@code getWebApplicationContext}. |
||||
* Can be overridden to provide an arbitrary BeanFactory reference to resolve |
||||
* against; usually, this will be a full Spring ApplicationContext. |
||||
* @param facesContext the current JSF context |
||||
* @return the Spring BeanFactory (never {@code null}) |
||||
* @see #getWebApplicationContext |
||||
*/ |
||||
protected BeanFactory getBeanFactory(FacesContext facesContext) { |
||||
return getWebApplicationContext(facesContext); |
||||
} |
||||
|
||||
/** |
||||
* Retrieve the web application context to delegate bean name resolution to. |
||||
* <p>The default implementation delegates to FacesContextUtils. |
||||
* @param facesContext the current JSF context |
||||
* @return the Spring web application context (never {@code null}) |
||||
* @see FacesContextUtils#getRequiredWebApplicationContext |
||||
*/ |
||||
protected WebApplicationContext getWebApplicationContext(FacesContext facesContext) { |
||||
return FacesContextUtils.getRequiredWebApplicationContext(facesContext); |
||||
} |
||||
|
||||
} |
||||
@ -1,57 +0,0 @@
@@ -1,57 +0,0 @@
|
||||
/* |
||||
* Copyright 2002-2007 the original author or authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
*/ |
||||
|
||||
package org.springframework.web.jsf; |
||||
|
||||
import javax.faces.context.FacesContext; |
||||
import javax.faces.el.EvaluationException; |
||||
import javax.faces.el.VariableResolver; |
||||
|
||||
/** |
||||
* This is a subclass of the JSF 1.1 {@link DelegatingVariableResolver}, |
||||
* letting Spring bean definitions override other attributes of the same name. |
||||
* |
||||
* <p>The main purpose of this class is to provide behavior that is analogous |
||||
* to the JSF 1.2 {@link org.springframework.web.jsf.el.SpringBeanFacesELResolver}. |
||||
* |
||||
* @author Juergen Hoeller |
||||
* @since 2.5 |
||||
* @see WebApplicationContextVariableResolver |
||||
* @see FacesContextUtils#getRequiredWebApplicationContext |
||||
* @deprecated as of Spring 3.2, in favor of the JSF 1.2 based |
||||
* {@link org.springframework.web.jsf.el.SpringBeanFacesELResolver} |
||||
*/ |
||||
@Deprecated |
||||
public class SpringBeanVariableResolver extends DelegatingVariableResolver { |
||||
|
||||
public SpringBeanVariableResolver(VariableResolver originalVariableResolver) { |
||||
super(originalVariableResolver); |
||||
} |
||||
|
||||
@Override |
||||
public Object resolveVariable(FacesContext facesContext, String name) throws EvaluationException { |
||||
Object bean = resolveSpringBean(facesContext, name); |
||||
if (bean != null) { |
||||
return bean; |
||||
} |
||||
Object value = resolveOriginal(facesContext, name); |
||||
if (value != null) { |
||||
return value; |
||||
} |
||||
return null; |
||||
} |
||||
|
||||
} |
||||
@ -1,117 +0,0 @@
@@ -1,117 +0,0 @@
|
||||
/* |
||||
* Copyright 2002-2012 the original author or authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
*/ |
||||
|
||||
package org.springframework.web.jsf; |
||||
|
||||
import javax.faces.context.FacesContext; |
||||
import javax.faces.el.EvaluationException; |
||||
import javax.faces.el.VariableResolver; |
||||
|
||||
import org.springframework.util.Assert; |
||||
import org.springframework.web.context.WebApplicationContext; |
||||
|
||||
/** |
||||
* Special JSF 1.1 {@code VariableResolver} that exposes the Spring |
||||
* {@code WebApplicationContext} instance under a variable named |
||||
* "webApplicationContext". |
||||
* |
||||
* <p>In contrast to {@link DelegatingVariableResolver}, this VariableResolver |
||||
* does <i>not</i> resolve JSF variable names as Spring bean names. It rather |
||||
* exposes Spring's root WebApplicationContext <i>itself</i> under a special name. |
||||
* JSF-managed beans can then use Spring's WebApplicationContext API to retrieve |
||||
* Spring-managed beans, access resources, etc. |
||||
* |
||||
* <p>Configure this resolver in your {@code faces-config.xml} file as follows: |
||||
* |
||||
* <pre> |
||||
* <application> |
||||
* ... |
||||
* <variable-resolver>org.springframework.web.jsf.WebApplicationContextVariableResolver</variable-resolver> |
||||
* </application></pre> |
||||
* |
||||
* @author Colin Sampaleanu |
||||
* @author Juergen Hoeller |
||||
* @since 1.2.5 |
||||
* @see DelegatingVariableResolver |
||||
* @see FacesContextUtils#getWebApplicationContext |
||||
* @deprecated as of Spring 3.2, in favor of the JSF 1.2 based |
||||
* {@link org.springframework.web.jsf.el.WebApplicationContextFacesELResolver} |
||||
*/ |
||||
@Deprecated |
||||
public class WebApplicationContextVariableResolver extends VariableResolver { |
||||
|
||||
/** |
||||
* Name of the exposed WebApplicationContext variable: "webApplicationContext". |
||||
*/ |
||||
public static final String WEB_APPLICATION_CONTEXT_VARIABLE_NAME = "webApplicationContext"; |
||||
|
||||
|
||||
protected final VariableResolver originalVariableResolver; |
||||
|
||||
|
||||
/** |
||||
* Create a new WebApplicationContextVariableResolver, using the given |
||||
* original VariableResolver. |
||||
* <p>A JSF implementation will automatically pass its original resolver into the |
||||
* constructor of a configured resolver, provided that there is a corresponding |
||||
* constructor argument. |
||||
* @param originalVariableResolver the original VariableResolver |
||||
*/ |
||||
public WebApplicationContextVariableResolver(VariableResolver originalVariableResolver) { |
||||
Assert.notNull(originalVariableResolver, "Original JSF VariableResolver must not be null"); |
||||
this.originalVariableResolver = originalVariableResolver; |
||||
} |
||||
|
||||
/** |
||||
* Return the original JSF VariableResolver that this resolver delegates to. |
||||
* Used to resolve standard JSF-managed beans. |
||||
*/ |
||||
protected final VariableResolver getOriginalVariableResolver() { |
||||
return this.originalVariableResolver; |
||||
} |
||||
|
||||
|
||||
/** |
||||
* Check for the special "webApplicationContext" variable first, |
||||
* then delegate to the original VariableResolver. |
||||
* <p>If no WebApplicationContext is available, all requests |
||||
* will be delegated to the original VariableResolver. |
||||
*/ |
||||
@Override |
||||
public Object resolveVariable(FacesContext context, String name) throws EvaluationException { |
||||
Object value = null; |
||||
if (WEB_APPLICATION_CONTEXT_VARIABLE_NAME.equals(name)) { |
||||
value = getWebApplicationContext(context); |
||||
} |
||||
if (value == null) { |
||||
value = getOriginalVariableResolver().resolveVariable(context, name); |
||||
} |
||||
return value; |
||||
} |
||||
|
||||
/** |
||||
* Retrieve the WebApplicationContext reference to expose. |
||||
* <p>The default implementation delegates to FacesContextUtils, |
||||
* returning {@code null} if no WebApplicationContext found. |
||||
* @param facesContext the current JSF context |
||||
* @return the Spring web application context |
||||
* @see FacesContextUtils#getWebApplicationContext |
||||
*/ |
||||
protected WebApplicationContext getWebApplicationContext(FacesContext facesContext) { |
||||
return FacesContextUtils.getWebApplicationContext(facesContext); |
||||
} |
||||
|
||||
} |
||||
@ -1,12 +1,9 @@
@@ -1,12 +1,9 @@
|
||||
|
||||
/** |
||||
* |
||||
* Support classes for integrating a JSF 1.2 web tier with a Spring middle tier |
||||
* ELResolvers for integrating a JSF web tier with a Spring middle tier |
||||
* which is hosted in a Spring root WebApplicationContext. |
||||
* |
||||
* <p>Supports JSF 1.2's ELResolver mechanism, providing closer integration |
||||
* than JSF 1.1's VariableResolver mechanism allowed for. |
||||
* |
||||
*/ |
||||
package org.springframework.web.jsf.el; |
||||
|
||||
|
||||
@ -1,87 +0,0 @@
@@ -1,87 +0,0 @@
|
||||
/* |
||||
* Copyright 2002-2013 the original author or authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
*/ |
||||
|
||||
package org.springframework.web.jsf; |
||||
|
||||
import javax.faces.context.FacesContext; |
||||
import javax.faces.el.EvaluationException; |
||||
import javax.faces.el.VariableResolver; |
||||
|
||||
import junit.framework.TestCase; |
||||
|
||||
import org.springframework.tests.sample.beans.TestBean; |
||||
import org.springframework.web.context.WebApplicationContext; |
||||
import org.springframework.web.context.support.StaticWebApplicationContext; |
||||
|
||||
/** |
||||
* @author Juergen Hoeller |
||||
* @since 02.08.2004 |
||||
*/ |
||||
@Deprecated |
||||
public class DelegatingVariableResolverTests extends TestCase { |
||||
|
||||
public void testDelegatingVariableResolver() { |
||||
final StaticWebApplicationContext wac = new StaticWebApplicationContext(); |
||||
wac.registerSingleton("bean1", TestBean.class, null); |
||||
wac.registerSingleton("var1", TestBean.class, null); |
||||
wac.refresh(); |
||||
TestBean bean1 = (TestBean) wac.getBean("bean1"); |
||||
|
||||
// We need to override the getWebApplicationContext method here:
|
||||
// FacesContext and ExternalContext are hard to mock.
|
||||
DelegatingVariableResolver resolver = new DelegatingVariableResolver(new OriginalVariableResolver()) { |
||||
@Override |
||||
protected WebApplicationContext getWebApplicationContext(FacesContext facesContext) { |
||||
return wac; |
||||
} |
||||
}; |
||||
assertEquals(bean1, resolver.resolveVariable(null, "bean1")); |
||||
assertEquals("val1", resolver.resolveVariable(null, "var1")); |
||||
} |
||||
|
||||
public void testSpringBeanVariableResolver() { |
||||
final StaticWebApplicationContext wac = new StaticWebApplicationContext(); |
||||
wac.registerSingleton("bean1", TestBean.class, null); |
||||
wac.registerSingleton("var1", TestBean.class, null); |
||||
wac.refresh(); |
||||
TestBean bean1 = (TestBean) wac.getBean("bean1"); |
||||
TestBean var1 = (TestBean) wac.getBean("var1"); |
||||
|
||||
// We need to override the getWebApplicationContext method here:
|
||||
// FacesContext and ExternalContext are hard to mock.
|
||||
SpringBeanVariableResolver resolver = new SpringBeanVariableResolver(new OriginalVariableResolver()) { |
||||
@Override |
||||
protected WebApplicationContext getWebApplicationContext(FacesContext facesContext) { |
||||
return wac; |
||||
} |
||||
}; |
||||
assertEquals(bean1, resolver.resolveVariable(null, "bean1")); |
||||
assertEquals(var1, resolver.resolveVariable(null, "var1")); |
||||
} |
||||
|
||||
|
||||
private static class OriginalVariableResolver extends VariableResolver { |
||||
|
||||
@Override |
||||
public Object resolveVariable(FacesContext facesContext, String name) throws EvaluationException { |
||||
if ("var1".equals(name)) { |
||||
return "val1"; |
||||
} |
||||
return null; |
||||
} |
||||
} |
||||
|
||||
} |
||||
Loading…
Reference in new issue