You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ek...@apache.org on 2005/08/22 22:40:25 UTC
svn commit: r239246 [3/3] - in
/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs: ./
controls/ pageflow/ system-controls/ejb/ system-controls/jdbc/
system-controls/jms/ system-controls/webservices/ tutorial/
Propchange: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlDevGuide.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlTutorial.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlTutorial.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlTutorial.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlTutorial.xml Mon Aug 22 13:40:15 2005
@@ -1,174 +1,174 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-<document>
- <header>
- <title>Jdbc Control Overview</title>
- </header>
- <body>
- <section>
- <title>Overview</title>
- <section>
- <title>The Problem with Jdbc: Complexity</title>
- <p>
- The Jdbc Control makes it easy to access a relational database from your Java code using SQL commands.
- The Jdbc Control handles the work of connecting to the database, so you don't have to understand JDBC to
- work with a database.</p>
- <p>
- The methods that you add to a Jdbc Control execute SQL commands against the database. You can send any
- SQL command to the database via the Jdbc Control, so that you can retrieve data, perform operations like
- inserts and updates, and even make structural changes to the database.</p>
- <p>
- All Jdbc controls are subclassed from the JdbcControl interface. The interface defines methods that Jdbc
- control instances can call from an application. See the Tutorial for more detailed information
- about using the JdbcControl.</p>
- </section>
- </section>
- <section>
- <title>Tutorial</title>
- <section>
- <title>Jdbc Control Tutorial</title>
- <p>
- The code fragements used in the mini-tutorial are from the jdbcControlSample - the full source
- can be found in the samples directory of the JdbcControl's source tree.</p>
- </section>
-
- <section>
- <title>Extending the Jdbc-Control Interface</title>
- <p>
- The JdbcControl is an extensible control. Before a JdbcControl can be used in an application,
- a subinterface of the org.apache.beehive.controls.system.jdbc.JdbcControl interface must be created.</p>
- <source>
-/**
- * JdbcControl implementation for the JdbcControl sample app.
- */
-@org.apache.beehive.controls.api.bean.ControlExtension
-@JdbcControl.ConnectionDataSource(jndiName="java:comp/env/jdbc/JdbcControlSampleDB")
-public interface SimpleDBControl extends JdbcControl {
- .
- .
- .
-}
- </source>
-
- <p>
- In the sample above several Java 1.5 annotations are used. The @ControlExtension annotation is required and
- tells the Beehive control framework that this control extends an extensible control (in this case the JdbcControl).
- </p>
- </section>
-
- <section>
- <title>Connecting to a Database Instance</title>
- <p> The next step is to tell the JdbcControl how to connect to a database instance.
- This is done using class level Java annotations, there are two annotations which can be used:</p>
- <ul>
- <li>JdbcControl.ConnectionDriver</li>
- <li>JdbcControl.ConnectionDataSource</li>
- </ul>
-
- <p>(i) See the Jdbc Control Annotation Reference for additional information about these annotations.</p>
- </section>
-
- <section>
- <title>Making Jdbc Calls to a Database Instance</title>
-
- <p>Now that the control knows how to connect to the database instance, the next step is to create
- methods in the control which access the database. Let's assume we want to access a table
- in the database which looks like:</p>
-
- <source>
-CREATE TABLE products (name VARCHAR(64), description VARCHAR(128), quantity INT)
- </source>
-
- <p>Here's what the control might look like:</p>
-
- <source>
-/**
- * JdbcControl implementation for the JdbcControl sample app.
- */
-@org.apache.beehive.controls.api.bean.ControlExtension
-@JdbcControl.ConnectionDataSource(jndiName="java:comp/env/jdbc/JdbcControlSampleDB")
-public interface SimpleDBControl extends JdbcControl
-{
-
- static public class Product
- {
- private String _name;
- private String _description;
- private int _quantity;
-
- public int getQuantity() { return _quantity; }
- public void setQuantity(int i) { _quantity = i; }
-
- public String getName() { return _name; }
- public void setName(String n) { _name = n; }
-
- public String getDescription() { return _description; }
- public void setDescription(String n) { _description = n; }
- }
-
- /**
- * Get the name column from the products table.
- * @return An array of strings.
- */
- @JdbcControl.SQL(statement="SELECT name FROM products")
- public String[] getProductNames() throws SQLException;
-
- /**
- * Get the rest of the columns associated with a product name.
- * @param productName Name of product to lookup.
- * @return An instance of Product.
- */
- @JdbcControl.SQL(statement="SELECT * FROM products WHERE name={productName}")
- public Product getProductDetails(String productName) throws SQLException;
-
- static final long serialVersionUID = 1L;
-}
- </source>
-
- <p>The SimpleJdbcControl can be accessed from an application as follows:</p>
-
- <source>
-public class Foo {
-
- // the @Control annotation causes the control to be intialized when this class is loaded.
- @Control
- public SimpleDBControl jdbcCtrl;
-
- public void doFoo() {
- String[] productNames = jdbcCtrl.getProductNames();
- Product productInfo = jdbcCtrl.getProductDetails(productNames[3]);
- }
-}
- </source>
-
- <p>Note the use of the @SQL method annotation in SimpleDBControl.java, see the Jdbc Control Annotation Reference for
- additional information about the SQL annotation.</p>
- </section>
- <section>
- <title>SQL Parameter Substitution</title>
-
- <p>It is also possible to substitute method parameter values into the statement member of the @SQL annotation:</p>
-
- <source>
-//
-// simple query with param substitution
-//
-@SQL(statement="SELECT * FROM USERS WHERE userid={someUserId}")
-public ResultSet getSomeUser(int someUserId) throws SQLException;
-
-//
-// query with sql substitution
-//
-@SQL(statement="SELECT * FROM USERS WHERE {sql: where}")
-public ResultSet getJustOneUser(String where) throws SQLException;
- </source>
-
-
- <p>For the first method, the value of the parameter 'someUserId' gets substituted into the SQL statement at
- runtime when the getSomeUser() method is invoked. For the second method, the substitution gets added to the
- SQL statement as the literal value of the 'where' parameter.</p>
-
- </section>
- </section>
- </body>
-</document>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>JDBC Control Tutorial</title>
+ </header>
+ <body>
+ <section>
+ <title>Overview</title>
+ <section>
+ <title>The Problem with JDBC: Complexity</title>
+ <p>
+ The JDBC Control makes it easy to access a relational database from your Java code using SQL commands.
+ The JDBC Control handles the work of connecting to the database, so you don't have to understand JDBC to
+ work with a database.</p>
+ <p>
+ The methods that you add to a JDBC Control execute SQL commands against the database. You can send any
+ SQL command to the database via the JDBC Control, so that you can retrieve data, perform operations like
+ inserts and updates, and even make structural changes to the database.</p>
+ <p>
+ All JDBC controls are subclassed from the JdbcControl interface. The interface defines methods that JDBC
+ control instances can call from an application. See the Tutorial for more detailed information
+ about using the JdbcControl.</p>
+ </section>
+ </section>
+ <section>
+ <title>Tutorial</title>
+ <section>
+ <title>JDBC Control Tutorial</title>
+ <p>
+ The code fragements used in the mini-tutorial are from the jdbcControlSample - the full source
+ can be found in the samples directory of the JdbcControl's source tree.</p>
+ </section>
+
+ <section>
+ <title>Extending the JDBC-Control Interface</title>
+ <p>
+ The JdbcControl is an extensible control. Before a JdbcControl can be used in an application,
+ a subinterface of the org.apache.beehive.controls.system.jdbc.JdbcControl interface must be created.</p>
+ <source>
+/**
+ * JdbcControl implementation for the JdbcControl sample app.
+ */
+@org.apache.beehive.controls.api.bean.ControlExtension
+@JdbcControl.ConnectionDataSource(jndiName="java:comp/env/jdbc/JdbcControlSampleDB")
+public interface SimpleDBControl extends JdbcControl {
+ .
+ .
+ .
+}
+ </source>
+
+ <p>
+ In the sample above several Java 1.5 annotations are used. The @ControlExtension annotation is required and
+ tells the Beehive control framework that this control extends an extensible control (in this case the JdbcControl).
+ </p>
+ </section>
+
+ <section>
+ <title>Connecting to a Database Instance</title>
+ <p> The next step is to tell the JdbcControl how to connect to a database instance.
+ This is done using class level Java annotations, there are two annotations which can be used:</p>
+ <ul>
+ <li>JdbcControl.ConnectionDriver</li>
+ <li>JdbcControl.ConnectionDataSource</li>
+ </ul>
+
+ <p>(i) See the JDBC Control Annotation Reference for additional information about these annotations.</p>
+ </section>
+
+ <section>
+ <title>Making JDBC Calls to a Database Instance</title>
+
+ <p>Now that the control knows how to connect to the database instance, the next step is to create
+ methods in the control which access the database. Let's assume we want to access a table
+ in the database which looks like:</p>
+
+ <source>
+CREATE TABLE products (name VARCHAR(64), description VARCHAR(128), quantity INT)
+ </source>
+
+ <p>Here's what the control might look like:</p>
+
+ <source>
+/**
+ * JdbcControl implementation for the JdbcControl sample app.
+ */
+@org.apache.beehive.controls.api.bean.ControlExtension
+@JdbcControl.ConnectionDataSource(jndiName="java:comp/env/jdbc/JdbcControlSampleDB")
+public interface SimpleDBControl extends JdbcControl
+{
+
+ static public class Product
+ {
+ private String _name;
+ private String _description;
+ private int _quantity;
+
+ public int getQuantity() { return _quantity; }
+ public void setQuantity(int i) { _quantity = i; }
+
+ public String getName() { return _name; }
+ public void setName(String n) { _name = n; }
+
+ public String getDescription() { return _description; }
+ public void setDescription(String n) { _description = n; }
+ }
+
+ /**
+ * Get the name column from the products table.
+ * @return An array of strings.
+ */
+ @JdbcControl.SQL(statement="SELECT name FROM products")
+ public String[] getProductNames() throws SQLException;
+
+ /**
+ * Get the rest of the columns associated with a product name.
+ * @param productName Name of product to lookup.
+ * @return An instance of Product.
+ */
+ @JdbcControl.SQL(statement="SELECT * FROM products WHERE name={productName}")
+ public Product getProductDetails(String productName) throws SQLException;
+
+ static final long serialVersionUID = 1L;
+}
+ </source>
+
+ <p>The SimpleJdbcControl can be accessed from an application as follows:</p>
+
+ <source>
+public class Foo {
+
+ // the @Control annotation causes the control to be intialized when this class is loaded.
+ @Control
+ public SimpleDBControl jdbcCtrl;
+
+ public void doFoo() {
+ String[] productNames = jdbcCtrl.getProductNames();
+ Product productInfo = jdbcCtrl.getProductDetails(productNames[3]);
+ }
+}
+ </source>
+
+ <p>Note the use of the @SQL method annotation in SimpleDBControl.java, see the JdbcControl Annotation Reference for
+ additional information about the SQL annotation.</p>
+ </section>
+ <section>
+ <title>SQL Parameter Substitution</title>
+
+ <p>It is also possible to substitute method parameter values into the statement member of the @SQL annotation:</p>
+
+ <source>
+//
+// simple query with param substitution
+//
+@SQL(statement="SELECT * FROM USERS WHERE userid={someUserId}")
+public ResultSet getSomeUser(int someUserId) throws SQLException;
+
+//
+// query with sql substitution
+//
+@SQL(statement="SELECT * FROM USERS WHERE {sql: where}")
+public ResultSet getJustOneUser(String where) throws SQLException;
+ </source>
+
+
+ <p>For the first method, the value of the parameter 'someUserId' gets substituted into the SQL statement at
+ runtime when the getSomeUser() method is invoked. For the second method, the substitution gets added to the
+ SQL statement as the literal value of the 'where' parameter.</p>
+
+ </section>
+ </section>
+ </body>
+</document>
Propchange: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlTutorial.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jms-annotations.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jms-annotations.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jms-annotations.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jms-annotations.xml Mon Aug 22 13:40:15 2005
@@ -1,27 +1,27 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-<document>
- <header>
- <title>JMS Control Annotations</title>
- </header>
- <body>
- <section>
- <title>JMS Control Annotations</title>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.CorrelationId.html">@JMSControl.CorrelationId</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Delivery.html">@JMSControl.Delivery</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Destination.html">@JMSControl.Destination</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Expiration.html">@JMSControl.Expiration</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Message.html">@JMSControl.Message</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Priority.html">@JMSControl.Priority</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Properties.html">@JMSControl.Properties</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Property.html">@JMSControl.Property</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.PropertyValue.html">@JMSControl.PropertyValue</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Type.html">@JMSControl.Type</a></p>
- </section>
- </body>
- <footer>
- <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br/>
- © 2005, Apache Software Foundation
- </legal>
- </footer>
-</document>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>JMS Control Annotations</title>
+ </header>
+ <body>
+ <section>
+ <title>JMS Control Annotations</title>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.CorrelationId.html">@JMSControl.CorrelationId</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Delivery.html">@JMSControl.Delivery</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Destination.html">@JMSControl.Destination</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Expiration.html">@JMSControl.Expiration</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Message.html">@JMSControl.Message</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Priority.html">@JMSControl.Priority</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Properties.html">@JMSControl.Properties</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Property.html">@JMSControl.Property</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.PropertyValue.html">@JMSControl.PropertyValue</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jms/JMSControl.Type.html">@JMSControl.Type</a></p>
+ </section>
+ </body>
+ <footer>
+ <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br/>
+ © 2005, Apache Software Foundation
+ </legal>
+ </footer>
+</document>
Propchange: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jms-annotations.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsControlTutorial.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsControlTutorial.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsControlTutorial.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsControlTutorial.xml Mon Aug 22 13:40:15 2005
@@ -1,116 +1,112 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-<document>
- <header>
- <title>Jms Control Tutorial</title>
- </header>
- <body>
- <section>
- <title>Jms Control Tutorial</title>
-
- <p>The JmsControl is an extensible control. Before a JmsControl can be used in an application,
- a sub-interface of the org.apache.beehive.controls.system.jms.JmsControl interface must be created and
- annotated with @ControlExtension.</p>
-
- <source>
-@ControlExtension
-public interface SampleQueue extends JMSControl
-{
-...
-}
- </source>
-
- <p>In order for the control to work, it needs to know the destination of the messages. This is
- accomplished using a JNDI context. Unless otherwise specified the default initial
- context is used. This may be overridden by settng the jndiContextFactory and
- jndiProviderUrl properties, either programically (setJndiContextFactory() and
- setJndiProviderUrl()) or via the corresponding @Destination attributes.</p>
-
- <p>The queue/topic destination is then obtained using the value of the sendJndiName property
- and a queue/topic connection is obtained using by the jndiConnectionFactory property.
- In most cases the same connection factory is used for both queues and topics. The
- @Destination sendType attribute may be used to constrain the use of the control to
- either a topic or a queue. By default it's value is Auto which allowes for run-time
- determination of whether the sendJndiName names a queue or a topic. By setting it to
- Queue or Topic a run-time check is made to see if the connection factory and destination
- is of the correct type.</p>
-
- <p>If the JNDI context to be used (i.e. the control is running in an ejb-container (or
- servlet-container with a JNDI context) is known (or is the default context) and the
- connection-factory (e.g. weblogic.jms.ConnectionFactory) and queue JNDI name
- (e.g. jms.SampleQueue) is also known at development time then the extension class can
- be annotated with the @Destination annotation as shown in the example:</p>
-
- <source>
-@ControlExtension
-@JMSControl.Destination(sendType=JMSControl.DestinationType.Queue,sendJndiName="jms.SampleQueue",jndiConnectionFactory="weblogic.jms.ConnectionFactory")
-public interface SampleQueue extends JMSControl
-{
-...
-}
- </source>
-
- <p>Likewise, for a topic (e.g. jms.SampleTopic) the following file might be appropriate:</p>
-
- <source>
-@ControlExtension
-@JMSControl.Destination(sendType=JMSControl.DestinationType.Topic,sendJndiName="jms.SampleTopic",jndiConnectionFactory="weblogic.jms.ConnectionFactory")
-public interface SampleTopic extends JMSControl
-{
-...
-}
- </source>
-
-
- <p>The sendType attribute could be left out of these examples and the control extensions would still work.</p>
-
- <p>See Extension Class Annotation for other annotations defined at the class or type level.</p>
-
- <p>The extension interface can include one or more methods that send messages. These methods must have
- at least one unannotated parameter that corresponds to the body of the message. Other annotated
- parameters can defined to provide property values and other information at run-time to the
- message (see Extension Class Annotation for allowed annotation). The method itself can be
- annotated (see Extension Class Annotation for allowed annotation).</p>
-
- <p>Some examples appropriate to topics and queues include:</p>
-
- <source>
-/**
- * Submit an xml object (org.apache.xmlbeans) as a text message.
- * @param document the document.
- * @param type the message JMS type.
-*/
-public void submitXml(XmlObject document,@Type String type);
-
-/**
- * Submit an xml object (org.apache.xmlbeans) with JMS type "xmlObject".
- * @param document the document.
- */
-@Message(MessageType.Text)
-@Type("xmlObject")
-public void submitXml(XmlObject document);
-
-/**
- * Submit an already constructed message
- * @param message the jms-message.
-*/
-public void submitMessage(Message message);
-
-/**
- * Submit a BytesMessage with the given byte array body and property hello.
- * @param body the byte array.
- * @param hello the value of the hello property.
-*/
-public void submitMessage(byte[] body, @Property(name=hello) hello);
-
-
-/**
- * Submit a MapMessage with the given map and property hello set to world.
- * @param body the byte array.
-*/
-@Properties({PropertyValue(name="hello", value="world")})
-public void submitMessage(Map body);
- </source>
- </section>
- </body>
-</document>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>JMS Control Tutorial</title>
+ </header>
+ <body>
+ <p>The JmsControl is an extensible control. Before a JmsControl can be used in an application,
+ a sub-interface of the <code>org.apache.beehive.controls.system.jms.JmsControl</code> interface must be created and
+ annotated with <code>@ControlExtension</code>.</p>
+
+ <source>
+@ControlExtension
+public interface SampleQueue
+ extends JMSControl {
+...
+}
+ </source>
+
+ <p>In order for the control to work, it needs to know the destination of the messages. This is
+ accomplished using a JNDI context. Unless otherwise specified the default initial
+ context is used. This may be overridden by settng the jndiContextFactory and
+ jndiProviderUrl properties, either programically (setJndiContextFactory() and
+ setJndiProviderUrl()) or via the corresponding @Destination attributes.</p>
+
+ <p>The queue/topic destination is then obtained using the value of the sendJndiName property
+ and a queue/topic connection is obtained using by the jndiConnectionFactory property.
+ In most cases the same connection factory is used for both queues and topics. The
+ @Destination sendType attribute may be used to constrain the use of the control to
+ either a topic or a queue. By default it's value is Auto which allowes for run-time
+ determination of whether the sendJndiName names a queue or a topic. By setting it to
+ Queue or Topic a run-time check is made to see if the connection factory and destination
+ is of the correct type.</p>
+
+ <p>If the JNDI context to be used (i.e. the control is running in an ejb-container (or
+ servlet-container with a JNDI context) is known (or is the default context) and the
+ connection-factory (e.g. weblogic.jms.ConnectionFactory) and queue JNDI name
+ (e.g. jms.SampleQueue) is also known at development time then the extension class can
+ be annotated with the @Destination annotation as shown in the example:</p>
+
+ <source>
+@ControlExtension
+@JMSControl.Destination(sendType=JMSControl.DestinationType.Queue,sendJndiName="jms.SampleQueue",jndiConnectionFactory="weblogic.jms.ConnectionFactory")
+public interface SampleQueue extends JMSControl
+{
+...
+}
+ </source>
+
+ <p>Likewise, for a topic (e.g. jms.SampleTopic) the following file might be appropriate:</p>
+
+ <source>
+@ControlExtension
+@JMSControl.Destination(sendType=JMSControl.DestinationType.Topic,sendJndiName="jms.SampleTopic",jndiConnectionFactory="weblogic.jms.ConnectionFactory")
+public interface SampleTopic extends JMSControl
+{
+...
+}
+ </source>
+
+
+ <p>The sendType attribute could be left out of these examples and the control extensions would still work.</p>
+
+ <p>See Extension Class Annotation for other annotations defined at the class or type level.</p>
+
+ <p>The extension interface can include one or more methods that send messages. These methods must have
+ at least one unannotated parameter that corresponds to the body of the message. Other annotated
+ parameters can defined to provide property values and other information at run-time to the
+ message (see Extension Class Annotation for allowed annotation). The method itself can be
+ annotated (see Extension Class Annotation for allowed annotation).</p>
+
+ <p>Some examples appropriate to topics and queues include:</p>
+
+ <source>
+/**
+ * Submit an xml object (org.apache.xmlbeans) as a text message.
+ * @param document the document.
+ * @param type the message JMS type.
+*/
+public void submitXml(XmlObject document,@Type String type);
+
+/**
+ * Submit an xml object (org.apache.xmlbeans) with JMS type "xmlObject".
+ * @param document the document.
+ */
+@Message(MessageType.Text)
+@Type("xmlObject")
+public void submitXml(XmlObject document);
+
+/**
+ * Submit an already constructed message
+ * @param message the jms-message.
+*/
+public void submitMessage(Message message);
+
+/**
+ * Submit a BytesMessage with the given byte array body and property hello.
+ * @param body the byte array.
+ * @param hello the value of the hello property.
+*/
+public void submitMessage(byte[] body, @Property(name=hello) hello);
+
+
+/**
+ * Submit a MapMessage with the given map and property hello set to world.
+ * @param body the byte array.
+*/
+@Properties({PropertyValue(name="hello", value="world")})
+public void submitMessage(Map body);
+ </source>
+ </body>
+</document>
Propchange: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsControlTutorial.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsDoc.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsDoc.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsDoc.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsDoc.xml Mon Aug 22 13:40:15 2005
@@ -1,173 +1,173 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-<document>
- <header>
- <title>Jms Control Overview</title>
- </header>
- <body>
- <section>
- <title>Overview</title>
-
- <p>The JMS control provides for sending messages to a queue or topic destination. It is an extensible
- control where sub-classes are bound to specific queues/topics and methods may be defined to
- send messages of specific types with specific properties and headers. The queue connections
- are transparently managed by the controls, relieving the developer of that responsibility.</p>
-
- <p>In the example below, the OrderQueue control class has one submitOrder() method that takes an
- Order object as the body and a string that sets the 'DeliverBy' property in the
- javax.jms.ObjectMessage to be sent to the queue.orders JMS queue.</p>
-
- <source>
-@ControlExtension
-@JMSControl.Destination(sendJndiName="queue.orders",jndiConnectionFactory="weblogic.jws.jms.QueueConnectionFactory")
-public interface OrderQueue extends JMSControl
- {
- public class Order implements java.io.Serializable
- {
- public Order()
- {
-
- }
- public Order(int buyer,String[] list)
- {
- buyerId = buyer;
- itemList = list;
-
- }
- private int buyerId;
- private String[] itemList;
- }
-
- public void submitOrder(Order order,@Property(name="DeliverBy") String deliverBy);
-}
- </source>
- </section>
- <section>
- <title>Control Methods</title>
-
- <p>The methods for the jms-control are:</p>
- <table>
- <tr><th>Method</th><th>Description</th></tr>
- <tr><td>getSession()</td><td>Get the queue/topic session.</td></tr>
- <tr><td>getDestination()</td><td>Get the queue/topic destination.</td></tr>
- <tr><td>getConnection()</td><td>Get the queue/topic connection.</td></tr>
- <tr><td>setHeaders(Map)</td><td>Set the headers from the given map. The keys should be of type HeaderType or equivalent strings. Used only for the next message send. See table below for valid values.</td></tr>
- <tr><td>setHeader(HeaderType,Object)</td><td>Set a header. Used only for the next message send.</td></tr>
- <tr><td>setProperties(Map)</td><td>Set the properties on the message using the map of string/object pairs. Used only for the next message send.</td></tr>
- <tr><td>setProperty(String,Object)</td><td>Set a property. Used only for the next message send.</td></tr>
- </table>
-
- <p>The methods of the extension control-classes correspond to sending a message to a topic/queue, e.g.</p>
- <source>send<message-type>(...)</source>
- </section>
- <section>
- <title>Header Types</title>
-
- <p>The table below defines the valid values for header types passed into setHeader() or setHeaders():</p>
- <table>
- <tr><th>JMS Message Method</th><th>HeaderType/String</th><th>Allowed Value Types</th></tr>
- <tr><td>setJMSType()</td><td>JMSType</td><td>String</td></tr>
- <tr><td>setJMSCorrelationID()</td><td>JMSCorrelationID</td><td>String or byte[]</td></tr>
- <tr><td>setJMSExpiration()</td><td>JMSExpiration</td><td>String valued long or Long</td></tr>
- <tr><td>setJMSPriority()</td><td>Priority</td><td>String valued int or Integer</td></tr>
- </table>
-
- <p>All other values are silently ignored (for backward compatibility).</p>
- </section>
-
- <section>
- <title>Extension Class Annotation</title>
-
- <p>The one TYPE/FIELD level annotation is:</p>
-
- <ul>
- <li>@Destination - defines the destination of the message, the message type and
- connection related attributes.</li>
- </ul>
- <p></p>
- <p>The defined annotation attributes for the @Destination element are:</p>
- <table>
- <tr><th>Attribute</th><th>Value</th><th>Description</th></tr>
- <tr><td>sendJndiName</td><td>string</td><td>JNDI name of the queue or topic. Required.</td></tr>
- <tr><td>sendCorrelationProperty</td><td>string</td><td>The correlation property to be used for message sent. Default is empty, which signifies that the JMS correlation header is to be used. Optional.</td></tr>
- <tr><td>connectionFactoryJndiName</td><td>string</td><td>JNDI name of the connection factory. Required</td></tr>
- <tr><td>transacted</td><td>boolean</td><td>True if en-queuing is under transactional semantics of the enclosing container. Default is true. See JMS documentation on transactional semantics of en-queueing and de-queueing.</td></tr>
- <tr><td>acknowledgeMode</td><td>enum AcknowledgeMode</td><td>The acknowledgement strategy, one of Auto, Client, DupsOk. Default is Auto. See JMS API documentation on javax.jms.Session.AUTO_ACKNOWLEDGE/CLIENT_ACKNOWLEDGE/DUPS_OK_ACKNOWLEDGE for more information</td></tr>
- <tr><td>sendType</td><td>enum DestinationType</td><td>Values are Auto, Queue and Topic. If Auto, then the type is determined by the destination named by the sendJndiName attribute. Default is Auto.</td></tr>
- <tr><td>jndiContextFactory</td><td>string</td><td>The class name of the jndi-context-factory. Default is none.</td></tr>
- <tr><td>jndiProviderURL</td><td>string</td><td>The provider URL for JNDI. Default is none.</td></tr>
- </table>
-
- <p>The method and parameters can be annotated with the annotation types in the next section.</p>
- </section>
- <section>
- <title>Extension Method Annotation</title>
-
- <p>The jms-control is intended to be extended. One or more methods may be defined that send messages
- to the given destination. They may be annotated with:</p>
-
- <ul>
- <li>@Message( message-type) or @Message or nothing.</li>
-
- <li>@Priority - the int valued attribute contains a JMS priority (0-9). If not given, then
- the default for the provider is used.</li>
-
- <li>@Expiration - the long valued attribute contains a JMS expiration in milliseconds.
- If not given, then the default for the provider is used.</li>
-
- <li>@Delivery - the DeliveryMode valued attribute determines the delivery mode of the
- message. If not given, then the default for the provider is used.</li>
-
- <li>@Type - the string valued attribute determines the JMS type.</li>
-
- <li>@CorrelationId - the string valued attribute determines the correlation id.</li>
-
- <li>@Properties( PropertyValue[] ) - One or more string/int/long valued properties to be added
- to the message. PropertyValue has the string valued attributes 'name', 'value' and class
- valued 'type'. The allowed values for 'type' are String.class, Integer.class and Long.class.
- If not given, then 'String.class' is assumed.</li>
- </ul>
-
-
- <p>The message-type value is a MessageType enumerated value. Values are: Auto, Object, Bytes, Text,
- Map and JMSMessage. If not given or no message-type string, then the default is Auto. If Auto,
- then the type of JMS message is determined by the type of the body passed in. If the body is a
- String or XmlObject, then a TextMessage is sent; if the body is a byte[], then a StreamMessage
- is sent; if the body is a Map, then a MapMessage is sent; if the body is a JMSMessage, then it is sent;
- otherwise if the body is Serializable, then an ObjectMessage is sent. Any other type
- results in a control exception.</p>
-
- <p>The values of the DeliveryMode enumerated value are: NonPersistent, Persistent, and Auto, where
- Auto is the default.</p>
- </section>
- <section>
- <title>Extension Method Parameter Annotation</title>
-
- <p>Parameters to a send message method may be annotated:</p>
- <ul>
- <li>@Property (name= blah ) - the parameter contains the value of the property blah.</li>
-
- <li>@Priority - the int or integer valued String parameter contains a JMS priority (0-9). If
- not given, then the method-level annotation is used; else the default for
- the provider is used.</li>
-
- <li>@Expiration - the long or integer valued String parameter contains a JMS expiration in
- milliseconds. If not given, then the method-level annotation is used; else
- the default for the provider is used.</li>
-
- <li>@Delivery - the DeliveryMode valued parameter determines the delivery mode of the message.
- If not given, then the method-level annotation is used; else the default for
- the provider is used.</li>
-
- <li>@Type - the string valued parameter determines the JMS type.</li>
-
- <li>@CorrelationId - the string valued parameter determines the correlation id.</li>
- </ul>
-
-
- <p>These annotations denote which parameter is to be the body of the message and zero or more
- properties to be set in the message respectively.</p>
-
- </section>
- </body>
-</document>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>Jms Control Overview</title>
+ </header>
+ <body>
+ <section>
+ <title>Overview</title>
+
+ <p>The JMS control provides for sending messages to a queue or topic destination. It is an extensible
+ control where sub-classes are bound to specific queues/topics and methods may be defined to
+ send messages of specific types with specific properties and headers. The queue connections
+ are transparently managed by the controls, relieving the developer of that responsibility.</p>
+
+ <p>In the example below, the OrderQueue control class has one submitOrder() method that takes an
+ Order object as the body and a string that sets the 'DeliverBy' property in the
+ javax.jms.ObjectMessage to be sent to the queue.orders JMS queue.</p>
+
+ <source>
+@ControlExtension
+@JMSControl.Destination(sendJndiName="queue.orders",jndiConnectionFactory="weblogic.jws.jms.QueueConnectionFactory")
+public interface OrderQueue extends JMSControl
+ {
+ public class Order implements java.io.Serializable
+ {
+ public Order()
+ {
+
+ }
+ public Order(int buyer,String[] list)
+ {
+ buyerId = buyer;
+ itemList = list;
+
+ }
+ private int buyerId;
+ private String[] itemList;
+ }
+
+ public void submitOrder(Order order,@Property(name="DeliverBy") String deliverBy);
+}
+ </source>
+ </section>
+ <section>
+ <title>Control Methods</title>
+
+ <p>The methods for the jms-control are:</p>
+ <table>
+ <tr><th>Method</th><th>Description</th></tr>
+ <tr><td>getSession()</td><td>Get the queue/topic session.</td></tr>
+ <tr><td>getDestination()</td><td>Get the queue/topic destination.</td></tr>
+ <tr><td>getConnection()</td><td>Get the queue/topic connection.</td></tr>
+ <tr><td>setHeaders(Map)</td><td>Set the headers from the given map. The keys should be of type HeaderType or equivalent strings. Used only for the next message send. See table below for valid values.</td></tr>
+ <tr><td>setHeader(HeaderType,Object)</td><td>Set a header. Used only for the next message send.</td></tr>
+ <tr><td>setProperties(Map)</td><td>Set the properties on the message using the map of string/object pairs. Used only for the next message send.</td></tr>
+ <tr><td>setProperty(String,Object)</td><td>Set a property. Used only for the next message send.</td></tr>
+ </table>
+
+ <p>The methods of the extension control-classes correspond to sending a message to a topic/queue, e.g.</p>
+ <source>send<message-type>(...)</source>
+ </section>
+ <section>
+ <title>Header Types</title>
+
+ <p>The table below defines the valid values for header types passed into setHeader() or setHeaders():</p>
+ <table>
+ <tr><th>JMS Message Method</th><th>HeaderType/String</th><th>Allowed Value Types</th></tr>
+ <tr><td>setJMSType()</td><td>JMSType</td><td>String</td></tr>
+ <tr><td>setJMSCorrelationID()</td><td>JMSCorrelationID</td><td>String or byte[]</td></tr>
+ <tr><td>setJMSExpiration()</td><td>JMSExpiration</td><td>String valued long or Long</td></tr>
+ <tr><td>setJMSPriority()</td><td>Priority</td><td>String valued int or Integer</td></tr>
+ </table>
+
+ <p>All other values are silently ignored (for backward compatibility).</p>
+ </section>
+
+ <section>
+ <title>Extension Class Annotation</title>
+
+ <p>The one TYPE/FIELD level annotation is:</p>
+
+ <ul>
+ <li>@Destination - defines the destination of the message, the message type and
+ connection related attributes.</li>
+ </ul>
+ <p></p>
+ <p>The defined annotation attributes for the @Destination element are:</p>
+ <table>
+ <tr><th>Attribute</th><th>Value</th><th>Description</th></tr>
+ <tr><td>sendJndiName</td><td>string</td><td>JNDI name of the queue or topic. Required.</td></tr>
+ <tr><td>sendCorrelationProperty</td><td>string</td><td>The correlation property to be used for message sent. Default is empty, which signifies that the JMS correlation header is to be used. Optional.</td></tr>
+ <tr><td>connectionFactoryJndiName</td><td>string</td><td>JNDI name of the connection factory. Required</td></tr>
+ <tr><td>transacted</td><td>boolean</td><td>True if en-queuing is under transactional semantics of the enclosing container. Default is true. See JMS documentation on transactional semantics of en-queueing and de-queueing.</td></tr>
+ <tr><td>acknowledgeMode</td><td>enum AcknowledgeMode</td><td>The acknowledgement strategy, one of Auto, Client, DupsOk. Default is Auto. See JMS API documentation on javax.jms.Session.AUTO_ACKNOWLEDGE/CLIENT_ACKNOWLEDGE/DUPS_OK_ACKNOWLEDGE for more information</td></tr>
+ <tr><td>sendType</td><td>enum DestinationType</td><td>Values are Auto, Queue and Topic. If Auto, then the type is determined by the destination named by the sendJndiName attribute. Default is Auto.</td></tr>
+ <tr><td>jndiContextFactory</td><td>string</td><td>The class name of the jndi-context-factory. Default is none.</td></tr>
+ <tr><td>jndiProviderURL</td><td>string</td><td>The provider URL for JNDI. Default is none.</td></tr>
+ </table>
+
+ <p>The method and parameters can be annotated with the annotation types in the next section.</p>
+ </section>
+ <section>
+ <title>Extension Method Annotation</title>
+
+ <p>The jms-control is intended to be extended. One or more methods may be defined that send messages
+ to the given destination. They may be annotated with:</p>
+
+ <ul>
+ <li>@Message( message-type) or @Message or nothing.</li>
+
+ <li>@Priority - the int valued attribute contains a JMS priority (0-9). If not given, then
+ the default for the provider is used.</li>
+
+ <li>@Expiration - the long valued attribute contains a JMS expiration in milliseconds.
+ If not given, then the default for the provider is used.</li>
+
+ <li>@Delivery - the DeliveryMode valued attribute determines the delivery mode of the
+ message. If not given, then the default for the provider is used.</li>
+
+ <li>@Type - the string valued attribute determines the JMS type.</li>
+
+ <li>@CorrelationId - the string valued attribute determines the correlation id.</li>
+
+ <li>@Properties( PropertyValue[] ) - One or more string/int/long valued properties to be added
+ to the message. PropertyValue has the string valued attributes 'name', 'value' and class
+ valued 'type'. The allowed values for 'type' are String.class, Integer.class and Long.class.
+ If not given, then 'String.class' is assumed.</li>
+ </ul>
+
+
+ <p>The message-type value is a MessageType enumerated value. Values are: Auto, Object, Bytes, Text,
+ Map and JMSMessage. If not given or no message-type string, then the default is Auto. If Auto,
+ then the type of JMS message is determined by the type of the body passed in. If the body is a
+ String or XmlObject, then a TextMessage is sent; if the body is a byte[], then a StreamMessage
+ is sent; if the body is a Map, then a MapMessage is sent; if the body is a JMSMessage, then it is sent;
+ otherwise if the body is Serializable, then an ObjectMessage is sent. Any other type
+ results in a control exception.</p>
+
+ <p>The values of the DeliveryMode enumerated value are: NonPersistent, Persistent, and Auto, where
+ Auto is the default.</p>
+ </section>
+ <section>
+ <title>Extension Method Parameter Annotation</title>
+
+ <p>Parameters to a send message method may be annotated:</p>
+ <ul>
+ <li>@Property (name= blah ) - the parameter contains the value of the property blah.</li>
+
+ <li>@Priority - the int or integer valued String parameter contains a JMS priority (0-9). If
+ not given, then the method-level annotation is used; else the default for
+ the provider is used.</li>
+
+ <li>@Expiration - the long or integer valued String parameter contains a JMS expiration in
+ milliseconds. If not given, then the method-level annotation is used; else
+ the default for the provider is used.</li>
+
+ <li>@Delivery - the DeliveryMode valued parameter determines the delivery mode of the message.
+ If not given, then the method-level annotation is used; else the default for
+ the provider is used.</li>
+
+ <li>@Type - the string valued parameter determines the JMS type.</li>
+
+ <li>@CorrelationId - the string valued parameter determines the correlation id.</li>
+ </ul>
+
+
+ <p>These annotations denote which parameter is to be the body of the message and zero or more
+ properties to be set in the message respectively.</p>
+
+ </section>
+ </body>
+</document>
Propchange: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsDoc.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservices-annotations.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservices-annotations.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservices-annotations.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservices-annotations.xml Mon Aug 22 13:40:15 2005
@@ -1,20 +1,20 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-<document>
- <header>
- <title>Webservice Control Annotations</title>
- </header>
- <body>
- <section>
- <title>Webservice Control Annotations</title>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/webservice/ServiceControl.Location.html">@ServiceControl.Location</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/webservice/ServiceControl.OperationName.html">@ServiceControl.OperationName</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/webservice/ServiceControl.WSDL.html">@ServiceControl.WSDL</a></p>
- </section>
- </body>
- <footer>
- <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br/>
- © 2005, Apache Software Foundation
- </legal>
- </footer>
-</document>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>Webservice Control Annotations</title>
+ </header>
+ <body>
+ <section>
+ <title>Webservice Control Annotations</title>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/webservice/ServiceControl.Location.html">@ServiceControl.Location</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/webservice/ServiceControl.OperationName.html">@ServiceControl.OperationName</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/webservice/ServiceControl.WSDL.html">@ServiceControl.WSDL</a></p>
+ </section>
+ </body>
+ <footer>
+ <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br/>
+ © 2005, Apache Software Foundation
+ </legal>
+ </footer>
+</document>
Propchange: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservices-annotations.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservicesDoc.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservicesDoc.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservicesDoc.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservicesDoc.xml Mon Aug 22 13:40:15 2005
@@ -1,20 +1,20 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-<document>
- <header>
- <title>WebServices Control Overview</title>
- </header>
- <body>
- <section>
- <title>What is the Web Service Control?</title>
-
- <p>The Web Service Control provides an easy way to create a web service client
- based on a valid WSDL document. A rudimentary client generator is provided
- that will create a control extension that with a few simple modifications can
- call the target web service using either XmlBeans (for Literal) or Axis Generated
- Beans (for Encoded) as parameters and return types.</p>
- <p>Type generation is handled ahead of the sample compilation so that all types used
- in the control extension are already available on the classpath.</p>
- </section>
- </body>
-</document>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>WebServices Control Overview</title>
+ </header>
+ <body>
+ <section>
+ <title>What is the Web Service Control?</title>
+
+ <p>The Web Service Control provides an easy way to create a web service client
+ based on a valid WSDL document. A rudimentary client generator is provided
+ that will create a control extension that with a few simple modifications can
+ call the target web service using either XmlBeans (for Literal) or Axis Generated
+ Beans (for Encoded) as parameters and return types.</p>
+ <p>Type generation is handled ahead of the sample compilation so that all types used
+ in the control extension are already available on the classpath.</p>
+ </section>
+ </body>
+</document>
Propchange: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservicesDoc.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/tutorial/setup.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/tutorial/setup.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/tutorial/setup.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/tutorial/setup.xml Mon Aug 22 13:40:15 2005
@@ -1,30 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-
-<!--
- This template can be used as the starting point for authoring Beehive documentation. Just remember
- to author the Forrest subset of XHTML. More information can be found here:
-
- http://forrest.apache.org/docs_0_70/index.html
-
- -->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+ "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>Beehive Tutorial + Tomcat Setup</title>
</header>
<body>
- <p>The following steps are useful for configuring Tomcat to run the Beehive tutorials.</p>
<p>
- (1) Install the latest Tomcat 5.0.xx distribution file.
- Download: <a class="fork" href="http://jakarta.apache.org/site/binindex.cgi#tomcat">http://jakarta.apache.org/site/binindex.cgi#tomcat</a>
- </p>
- <p>
- (2) Ensure that the <code>CATALINA_HOME</code> environmental variable is set in your shell.
- </p>
- <p>
- (3) Edit the file <code>CATALINA_HOME/conf/tomcat-users.xml</code> so it appears as follows. Elements to add are shown in bold type.
- </p>
- <source>
+ The Beehive tutorials can be run on many different J2EE / Servlet application containers. Often, the tutorials use Tomcat as an
+ example application container during discussions of deployment and URLs. The following steps are useful for configuring
+ Tomcat to run the Beehive tutorials. Feel free to switch containers; just be sure to follow your application
+ container's deployment and URL address instructions
+ </p>
+ <p>
+ Because the Beehive NetUI requires JSP 2.0 and Servlet 2.4 features, the 5.0 version of Tomcat is the minimum container for running
+ Beehive-enabled applications.
+ </p>
+ <p>
+ (1) Install the latest Tomcat 5.x version -- download
+ <a class="fork" href="site:tomcatdownload">http://jakarta.apache.org/site/binindex.cgi#tomcat</a>
+ </p>
+ <p>
+ (2) Set the <code>CATALINA_HOME</code> environmental variable in your shell
+ </p>
+ <p>
+ (3) Optional. To easily deploy applications on Tomcat at build time, it is often useful to enable the <code>manager</code> username and role
+ in the <code>$CATALINA_HOME/conf/tomcat-users.xml</code> file. This allows the <code>manager</code> role to be used in conjunction with Tomcat's
+ Ant tasks for deploying, undeploying, and redeploying web applications. Note, for security reasons, the <code>manager</code> role should often
+ be enabled before deploying applications into production on Tomcat. An example <code>tomcat-users-xml</code> file is below; new XML elements
+ are shown below in <strong>bold</strong> type.
+ </p>
+ <source>
<?xml version='1.0' encoding='utf-8'?>
<tomcat-users>
<role rolename="tomcat"/>