You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by hu...@apache.org on 2002/11/24 16:53:05 UTC
cvs commit: jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold BizFormBean.java BizForm.java BizAction.java ProcessAction.java BizFormImpl.java BaseForm.java
husted 2002/11/24 07:53:05
Modified: contrib/scaffold/src/java/org/apache/struts/scaffold
ProcessAction.java BizFormImpl.java BaseForm.java
Added: contrib/scaffold/src/java/org/apache/struts/scaffold
BizFormBean.java BizForm.java BizAction.java
Log:
+ Biz*: Initial version of classes to support BizRequest,BizService,BizResponse strategy.
Revision Changes Path
1.7 +3 -1 jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold/ProcessAction.java
Index: ProcessAction.java
===================================================================
RCS file: /home/cvs/jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold/ProcessAction.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ProcessAction.java 23 Nov 2002 19:09:07 -0000 1.6
+++ ProcessAction.java 24 Nov 2002 15:53:05 -0000 1.7
@@ -40,8 +40,10 @@
* and process the result.
*
* @author Ted Husted
+ * @author Synthis Corporation.
* @author OK State DEQ
* @version $Revision$ $Date$
+ * @deprecated Use BizAction instead
*/
public class ProcessAction extends BaseHelperAction {
1.2 +101 -173 jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold/BizFormImpl.java
Index: BizFormImpl.java
===================================================================
RCS file: /home/cvs/jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold/BizFormImpl.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BizFormImpl.java 23 Nov 2002 19:09:07 -0000 1.1
+++ BizFormImpl.java 24 Nov 2002 15:53:05 -0000 1.2
@@ -10,10 +10,12 @@
import org.apache.struts.action.Action;
import org.apache.struts.action.ActionError;
import org.apache.struts.action.ActionErrors;
+import org.apache.struts.action.ActionFormBeans;
import org.apache.struts.action.ActionMapping;
// import org.apache.struts.validator.ValidatorForm; // Struts 1.1
import com.wintecinc.struts.action.ValidatorForm; // Struts 1.0.x
+import org.apache.commons.scaffold.lang.ParameterException;
import org.apache.commons.scaffold.lang.Tokens;
import org.apache.commons.scaffold.util.BizRequest;
import org.apache.commons.scaffold.util.Message;
@@ -23,122 +25,67 @@
/**
+ * Concrete implementation of a BizForm.
+ * To use this object, you must specify the BizFormBean or a superclass
+ * as the default ActionFormBean type for the ActionServlet controller.
+ *
+ * :FIXME: This implementation can only be used with the default module.
+ *
* @author Ted Husted
* @version $Revision$ $Date$
*/
-public class BizFormImpl extends BaseForm {
-
-
- /**
- * The session attribute key for our user profile bean ["USER_PROFILE"].
- * (Suggestion only, may be overridden by presentation framework
- */
- public static String USER_PROFILE_KEY = "USER_PROFILE";
-
+public class BizFormImpl extends BaseForm implements BizForm {
+
// ------------------------------------------------------ Business Request
-
- /**
- * The business request type to create, populate, and validate.
- */
- private String bizType = null;
-
-
- /**
- * Return our bizType property.
- */
- public String getBizType() {
- return (this.bizType);
- }
-
-
- /**
- * Set our bizType property.
- */
- public void setBizType(String bizType) {
- this.bizType = bizType;
- }
-
/**
* The business request object.
*/
private BizRequest bizRequest = null;
-
- /**
- * Return our bizRequest property.
- */
+ // see interface for Javadoc
public BizRequest getBizRequest() {
return (this.bizRequest);
}
-
- /**
- * Set our bizRequest property.
- */
+ // see interface for Javadoc
public void setBizRequest(BizRequest bizRequest) {
this.bizRequest = bizRequest;
}
-
- /**
- * Factory method to create business request object.
- */
+ // see interface for Javadoc
public BizRequest createBizRequest(String bizType) {
-
- BizRequest bizRequest = (BizRequest) createObject(bizType) ;
+
+ BizRequest bizRequest = (BizRequest) createObject(bizType) ;
- return bizRequest;
+ return bizRequest;
}
-
// ------------------------------------------------------ User Profile
-
/**
* The business request type to create, populate, and validate.
*/
private Object userProfile = null;
-
- /**
- * Return our userProfile property.
- */
+ // see interface for Javadoc
public Object getUserProfile() {
return (this.userProfile);
}
-
- /**
- * Set our userProfile property.
- */
+ // see interface for Javadoc
public void setUserProfile(Object userProfile) {
this.userProfile = userProfile;
}
+ // see interface for Javadoc
+ public String getUserProfileName() {
+ return USER_PROFILE_KEY;
+ }
- /**
- * Returns name of result server to be used by this Action,
- * [BizRequest.USER_PROFILE_KEY]
- */
- protected String getUserProfileName() {
- return USER_PROFILE_KEY;
- }
-
-
- /**
- * Retrieve from session under known key
- * (<code>ProcessBean.USER_PROFILE_KEY</code>).
- * Override this approach to implement another method (e.g cookies).
- * Also revise UpdateProfile action-mapping to store changes.
- *
- * @param mapping The ActionMapping used to select this instance
- * @param form The ActionForm
- * @param request The HTTP request we are processing
- * @param response The HTTP response we are creating
- */
- protected void resetUserProfile(HttpServletRequest request) {
+ // see interface for Javadoc
+ public void resetUserProfile(HttpServletRequest request) {
setUserProfile(
request.getSession().getAttribute(getUserProfileName())
@@ -146,84 +93,60 @@
}
-
// ------------------------------------------------------ Remote Server
-
/**
* The business request type to create, populate, and validate.
*/
private Object remoteServer = null;
-
- /**
- * Return our remoteServer property.
- */
+ // see interface for Javadoc
public Object getRemoteServer() {
return (this.remoteServer);
}
-
- /**
- * Set our remoteServer property.
- */
+ // see interface for Javadoc
public void setRemoteServer(Object remoteServer) {
this.remoteServer = remoteServer;
}
-
- /**
- * Returns name of result server to be used by this Action,
- * [BizRequest.RESULT_SERVER_KEY].
- */
- protected String getRemoteServerName() {
+ // see interface for Javadoc
+ public String getRemoteServerName() {
return BizRequest.REMOTE_SERVER_KEY;
}
+ // see interface for Javadoc
+ public void resetRemoteServer(HttpServletRequest request) {
- /**
- * Checks application scope for the remote server object
- * specified by <code>getRemoteServerName</code>
- */
- protected void resetRemoteServer(HttpServletRequest request) {
+ setRemoteServer(servlet.getServletContext().getAttribute(
+ getRemoteServerName()));
- setRemoteServer(servlet.getServletContext().getAttribute(
- getRemoteServerName()));
-
- }
+ }
// --------------------------------------------------------------------
-
- /**
- * Copy messages from business tier message class to presentation
- * tier error class.
- * :TODO: Refactor once everything is based on a root Commons
- * Messages class.
- */
+ // see interface for Javadoc
public void addMessages(ActionErrors errors, Messages messages) {
-
- //:TODO: add functionality
-
+
+ //:TODO: add functionality
+
}
-
/**
* Call superclass reset and other reset* methods in this class.
*/
public void reset(ActionMapping mapping,
HttpServletRequest request) {
- super.reset(mapping,request);
-
- if (isMutable()) {
-
- resetUserProfile(request);
- resetRemoteServer(request);
- }
- }
-
-
+ super.reset(mapping,request);
+
+ if (isMutable()) {
+
+ resetUserProfile(request);
+ resetRemoteServer(request);
+ }
+ }
+
/**
* Call superclass validate.
* If returns null, return an empty ActionErrors for the
@@ -232,58 +155,63 @@
public ActionErrors validate(ActionMapping mapping,
HttpServletRequest request) {
+ // First validate ourself
ActionErrors errors = super.validate(mapping,request);
if (null==errors) errors = new ActionErrors();
- if (isMutable()) {
-
- String bizType = getBizType();
-
- if ((errors.empty()) && (null!=bizType)) {
-
- Messages messages = new MessagesImpl();
-
- try {
-
- BizRequest bizRequest = createBizRequest(bizType);
- Map properties = merge(getUserProfile());
- BeanUtils.copyProperties(bizRequest,properties);
-
- }
-
- catch (Throwable t) {
-
- messages.add(new MessageImpl(
- Tokens.ERROR_GENERAL,
- t.toString()
- ));
-
- }
-
- if (messages.isEmpty()) {
- messages.add(
- bizRequest.validate(mapping.getAttribute()));
- }
-
- if (messages.isEmpty()) {
-
- setBizRequest(bizRequest);
- }
-
- else {
-
- setBizRequest(null);
-
- addMessages(errors,messages);
- }
-
- } // end errors empty
-
- } // end isMutable
-
- return errors;
-
- }
+ // Then validate our business request
+ if ((isMutable()) && (errors.empty())) {
+
+ // Find our business request type
+ BizFormBean bizFormBean = (BizFormBean)
+ mapping.getMappings().getServlet().findFormBean(mapping.getName());
+ String bizType = bizFormBean.getBizType();
+
+ if ((errors.empty()) && (null!=bizType)) {
+
+ // Generate and populate our business request
+ Messages messages = new MessagesImpl();
+ try {
+
+ BizRequest bizRequest = createBizRequest(bizType);
+ // Populate the business request with ourselves
+ // merged with any user profile properties
+ Map properties = merge(getUserProfile());
+ BeanUtils.copyProperties(bizRequest,properties);
+
+ }
+ catch (Throwable t) {
+
+ messages.add(new MessageImpl(
+ Tokens.ERROR_GENERAL,
+ t.toString()
+ ));
+
+ }
+
+ // Validate our business request
+ if (messages.isEmpty()) {
+ messages.add(
+ bizRequest.validate(mapping.getAttribute()));
+ }
+ if (messages.isEmpty()) {
+
+ setBizRequest(bizRequest);
+ }
+ else {
+
+ setBizRequest(null);
+
+ addMessages(errors,messages);
+ }
+
+ } // end errors empty
+
+ } // end isMutable
+
+ return errors;
+
+ }
} // end BizFormImpl
1.12 +13 -7 jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold/BaseForm.java
Index: BaseForm.java
===================================================================
RCS file: /home/cvs/jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold/BaseForm.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- BaseForm.java 23 Nov 2002 19:09:19 -0000 1.11
+++ BaseForm.java 24 Nov 2002 15:53:05 -0000 1.12
@@ -405,8 +405,10 @@
* The result is a union of the properties, with the this
* bean's non-blank properties having precedence over the
* profile's properties. The profile is a base that this bean
- * can override on the fly. If this bean does not supply a
- * property, then the profile property is used.
+ * can override on the fly -- If this bean does not supply a
+ * property, then the profile property is used. But any
+ * property named on the userProfile is included (even if
+ * it has no match on this bean).
* <p>
* If profile is null, a map of this bean's properties is returned.
* <p>
@@ -446,7 +448,11 @@
userMap = PropertyUtils.describe(this);
}
- // Add user element to formMap if form element is null or blank
+ // Add user element to formMap if form element is null or blank
+ // Starting with the formMap, for every element in the userMap,
+ // see if the formMap element is non-existant, null, or an empty String.
+ // If it is (our formMap doesn't override), add the userMap value
+ // to the formMap.
Iterator i = userMap.keySet().iterator();
while (i.hasNext()) {
String key = (String) i.next();
@@ -478,10 +484,10 @@
HttpServletRequest request) {
if (isMutable()) {
-
- super.reset(mapping,request);
+
+ super.reset(mapping,request);
- // :TODO: Might be useful to have a collection of reset listeners
+ // :TODO: Might be useful to have a collection of reset listeners
resetRemoteHost(request);
resetSessionLocale(request);
}
1.1 jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold/BizFormBean.java
Index: BizFormBean.java
===================================================================
package org.apache.struts.scaffold;
import org.apache.struts.action.ActionFormBean;
/**
* An <code>ActionFormBean</code> for specifying a <code>BizForm</code>.
*
* @author Ted Husted
* @version $Revision: 1.1 $ $Date: 2002/11/24 15:53:05 $
*/
public class BizFormBean extends ActionFormBean {
/**
* The business request type to create, populate, and validate.
*/
private String bizType = null;
// see interface for Javadoc
public String getBizType() {
return (this.bizType);
}
// see interface for Javadoc
public void setBizType(String bizType) {
this.bizType = bizType;
}
} // end BizFormBean
/*
* $Header: /home/cvs/jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold/BizFormBean.java,v 1.1 2002/11/24 15:53:05 husted Exp $
* $Revision: 1.1 $
* $Date: 2002/11/24 15:53:05 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 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", "Tomcat", 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/>.
*
**/
1.1 jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold/BizForm.java
Index: BizForm.java
===================================================================
package org.apache.struts.scaffold;
import java.util.Map;
import org.apache.commons.beanutils.BeanUtils;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import org.apache.struts.action.Action;
import org.apache.struts.action.ActionError;
import org.apache.struts.action.ActionErrors;
import org.apache.struts.action.ActionMapping;
// import org.apache.struts.validator.ValidatorForm; // Struts 1.1
import com.wintecinc.struts.action.ValidatorForm; // Struts 1.0.x
import org.apache.commons.scaffold.lang.Tokens;
import org.apache.commons.scaffold.util.BizRequest;
import org.apache.commons.scaffold.util.Message;
import org.apache.commons.scaffold.util.MessageImpl;
import org.apache.commons.scaffold.util.Messages;
import org.apache.commons.scaffold.util.MessagesImpl;
/**
* A BizForm creates and validates a business request
* [<code>org.apache.commons.scaffold.BizRequest</code>]
* as part of its own validation routine.
* A BizForm is typically procesed by a business action
* [<code>org.apache.commons.scaffold.BizAction</code>]
* which passes the business request to a business service
* [<code>org.apache.commons.scaffold.BizService</code>].
*
* @author Ted Husted
* @author Nationwide Insurance Company
* @version $Revision: 1.1 $ $Date: 2002/11/24 15:53:05 $
*/
public interface BizForm {
/**
* The session attribute key for our user profile bean ["USER_PROFILE"].
* (Suggestion only, may be overridden by presentation framework
*/
public static String USER_PROFILE_KEY = "USER_PROFILE";
/**
* Return our bizRequest property.
*/
public BizRequest getBizRequest();
/**
* Set our bizRequest property.
*/
public void setBizRequest(BizRequest bizRequest);
/**
* Factory method to create business request object.
*/
public BizRequest createBizRequest(String bizType);
// ------------------------------------------------------ User Profile
/**
* Return our userProfile property.
*/
public Object getUserProfile();
/**
* Set our userProfile property.
*/
public void setUserProfile(Object userProfile);
/**
* Returns name of result server to be used by this Action,
* [BizRequest.USER_PROFILE_KEY]
*/
public String getUserProfileName();
/**
* Retrieve from session under known key
* (<code>ProcessBean.USER_PROFILE_KEY</code>).
* Override this approach to implement another method (e.g cookies).
* Also revise UpdateProfile action-mapping to store changes.
*
* @param mapping The ActionMapping used to select this instance
* @param form The ActionForm
* @param request The HTTP request we are processing
* @param response The HTTP response we are creating
*/
public void resetUserProfile(HttpServletRequest request);
/**
* Return our remoteServer property.
*/
public Object getRemoteServer();
/**
* Set our remoteServer property.
*/
public void setRemoteServer(Object remoteServer);
/**
* Checks application scope for the remote server object
* specified by <code>getRemoteServerName</code>
*/
public void resetRemoteServer(HttpServletRequest request);
/**
* Copy messages from business tier message class to presentation
* tier error class.
* :TODO: Refactor once everything is based on a root Commons
* Messages class.
*/
public void addMessages(ActionErrors errors, Messages messages);
} // end BizForm
/*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 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", "Scaffold", 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/>.
*
*/
1.1 jakarta-struts/contrib/scaffold/src/java/org/apache/struts/scaffold/BizAction.java
Index: BizAction.java
===================================================================
package org.apache.struts.scaffold;
import java.io.IOException;
import java.io.PrintWriter;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.StringTokenizer;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.beanutils.BeanUtils;
import org.apache.struts.action.ActionError;
import org.apache.struts.action.ActionErrors;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.util.MessageResources;
import org.apache.commons.scaffold.lang.Log;
import org.apache.commons.scaffold.lang.ParameterException;
import org.apache.commons.scaffold.lang.Tokens;
import org.apache.commons.scaffold.util.BizRequest;
import org.apache.commons.scaffold.util.BizResponse;
import org.apache.commons.scaffold.util.BizService;
import org.apache.commons.scaffold.util.Message;
import org.apache.commons.scaffold.util.ResultList;
import org.apache.commons.scaffold.util.ResultListBase;
/**
* Advanced framework class to invoke a business service
* and process the response.
*
* @author Ted Husted
* @author Synthis Corporation.
* @author OK State DEQ
* @author Nationwide Insurance Company
* @version $Revision: 1.1 $ $Date: 2002/11/24 15:53:05 $
*/
public class BizAction extends BaseHelperAction {
/**
* Exposes result in a servlet context.
* If there is an existing bean with same attribute name in the target
* context,
* then the matching properties on that bean are populated with the
* result.
*
* @param request the request being serviced
* @param name The name to use in scope
* @param scope The scope to set the attribute in
* @param bean The attribute to be set
*/
protected void exposeInScope(
HttpServletRequest request,
String name,
String scope,
Object bean) {
if ((null==scope) || (null==bean)) {
servlet.log(Log.PROCESS_BEAN_NULL_SCOPE,Log.DEBUG);
return;
}
if (Tokens.REQUEST.equals(scope)) {
Object form = request.getAttribute(name);
if (null==form) {
request.setAttribute(name,bean);
}
else {
try {
BeanUtils.copyProperties(form,bean);
}
catch (Exception e) {
throw new RuntimeException(e.toString());
}
}
}
else if (Tokens.SESSION.equals(scope)) {
Object form = request.getSession().getAttribute(name);
if (null==form) {
request.getSession().setAttribute(name,bean);
}
else {
try {
BeanUtils.copyProperties(form,bean);
}
catch (Exception e) {
throw new RuntimeException(e.toString());
}
}
}
else if (Tokens.APPLICATION.equals(scope)) {
Object form = servlet.getServletContext().getAttribute(name);
if (null==form) {
servlet.getServletContext().setAttribute(name,bean);
}
else {
try {
BeanUtils.copyProperties(form,bean);
}
catch (Exception e) {
throw new RuntimeException(e.toString());
}
}
}
else {
StringBuffer sb = new StringBuffer("exposeInScope: ");
sb.append(scope);
sb.append(Tokens.INVALID_SCOPE);
servlet.log(sb.toString(),Log.DEBUG);
throw new IllegalArgumentException(sb.toString());
}
} // end exposeInScope()
/**
* Save the result object within the business response to servlet context.
* <p>
* <code>bizResponse.getData()</code> must return non-null.
* <p>
* If <code>bizResponse.getName()</code> is null, the mapping's attribute
* (<code>mapping.getAttribute()</code>) is used instead.
* By default, this is the <code>form-bean</code>'s name.
* <p>
* If data is a Collection, only the first element is stored.
*
* @param mapping The ActionMapping used to select this instance
* @param form The ActionForm
* @param request The HTTP request we are processing
* @param bizResponse The BizResponse we are handling
*/
protected void checkDataSingle(
ActionMapping mapping,
HttpServletRequest request,
BizResponse bizResponse) {
String name = bizResponse.getName();
if (null==name) {
// use form-bean or mapping name
name = mapping.getAttribute();
bizResponse.setName(name);
}
String scope = bizResponse.getScope();
Object bean = bizResponse.getData();
// if data is collection, use first element
if (bean instanceof Collection) {
Collection collection = (Collection) bean;
if (collection.isEmpty()) {
// for lack of a better idea, get a fresh form-bean
// this will return null if there is not a form-bean
// associated with this mapping
bean = createHelperBean(request,mapping.getName());
}
else {
bean = collection.iterator().next();
}
}
if (bizResponse.isExposed()) {
exposeInScope(request,name,scope,bean);
}
} // end checkDataSingle
/**
* Save any result objects within the business response to servlet context.
* <p>
* <code>bizResponse.getData()</code> must return non-null.
* <p>
* If <code>bizResponse.getName()</code> is null, the mapping's attribute
* (<code>mapping.getAttribute()</code>) is used instead.
* By default, this is the <code>form-bean</code>'s name.
*
* @param mapping The ActionMapping used to select this instance
* @param form The ActionForm
* @param request The HTTP request we are processing
* @param bizResponse The BizResponse we are handling
*/
protected void checkData(
ActionMapping mapping,
HttpServletRequest request,
BizResponse bizResponse) {
if (bizResponse.isSingleForm()) {
checkDataSingle(mapping,request,bizResponse);
}
else {
String name = bizResponse.getName();
if (null==name) {
name = Tokens.LIST_KEY;
bizResponse.setName(name);
}
String scope = bizResponse.getScope();
Object bean = bizResponse.getData();
if (bizResponse.isExposed()) {
exposeInScope(request,name,scope,bean);
}
}
} // end checkData
/**
* Process new dispatch advice passed by the business tier.
* <p>
* This is used to route control to another location besides
* the default "success" forward registered with the controller.
* <p>
* The business tier can pass back either a path or the name of
* an ActionForward.
* <code>checkDispatch</code> will then create an ActionForward to return
* and save it in the request under the SUCCESS token.
* The <code>findSuccess()</code> will check for this attribute
* before returning the controller's default.
*
* @param mapping The ActionMapping used to select this instance
* @param request The HTTP request we are processing
* @param BizResponse The BizResponse we are handling
*/
protected void checkDispatch(
ActionMapping mapping,
HttpServletRequest request,
BizResponse bizResponse) {
String dispatch = bizResponse.getDispatch();
ActionForward forward = null;
if (bizResponse.isDispatchPath()) {
forward = new ActionForward(dispatch);
}
else {
forward = mapping.findForward(dispatch);
}
// Our findSuccess looks for this
request.setAttribute(Tokens.SUCCESS,forward);
} // end checkDispatch
/**
* Check outcome, if any; recurse if container for other outcomes.
*
* @param mapping The ActionMapping used to select this instance
* @param request The HTTP request we are processing
* @param BizResponse The BizResponse we are handling
*/
protected void checkOutcome(
ActionMapping mapping,
HttpServletRequest request,
BizResponse bizResponse) throws Exception {
if (bizResponse!=null) {
servlet.log(Log.HELPER_OUTCOME,Log.DEBUG);
if (bizResponse.isAggregate()) {
// recurse for each BizResponse in collection
Collection collection = (Collection)
bizResponse.getData();
Iterator iterator = collection.iterator();
while (iterator.hasNext()) {
BizResponse nextBizResponse =
(BizResponse) iterator.next();
checkOutcome(mapping,request,nextBizResponse);
}
}
else {
// call extension points for whatever is returned
if (bizResponse.isData())
checkData(mapping,request,bizResponse);
if (bizResponse.isMessages())
checkMessages(mapping,request,bizResponse);
if (bizResponse.isDispatch())
checkDispatch(mapping,request,bizResponse);
}
}
else {
throw new Exception(Log.PROCESS_RESULT_NULL);
}
} // end checkOutcome
// --------------------------------------------------------- Public Methods
/**
* Stores informational messages for display by the presention device.
*
* @param mapping The ActionMapping used to select this instance
* @param request The HTTP request we are processing
* @param bizResponse The BizResponse we are handling
*/
protected void checkMessages(
ActionMapping mapping,
HttpServletRequest request,
BizResponse bizResponse) {
// saveMessages(request,bizResponse.getMessages());
} // end checkMessages
/**
* Return the appropriate ActionForward for error or failure
* conditions.
* First checks for a FAILURE ActionForward stored in the request.
* If an override is not found, returns the result of the
* superclass method.
*
* @param mapping The ActionMapping used to select this instance
* @param actionForm The optional ActionForm bean for this request
* @param request The HTTP request we are processing
* @param response The resonse we are creating
* @return The ActionForward representing FAILURE
* or null if a FAILURE forward has not been specified.
*/
protected ActionForward findFailure(
ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response) {
// Did someone leave us a forward?
ActionForward forward = (ActionForward)
request.getAttribute(Tokens.FAILURE);
if (null==forward) {
// No override, use default
forward = super.findFailure(mapping,form,request,response);
}
else {
// Clear advice from the request
request.setAttribute(Tokens.FAILURE,null);
}
return forward;
} // end findFailure
/**
* Optional extension point for pre-processing.
* Default method does nothing.
* To branch to another URI, return an non-null ActionForward.
* If errors are logged (getErrors() et al),
* default behaviour will branch to findFailure().
*
* @param mapping The ActionMapping used to select this instance
* @param actionForm The optional ActionForm bean for this request
* @param request The HTTP request we are processing
* @param response The resonse we are creating
*/
protected void preProcess(
ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response) {
// Check for cancelled
ActionForward forward = mapping.findForward(Tokens.CANCEL);
if ((null!=forward) && (isCancelled(request))) {
// Our findFailure looks for this
request.setAttribute(Tokens.FAILURE,forward);
// Post cancel error message
ActionErrors errors = getErrors(request,true);
errors.add(ActionErrors.GLOBAL_ERROR,
new ActionError(Tokens.ERROR_CANCEL));
return;
}
// Check for missing token
forward = mapping.findForward(Tokens.GET_TOKEN);
if ((null!=forward) && (!isTokenValid(request))) {
// Our findFailure looks for this
request.setAttribute(Tokens.FAILURE,forward);
// Post token error message
ActionErrors errors = getErrors(request,true);
errors.add(ActionErrors.GLOBAL_ERROR,
new ActionError(Tokens.ERROR_TOKEN));
return;
}
if (null!=forward) {
// reset to guard against duplicate request
resetToken(request);
}
// Check for save token directive (do this last)
forward = mapping.findForward(Tokens.SET_TOKEN);
if (null!=forward) saveToken(request);
} // end preProcess
/**
* Return the appropriate ActionForward for the nominal,
* non-error state.
* First checks for a SUCCESS ActionForward stored in the request.
* If an override is not found, returns the result of the
* superclass method.
*
* @param mapping The ActionMapping used to select this instance
* @param form The optional ActionForm bean for this request (if any)
* @param request The HTTP request we are processing
* @param response The response we are creating
* @return The ActionForward representing SUCCESS
* or null if a SUCCESS forward has not been specified.
*/
protected ActionForward findSuccess(
ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response) {
// Did someone leave us a forward?
ActionForward forward = (ActionForward)
request.getAttribute(Tokens.SUCCESS);
if (null==forward) {
// No override, use default
forward = super.findSuccess(mapping,form,request,response);
}
else {
// Clear advice from the request
request.setAttribute(Tokens.SUCCESS,null);
}
return forward;
} // end findSuccess
/**
* The set of argument type classes for the reflected method call.
* These are the same for all calls, so calculate them only once.
*/
private static final Class types[] = { Object.class };
/**
* Error handler.
* Posts a message template and two parameters in a BizResponse.
*/
private BizResponse processError(
ActionMapping mapping,
String template) {
// Any other way to do this?
BizResponse bizResponse =
new org.apache.commons.scaffold.util.BizResponseImpl();
Message message =
new org.apache.commons.scaffold.util.MessageImpl(
template,
mapping.getPath(),
mapping.getParameter()
);
bizResponse.addMessage(message);
return bizResponse;
}
/**
* Invoke an alternate method on BizService.
*/
protected BizResponse processDispatch(
ActionMapping mapping,
BizService bizService,
BizRequest bizRequest,
String methodName) throws Exception {
Method method = bizService.getClass().getMethod(methodName,types);
Object args[] = { bizRequest };
BizResponse bizResponse = null;
try {
bizResponse = (BizResponse) method.invoke(bizService,args);
}
catch (ClassCastException e) {
bizResponse = processError(mapping,Tokens.ERROR_DISPATCH_RETURN);
}
catch (IllegalAccessException e) {
bizResponse = processError(mapping,Tokens.ERROR_DISPATCH_RETURN);
}
catch (InvocationTargetException e) {
// Rethrow the target exception if possible so that the
// exception handling machinery can deal with it
Throwable t = e.getTargetException();
if (t instanceof Exception) {
throw ((Exception) t);
} else {
bizResponse = processError(mapping,Tokens.ERROR_DISPATCH);
}
}
return bizResponse;
}
/**
* Obtain the business request, invoke the business service,
* and process the outcome.
*
* @param mapping The ActionMapping used to select this instance
* @param form The ActionForm
* @param request The HTTP request we are processing
* @param response The HTTP response we are creating
* @param helper The object instantiated from type given as parameter.
* @exception IOException if an input/output error occurs
* @exception ServletException if a servlet exception occurs
*/
protected void executeLogic(
ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response,
Object[] helpers) throws Exception {
BizResponse bizResponse = null;
servlet.log(Log.HELPER_PROCESSING,Log.DEBUG);
try {
// Cast our form bean; snag our request bean
BizForm bizForm = (BizForm) form;
BizRequest bizRequest = bizForm.getBizRequest();
// Munge the parameter property
servlet.log(Log.TOKENS_PARSING,Log.DEBUG);
String[] tokens = tokenize(mapping.getParameter());
// Create our business service helper
Object helper = createHelperObject(request,tokens[0]);
BizService bizService = (BizService) helper;
// Process business logic
servlet.log(Log.HELPER_EXECUTING,Log.DEBUG);
if (tokens.length>1) {
// Pass along the helper's parameter, if any
if (tokens.length>2) {
bizRequest.setParameter(tokens[2]);
}
bizResponse = processDispatch(
mapping,
bizService,
bizRequest,
tokens[1]);
}
else {
bizResponse = (BizResponse) bizService.process(bizRequest);
}
}
// Gracefully trap any kinky class-cast or NPE type exceptions
catch (Throwable t) {
throw new ParameterException(t);
}
// Analyze result of business logic
checkOutcome(mapping,request,bizResponse);
} // end executeLogic
} // end BizAction
/*
*
* Copyright (c) 2002 Synthis Corporation.
* 430 10th Street NW, Suite S-108, Atlanta GA 30318, U.S.A.
* All rights reserved.
*
* This software is licensed to you free of charge under
* the Apache Software License, so long as this copyright
* statement, list of conditions, and comments, remains
* in the source code. See bottom of file for more
* license information.
*
* This software was written to support code generation
* for the Apache Struts J2EE architecture by Synthis'
* visual application modeling tool Adalon.
*
* For more information on Adalon and Struts code
* generation please visit http://www.synthis.com
*
*/
/*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001 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", "Scaffold", 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/>.
*
*/
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>