[seam-commits] Seam SVN: r13895 - modules/faces/trunk/impl/src/main/java/org/jboss/seam/faces/environment.

[seam-commits at lists.jboss.org]

Author: lincolnthree
Date: 2010-10-20 16:07:57 -0400 (Wed, 20 Oct 2010)
New Revision: 13895

Added:
   modules/faces/trunk/impl/src/main/java/org/jboss/seam/faces/environment/FacesFlashProducer.java
Log:
Added JSF standard javax.faces.Flash @Producer

Added: modules/faces/trunk/impl/src/main/java/org/jboss/seam/faces/environment/FacesFlashProducer.java
===================================================================
--- modules/faces/trunk/impl/src/main/java/org/jboss/seam/faces/environment/FacesFlashProducer.java	                        (rev 0)
+++ modules/faces/trunk/impl/src/main/java/org/jboss/seam/faces/environment/FacesFlashProducer.java	2010-10-20 20:07:57 UTC (rev 13895)
@@ -0,0 +1,67 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright 2010, Red Hat, Inc., and individual contributors
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.jboss.seam.faces.environment;
+
+import javax.enterprise.context.ContextNotActiveException;
+import javax.enterprise.context.RequestScoped;
+import javax.enterprise.inject.Produces;
+import javax.faces.context.FacesContext;
+import javax.faces.context.Flash;
+
+/**
+ * <p>
+ * A producer which retrieves the {@link Flash} for the current request of the JavaServer Faces application by calling
+ * {@link FacesContext#getCurrentInstance()} and stores the result as a request-scoped bean instance.
+ * </p>
+ * 
+ * <p>
+ * This producer allows the {@link Flash} to be injected:
+ * </p>
+ * 
+ * <pre>
+ * &#064;Inject
+ * Flash flash;
+ * </pre>
+ * 
+ * @author Lincoln Baxter
+ */
+public class FacesFlashProducer
+{
+   @Produces
+   @RequestScoped
+   public Flash getFlash()
+   {
+      FacesContext facesContext = FacesContext.getCurrentInstance();
+      if (facesContext == null)
+      {
+         throw new ContextNotActiveException("FacesContext is not active");
+      }
+
+      Flash ctx = facesContext.getExternalContext().getFlash();
+      if (ctx == null)
+      {
+         throw new ContextNotActiveException("Flash is not active");
+      }
+
+      return ctx;
+   }
+}