[jboss-svn-commits] JBL Code SVN: r13908 - in labs/jbossesb/trunk/product: services/smooks/src/main/java/org/jboss/soa/esb/actions/converters and 1 other directory.

[jboss-svn-commits at lists.jboss.org]

Author: tfennelly
Date: 2007-07-31 08:09:47 -0400 (Tue, 31 Jul 2007)
New Revision: 13908

Modified:
   labs/jbossesb/trunk/product/docs/MessageActionGuide.odt
   labs/jbossesb/trunk/product/services/smooks/src/main/java/org/jboss/soa/esb/actions/converters/SmooksTransformer.java
Log:
Added detail wrt "input-location" and "output-location" properties on SmooksTransformer action.

Modified: labs/jbossesb/trunk/product/docs/MessageActionGuide.odt
===================================================================
(Binary files differ)

Modified: labs/jbossesb/trunk/product/services/smooks/src/main/java/org/jboss/soa/esb/actions/converters/SmooksTransformer.java
===================================================================
--- labs/jbossesb/trunk/product/services/smooks/src/main/java/org/jboss/soa/esb/actions/converters/SmooksTransformer.java	2007-07-31 12:02:29 UTC (rev 13907)
+++ labs/jbossesb/trunk/product/services/smooks/src/main/java/org/jboss/soa/esb/actions/converters/SmooksTransformer.java	2007-07-31 12:09:47 UTC (rev 13908)
@@ -51,7 +51,7 @@
  * XML Transformation/Processing Engine into a message processing pipeline to support
  * non binary message transformations.
  * 
- * <h3>Action Configuration</h3>
+ * <h3>Action Transformation Configuration</h3>
  * This action works in one of 2 ways:
  * <ol>
  *      <li>Out of a Smooks resource configuration whose URL is specified directly on the action via the
@@ -80,7 +80,7 @@
  * 	&lt;property name="<b>to-type</b>" value="text/xml:messageAtB" /&gt;
  * &lt;/action&gt;
  * </pre>
- * 
+ *
  * <h3>Configuartion Loading &amp; Administration Console Integration</h3>
  * This class picks up its list of transformation resource configurations from a list file
  * specified in the "configuration.list.file.uri" parameter of the "transformation" 
@@ -98,7 +98,23 @@
  * 	http://localhost:8080/jboss-esb-console/transform/smooks-config.jsp
  * </pre>
  * ... where the host and port values need to be modified appropriately.
- * 
+ *
+ * <h3>Action Transformation Input/Output Configuration</h3>
+ * This action gets the transformation input, and sets the transformation output
+ * based on the "input-location" and "output-location" configuration properties.
+ * These properties name the {@link Body Message.Body} location where the transformation input
+ * and output are attached.
+ * <p/>
+ * If either these properties are not set, the action class defaults that value
+ * to being "{@link Body#DEFAULT_LOCATION defaultEntry}".  In other words, if "input-location" is not configured
+ * on the action, the action will attempt to load the transformation input from the
+ * {@link Body Message.Body} location named "{@link Body#DEFAULT_LOCATION defaultEntry}".  If the "output-location"
+ * is not configured on the action, the action will set the transformation result/output
+ * in the {@link Body Message.Body} location named "{@link Body#DEFAULT_LOCATION defaultEntry}".
+ * <p/>
+ * From a Java code perspective, setting and getting on the "{@link Body#DEFAULT_LOCATION defaultEntry}"
+ * is done simply by calling the no-name-arg {@link Body#add(Object)} and {@link Body#get()} methods.
+ *
  * @author <a href="mailto:tom.fennelly at jboss.com">tom.fennelly at jboss.com</a>
  * @since Version 4.0
  */