/*
* $Header: /home/cvspublic/jakarta-struts/contrib/struts-faces/src/java/org/apache/struts/faces/component/FormComponent.java,v 1.1 2003/03/07 03:22:44 craigmcc Exp $
* $Revision: 1.1 $
* $Date: 2003/03/07 03:22:44 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Struts", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.struts.faces.component;
import java.io.IOException;
import javax.faces.component.UIForm;
import javax.faces.context.FacesContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.apache.commons.beanutils.DynaBean;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.struts.Globals;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionServlet;
import org.apache.struts.action.DynaActionFormClass;
import org.apache.struts.config.ActionConfig;
import org.apache.struts.config.FormBeanConfig;
import org.apache.struts.config.ModuleConfig;
import org.apache.struts.util.RequestUtils;
/**
* <p><strong>FormComponent</strong> is a specialized subclass of
* <code>javax.faces.component.UIForm</code> that supports automatic
* creation of form beans in request or session scope.</p>
*
* @author Craig R. McClanahan
* @version $Revision: 1.1 $ $Date: 2003/03/07 03:22:44 $
*/
public class FormComponent extends UIForm {
// ------------------------------------------------------- Static Variables
/**
* <p>The <code>Log</code> instance for this class.</p>
*/
protected static Log log = LogFactory.getLog(FormComponent.class);
// --------------------------------------------------- Component Properties
/**
* <p>Return the Struts action path to which this form should be submitted.
* It is an alias for <code>formName</code> (and <code>value</code>) on the
* superclass <code>UIForm</code>.</p>
*/
public String getAction() {
return ((String) getAttribute("value"));
}
/**
* <p>Set the Struts action to which this form should be submitted.
* It is an alias for <code>formName</code> (and <code>value</code>) on the
* superclass <code>UIForm</code>.</p>
*
* @param action The new action path
*/
public void setAction(String action) {
setAttribute("value", action);
}
// --------------------------------------------------------- UIForm Methods
/**
* <p>Create an instance of the form bean (if necessary) before
* delegating to the standard decoding process.</p>
*
* @param context FacesContext for the request we are processing
*
* @exception IOException if an input/output error occurs
* during decoding
*/
public void processDecodes(FacesContext context) throws IOException {
if (context == null) {
throw new NullPointerException();
}
// Create the form bean (if necessary)
createActionForm(context);
// Perform the standard decode processing
super.processDecodes(context);
}
// --------------------------------------------------------- Public Methods
/**
* <p>Create an appropriate form bean in the appropriate scope, if one
* does not already exist.</p>
*
* @param context FacesContext for the current request
*
* @exception IllegalArgumentException if no ActionConfig for the
* specified action attribute can be located
* @exception IllegalArgumentException if no FormBeanConfig for the
* specified form bean can be located
* @exception IllegalArgumentException if no ModuleConfig can be
* located for this application module
*/
public void createActionForm(FacesContext context) {
// Look up the application module configuration information we need
ModuleConfig moduleConfig = lookupModuleConfig(context);
// Look up the ActionConfig we are processing
String action = getAction();
ActionConfig actionConfig = moduleConfig.findActionConfig(action);
if (actionConfig == null) {
throw new IllegalArgumentException("Cannot find action '" +
action + "' configuration");
}
// Does this ActionConfig specify a form bean?
String name = actionConfig.getName();
if (name == null) {
return;
}
// Look up the FormBeanConfig we are processing
FormBeanConfig fbConfig = moduleConfig.findFormBeanConfig(name);
if (fbConfig == null) {
throw new IllegalArgumentException("Cannot find form bean '" +
name + "' configuration");
}
// Does a usable form bean attribute already exist?
String attribute = actionConfig.getAttribute();
String scope = actionConfig.getScope();
ActionForm instance = null;
if ("request".equals(scope)) {
instance = (ActionForm)
context.getServletRequest().getAttribute(attribute);
} else if ("session".equals(scope)) {
HttpSession session =
((HttpServletRequest) context.getServletRequest()).
getSession(true);
instance = (ActionForm)
session.getAttribute(attribute);
}
if (instance != null) {
if (fbConfig.getDynamic()) {
String className =
((DynaBean) instance).getDynaClass().getName();
if (className.equals(fbConfig.getName())) {
if (log.isDebugEnabled()) {
log.debug
(" Recycling existing DynaActionForm instance " +
"of type '" + className + "'");
}
return;
}
} else {
try {
Class configClass =
RequestUtils.applicationClass(fbConfig.getType());
if (configClass.isAssignableFrom(instance.getClass())) {
if (log.isDebugEnabled()) {
log.debug
(" Recycling existing ActionForm instance " +
"of class '" + instance.getClass().getName()
+ "'");
}
return;
}
} catch (Throwable t) {
throw new IllegalArgumentException
("Cannot load form bean class '" +
fbConfig.getType() + "'");
}
}
}
// Create a new form bean instance
if (fbConfig.getDynamic()) {
try {
DynaActionFormClass dynaClass =
DynaActionFormClass.createDynaActionFormClass(fbConfig);
instance = (ActionForm) dynaClass.newInstance();
if (log.isDebugEnabled()) {
log.debug
(" Creating new DynaActionForm instance " +
"of type '" + fbConfig.getType() + "'");
log.trace(" --> " + instance);
}
} catch (Throwable t) {
throw new IllegalArgumentException
("Cannot create form bean of type '" +
fbConfig.getType() + "'");
}
} else {
try {
instance = (ActionForm)
RequestUtils.applicationInstance(fbConfig.getType());
if (log.isDebugEnabled()) {
log.debug
(" Creating new ActionForm instance " +
"of type '" + fbConfig.getType() + "'");
log.trace(" --> " + instance);
}
} catch (Throwable t) {
throw new IllegalArgumentException
("Cannot create form bean of class '" +
fbConfig.getType() + "'");
}
}
// Configure and cache the form bean instance in the correct scope
ActionServlet servlet = (ActionServlet)
context.getServletContext().getAttribute
(Globals.ACTION_SERVLET_KEY);
instance.setServlet(servlet);
if ("request".equals(scope)) {
context.getServletRequest().setAttribute(attribute, instance);
} else if ("session".equals(scope)) {
context.getHttpSession().setAttribute(attribute, instance);
}
}
/**
* <p>Return the <code>ModuleConfig</code> for the application module
* this form is being processed for.</p>
*
* @param context The <code>FacesContext</code> for the current request
*
* @exception IllegalArgumentException if no <code>ModuleConfig</code>
* can be found
*/
public ModuleConfig lookupModuleConfig(FacesContext context) {
// Look up the application module configuration information we need
ModuleConfig modConfig = (ModuleConfig)
context.getServletRequest().getAttribute(Globals.APPLICATION_KEY);
if (modConfig == null) {
modConfig = (ModuleConfig)
context.getServletContext().getAttribute
(Globals.APPLICATION_KEY);
}
if (modConfig == null) {
throw new IllegalArgumentException
("Cannot find module configuration");
}
return (modConfig);
}
}