You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by gp...@apache.org on 2011/04/05 23:43:16 UTC
svn commit: r1089246 - in /myfaces/extensions/cdi/trunk:
core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/
core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/config/
core/impl/src/ma...
Author: gpetracek
Date: Tue Apr 5 21:43:15 2011
New Revision: 1089246
URL: http://svn.apache.org/viewvc?rev=1089246&view=rev
Log:
EXTCDI-100 conversation-required support for page-beans (second draft)
Added:
myfaces/extensions/cdi/trunk/core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/ConversationRequired.java
Modified:
myfaces/extensions/cdi/trunk/core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/config/ConversationConfig.java
myfaces/extensions/cdi/trunk/core/impl/src/main/java/org/apache/myfaces/extensions/cdi/core/impl/util/CodiUtils.java
myfaces/extensions/cdi/trunk/jee-modules/jsf-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf/impl/listener/phase/CodiLifecycleWrapper.java
myfaces/extensions/cdi/trunk/jee-modules/jsf-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf/impl/util/JsfUtils.java
myfaces/extensions/cdi/trunk/jee-modules/jsf20-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf2/impl/listener/phase/CodiLifecycleWrapper.java
Added: myfaces/extensions/cdi/trunk/core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/ConversationRequired.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/cdi/trunk/core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/ConversationRequired.java?rev=1089246&view=auto
==============================================================================
--- myfaces/extensions/cdi/trunk/core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/ConversationRequired.java (added)
+++ myfaces/extensions/cdi/trunk/core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/ConversationRequired.java Tue Apr 5 21:43:15 2011
@@ -0,0 +1,49 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.apache.myfaces.extensions.cdi.core.api.scope.conversation;
+
+import org.apache.myfaces.extensions.cdi.core.api.config.view.ViewConfig;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+import java.lang.annotation.Documented;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+
+/**
+ * @author Gerhard Petracek
+ */
+@Target({TYPE})
+@Retention(RUNTIME)
+@Documented
+public @interface ConversationRequired
+{
+ /**
+ * Default entry-point which will be used if a violation had been detected
+ * @return entry-point page
+ */
+ Class<? extends ViewConfig> defaultEntryPoint();
+
+ /**
+ * Allowed entry-points for starting a conversation
+ * @return possible entry-points
+ */
+ Class<? extends ViewConfig>[] entryPoints() default {};
+}
Modified: myfaces/extensions/cdi/trunk/core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/config/ConversationConfig.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/cdi/trunk/core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/config/ConversationConfig.java?rev=1089246&r1=1089245&r2=1089246&view=diff
==============================================================================
--- myfaces/extensions/cdi/trunk/core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/config/ConversationConfig.java (original)
+++ myfaces/extensions/cdi/trunk/core/api/src/main/java/org/apache/myfaces/extensions/cdi/core/api/scope/conversation/config/ConversationConfig.java Tue Apr 5 21:43:15 2011
@@ -131,4 +131,16 @@ public class ConversationConfig extends
{
return false;
}
+
+ /**
+ * Specifies if {@link org.apache.myfaces.extensions.cdi.core.api.scope.conversation.ConversationRequired}
+ * is enabled
+ *
+ * @return true if conversation-required is enabled, false otherwise
+ */
+ @ConfigEntry
+ public boolean isConversationRequiredEnabled()
+ {
+ return true;
+ }
}
Modified: myfaces/extensions/cdi/trunk/core/impl/src/main/java/org/apache/myfaces/extensions/cdi/core/impl/util/CodiUtils.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/cdi/trunk/core/impl/src/main/java/org/apache/myfaces/extensions/cdi/core/impl/util/CodiUtils.java?rev=1089246&r1=1089245&r2=1089246&view=diff
==============================================================================
--- myfaces/extensions/cdi/trunk/core/impl/src/main/java/org/apache/myfaces/extensions/cdi/core/impl/util/CodiUtils.java (original)
+++ myfaces/extensions/cdi/trunk/core/impl/src/main/java/org/apache/myfaces/extensions/cdi/core/impl/util/CodiUtils.java Tue Apr 5 21:43:15 2011
@@ -174,7 +174,16 @@ public abstract class CodiUtils
return null;
}
- private static <T> T getContextualReference(BeanManager beanManager, Type t, Bean<T> bean)
+ /**
+ * Creates a scoped instance (a proxy for normal scoped beans) for the given bean-descriptor.
+ *
+ * @param beanManager current bean-manager
+ * @param t type of the bean
+ * @param bean bean-descriptor
+ * @param <T> target type
+ * @return created or resolved instance if such a bean exists, null otherwise
+ */
+ public static <T> T getContextualReference(BeanManager beanManager, Type t, Bean<T> bean)
{
CreationalContext<T> cc = beanManager.createCreationalContext(bean);
return (T) beanManager.getReference(bean, t, cc);
Modified: myfaces/extensions/cdi/trunk/jee-modules/jsf-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf/impl/listener/phase/CodiLifecycleWrapper.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/cdi/trunk/jee-modules/jsf-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf/impl/listener/phase/CodiLifecycleWrapper.java?rev=1089246&r1=1089245&r2=1089246&view=diff
==============================================================================
--- myfaces/extensions/cdi/trunk/jee-modules/jsf-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf/impl/listener/phase/CodiLifecycleWrapper.java (original)
+++ myfaces/extensions/cdi/trunk/jee-modules/jsf-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf/impl/listener/phase/CodiLifecycleWrapper.java Tue Apr 5 21:43:15 2011
@@ -25,6 +25,7 @@ import org.apache.myfaces.extensions.cdi
import org.apache.myfaces.extensions.cdi.jsf.impl.scope.conversation.spi.LifecycleAwareWindowHandler;
import org.apache.myfaces.extensions.cdi.core.impl.util.CodiUtils;
import org.apache.myfaces.extensions.cdi.jsf.impl.util.ConversationUtils;
+import org.apache.myfaces.extensions.cdi.jsf.impl.util.JsfUtils;
import javax.faces.lifecycle.Lifecycle;
import javax.faces.event.PhaseListener;
@@ -115,6 +116,8 @@ class CodiLifecycleWrapper extends Lifec
*/
public void render(FacesContext facesContext)
{
+ JsfUtils.ensureExistingConversation(facesContext);
+
wrapped.render(facesContext);
ConversationUtils.postRenderCleanup(facesContext);
Modified: myfaces/extensions/cdi/trunk/jee-modules/jsf-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf/impl/util/JsfUtils.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/cdi/trunk/jee-modules/jsf-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf/impl/util/JsfUtils.java?rev=1089246&r1=1089245&r2=1089246&view=diff
==============================================================================
--- myfaces/extensions/cdi/trunk/jee-modules/jsf-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf/impl/util/JsfUtils.java (original)
+++ myfaces/extensions/cdi/trunk/jee-modules/jsf-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf/impl/util/JsfUtils.java Tue Apr 5 21:43:15 2011
@@ -18,22 +18,37 @@
*/
package org.apache.myfaces.extensions.cdi.jsf.impl.util;
+import org.apache.myfaces.extensions.cdi.core.api.config.view.ViewConfig;
+import org.apache.myfaces.extensions.cdi.core.api.provider.BeanManagerProvider;
+import org.apache.myfaces.extensions.cdi.core.api.scope.conversation.ConversationRequired;
+import org.apache.myfaces.extensions.cdi.core.api.scope.conversation.config.ConversationConfig;
+import org.apache.myfaces.extensions.cdi.core.impl.util.AnyLiteral;
+import org.apache.myfaces.extensions.cdi.core.impl.util.CodiUtils;
+import org.apache.myfaces.extensions.cdi.jsf.api.config.view.PageBeanDescriptor;
+import org.apache.myfaces.extensions.cdi.jsf.api.config.view.ViewConfigDescriptor;
+import org.apache.myfaces.extensions.cdi.jsf.impl.config.view.ViewConfigCache;
+import org.apache.myfaces.extensions.cdi.jsf.impl.scope.conversation.spi.EditableWindowContext;
+
+import javax.enterprise.inject.Typed;
+import javax.enterprise.inject.spi.Bean;
+import javax.enterprise.inject.spi.BeanManager;
import javax.faces.FactoryFinder;
+import javax.faces.application.FacesMessage;
+import javax.faces.component.UIViewRoot;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
-import javax.faces.application.FacesMessage;
import javax.faces.event.PhaseListener;
import javax.faces.lifecycle.Lifecycle;
import javax.faces.lifecycle.LifecycleFactory;
-import javax.enterprise.inject.Typed;
import java.io.UnsupportedEncodingException;
+import java.lang.annotation.Annotation;
import java.net.URLEncoder;
+import java.util.HashSet;
import java.util.Iterator;
-import java.util.ResourceBundle;
import java.util.Locale;
import java.util.Map;
+import java.util.ResourceBundle;
import java.util.Set;
-import java.util.HashSet;
/**
* keep in sync with extval!
@@ -201,4 +216,132 @@ public abstract class JsfUtils
return result;
}
+
+ /**
+ * Checks if the page-bean for the current view hosts {@link ConversationRequired} and the conversation has been
+ * started or the current page is an allowed entry-point for the conversation. If a violation is detected,
+ * the default-entry-point (specified by {@link ConversationRequired}) will be used as new view
+ * which will be rendered.
+ *
+ * @param facesContext current faces-context
+ */
+ public static void ensureExistingConversation(FacesContext facesContext)
+ {
+ UIViewRoot uiViewRoot = facesContext.getViewRoot();
+
+ if(uiViewRoot == null)
+ {
+ return;
+ }
+
+ String oldViewId = uiViewRoot.getViewId();
+
+ if(oldViewId == null)
+ {
+ return;
+ }
+
+ ViewConfigDescriptor entry = ViewConfigCache.getViewConfig(oldViewId);
+
+ if(entry == null)
+ {
+ return;
+ }
+
+ BeanManager beanManager = BeanManagerProvider.getInstance().getBeanManager();
+
+ ConversationConfig conversationConfig =
+ CodiUtils.getContextualReferenceByClass(beanManager, ConversationConfig.class);
+
+ if(!conversationConfig.isConversationRequiredEnabled())
+ {
+ return;
+ }
+
+ String newViewId = checkConversationRequired(beanManager, uiViewRoot, entry);
+
+ if(newViewId != null && !oldViewId.equals(newViewId))
+ {
+ UIViewRoot newViewRoot = facesContext.getApplication().getViewHandler().createView(facesContext, newViewId);
+
+ if(newViewRoot != null)
+ {
+ facesContext.setViewRoot(newViewRoot);
+ }
+ }
+ }
+
+ private static String checkConversationRequired(BeanManager beanManager,
+ UIViewRoot uiViewRoot,
+ ViewConfigDescriptor entry)
+ {
+ Class<? extends ViewConfig> currentView =
+ ViewConfigCache.getViewConfig(uiViewRoot.getViewId()).getViewConfig();
+
+ if(currentView == null)
+ {
+ return null;
+ }
+
+ for(PageBeanDescriptor pageBeanDescriptor : entry.getPageBeanDescriptors())
+ {
+ Class<?> pageBeanClass = pageBeanDescriptor.getBeanClass();
+ ConversationRequired conversationRequired = pageBeanClass.getAnnotation(ConversationRequired.class);
+
+ if(conversationRequired == null)
+ {
+ continue;
+ }
+
+ if(!isEntryPoint(currentView, conversationRequired.defaultEntryPoint(), conversationRequired.entryPoints()))
+ {
+ EditableWindowContext editableWindowContext =
+ (EditableWindowContext)ConversationUtils.getWindowContextManager().getCurrentWindowContext();
+
+ Set<? extends Bean> foundBeans =
+ beanManager.getBeans(pageBeanDescriptor.getBeanClass(), new AnyLiteral());
+
+ Bean<?> foundBean;
+ Set<Bean<?>> beanSet;
+ for(Bean<?> currentBean : foundBeans)
+ {
+ beanSet = new HashSet<Bean<?>>(1);
+ beanSet.add(currentBean);
+ foundBean = beanManager.resolve(beanSet);
+
+ //only page-beans are supported -> we have to compare them by bean-name
+ if(!pageBeanDescriptor.getBeanName().equals(foundBean.getName()))
+ {
+ continue;
+ }
+
+ if(!editableWindowContext.isConversationActive(ConversationUtils.getConversationGroup(foundBean),
+ foundBean.getQualifiers().toArray(new Annotation[foundBean.getQualifiers().size()])))
+ {
+ return ViewConfigCache.getViewConfig(conversationRequired.defaultEntryPoint()).getViewId();
+ }
+ }
+ }
+ }
+ return null;
+ }
+
+ private static boolean isEntryPoint(Class<? extends ViewConfig> currentView,
+ Class<? extends ViewConfig> defaultEntryPoint,
+ Class<? extends ViewConfig>[] entryPoints)
+ {
+ if(currentView.equals(defaultEntryPoint))
+ {
+ return true;
+ }
+
+ for(Class<? extends ViewConfig> entryPoint : entryPoints)
+ {
+ if(currentView.equals(entryPoint))
+ {
+ return true;
+ }
+ }
+ return false;
+ }
}
Modified: myfaces/extensions/cdi/trunk/jee-modules/jsf20-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf2/impl/listener/phase/CodiLifecycleWrapper.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/cdi/trunk/jee-modules/jsf20-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf2/impl/listener/phase/CodiLifecycleWrapper.java?rev=1089246&r1=1089245&r2=1089246&view=diff
==============================================================================
--- myfaces/extensions/cdi/trunk/jee-modules/jsf20-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf2/impl/listener/phase/CodiLifecycleWrapper.java (original)
+++ myfaces/extensions/cdi/trunk/jee-modules/jsf20-module/impl/src/main/java/org/apache/myfaces/extensions/cdi/jsf2/impl/listener/phase/CodiLifecycleWrapper.java Tue Apr 5 21:43:15 2011
@@ -25,6 +25,7 @@ import org.apache.myfaces.extensions.cdi
import org.apache.myfaces.extensions.cdi.jsf.impl.scope.conversation.spi.WindowHandler;
import org.apache.myfaces.extensions.cdi.jsf.impl.scope.conversation.spi.LifecycleAwareWindowHandler;
import org.apache.myfaces.extensions.cdi.jsf.impl.util.ConversationUtils;
+import org.apache.myfaces.extensions.cdi.jsf.impl.util.JsfUtils;
import javax.faces.context.FacesContext;
@@ -116,6 +117,8 @@ class CodiLifecycleWrapper extends Lifec
*/
public void render(FacesContext facesContext)
{
+ JsfUtils.ensureExistingConversation(facesContext);
+
wrapped.render(facesContext);
ConversationUtils.postRenderCleanup(facesContext);