You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by st...@apache.org on 2005/05/25 01:27:09 UTC
svn commit: r178318 - in
/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs:
controls/controlsContainment.xml pageflow/pageflow_building.xml
system-controls/jdbc/jdbcControlDevGuide.xml wsm/wsm_JWSFiles.xml
Author: steveh
Date: Tue May 24 16:27:09 2005
New Revision: 178318
URL: http://svn.apache.org/viewcvs?rev=178318&view=rev
Log:
Remaining fixes for BEEHIVE-764.
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/controlsContainment.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_building.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlDevGuide.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_JWSFiles.xml
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/controlsContainment.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/controlsContainment.xml?rev=178318&r1=178317&r2=178318&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/controlsContainment.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/controlsContainment.xml Tue May 24 16:27:09 2005
@@ -208,7 +208,7 @@
<p>The interactions between a control and its container are best expressed in terms of the set of functional services that the container provides to the control. This provides a basic framework for understanding what happens at runtime when a Control uses those services (for the Control author) as well as the effort required to integrate these services into a specific container (for the Control container developer).
</p>
- <section>
+ <!--<section>
<title>Nesting/Composition</title>
<p>To be completed</p>
</section>
@@ -232,7 +232,7 @@
<section><title>External Event Dispatch</title>
<p>To be completed</p>
- </section>
+ </section>-->
</section>
</body>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_building.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_building.xml?rev=178318&r1=178317&r2=178318&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_building.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_building.xml Tue May 24 16:27:09 2005
@@ -25,6 +25,9 @@
that the environment variable $WEBAPP_DIR points to the top-level of your
application.
</p>
+ <p>Here is a typical directory structure, an emandation of the core directory structure found in the
+ web app template <code><BeehiveRoot>/samples/netui-blank</code>. For instructions on using the web app
+ template, see <a href="site:netui-blank">Project: Page Flow</a>.</p>
<ul>
<li><code>$WEBAPP_DIR/</code>
@@ -78,6 +81,10 @@
or <code>.xml</code> files that need to be deployed with your application will be copied
from the <code>src/</code> directory to the <code>classes/</code> directory during the build.
</p>
+
+ <p><code>$WEBAPP_DIR/WEB-INF/src/</code> should also contain the build related files for the web app.
+ See the web app template <code><BeehiveRoot>/samples/netui-blank/WEB-INF/src</code> for an
+ example build file and supporting <code>build.properties</code> file.</p>
</section>
@@ -275,9 +282,37 @@
<section id="running_ant">
<title>Running Ant</title>
- <p>
- Before you can build the web-app using ant, you must ensure that the <code>BEEHIVE_HOME</code>
- and <code>CATALINA_HOME</code> variables are set correctly, along with <code>WEBAPP_DIR</code>.
+ <p>The following section assumes that you are using the Ant build.xml
+ file found at <code><BeehiveRoot>/samples/netui-blank/WEB-INF/src/</code>. We assume either (1)
+ that the build.xml file has been copied to <code>$WEBAPP_DIR/WEB-INF/src/</code>
+ or (2) that your web app has been developed by amending the template web app
+ <BeehiveRoot/samples/netui-blank. (For instructions on starting a web with the template web app, see
+ <a href="site:netui-blank">Project: Page Flow</a>.)</p>
+
+ <p>You also set the following properties in a supporting <code>build.properties</code>
+ file located at <code>$WEBAPP_DIR/WEB-INF/src/build.properties</code>.</p>
+
+ <ul>
+ <li><code>beehive.home</code> -- points to the top-level directory of your Beehive installation</li>
+ <li><code>servlet-api.jar</code> -- for Tomcat, this value is $CATALINA_HOME/common/lib/servlet-api.jar</li>
+ <li>jsp-api.jar -- for Tomcat, this value is $CATALINA_HOME/common/lib/jsp-api.jar</li>
+ <li>context.path -- determines (1) part of the URL where your web app resides, e.g., http://some.domain/<strong>contextPath</strong>/someDirectory,
+ and (2) the name of the compiled WAR file.</li>
+ </ul>
+
+ <p>An example <code>build.properties</code> file appears below.</p>
+
+ <p><strong>build.properties</strong></p>
+ <source>
+beehive.home=C:/apache/apache-beehive-1.0
+servlet-api.jar=${os.CATALINA_HOME}/common/lib/servlet-api.jar
+jsp-api.jar=${os.CATALINA_HOME}/common/lib/jsp-api.jar
+context.path=contextPath</source>
+
+ <p>
+ Before you can build the web-app using Ant, you must ensure that the
+ following variables are set: <code>ANT_HOME</code>, <code>JAVA_HOME</code>,
+ and <code>CATALINA_HOME</code>.
</p>
<table>
@@ -286,31 +321,39 @@
<th>Value</th>
</tr>
<tr>
- <td>BEEHIVE_HOME</td>
- <td>Top level of the Beehive distribution</td>
+ <td>ANT-HOME</td>
+ <td>Top level of your Ant distribution</td>
</tr>
<tr>
- <td>CATALINE_HOME</td>
- <td>Top level of the installed Tomcat server</td>
+ <td>JAVA_HOME</td>
+ <td>You must have JDK5 installed.</td>
</tr>
<tr>
- <td>WEBAPP_DIR</td>
- <td>Top level of the web-app to be built</td>
+ <td>CATALINA_HOME</td>
+ <td>Top level of the installed Tomcat server.</td>
</tr>
</table>
<p>
Once these variables are set correctly, building the deployable web-app
- requires a single ant invocation using the build file at <code>$BEEHIVE_HOME/ant/buildWebapp.xml</code>.
+ requires a single ant invocation using the build file at <code>$WEBAPP_DIR/WEB-INF/src/build.xml</code>.
This build-file is invoked using ant's <code>-f <buildfile-path></code> option.
- The directory of the web-app is passed on the commandline using the <code>-Dname=value</code>
- functionality of ant. Finally, the <code>build.webapp</code> target is invoked.
+ The directory of the web app is gleened from the supporting <code>build.properties file</code>.
+ Finally, the <code>clean</code>, <code>build</code>, and <code>war</code> targets are invoked in turn.
</p>
<source>
-ant -f $BEEHIVE_HOME/ant/buildWebapp.xml -Dwebapp.dir=$WEBAPP_DIR build
+ant -f $WEBAPP_DIR/WEB-INF/src/build.xml clean build war
</source>
+
+<p>The <code>clean</code> target deletes any old build artifacts from the <code>WEB-INF/classes</code> directory, and
+ other directories.</p>
+
+<p>The <code>build</code> target compiles new build artifacts from the source files.</p>
+
+<p>Finally, the <code>war</code> target zips up the results into a WAR file, named <code>contextPath.war</code>.</p>
+
</section>
<section id="deploying">
@@ -321,7 +364,7 @@
$WEBAPP_DIR to $CATALINA_HOME/webapps.
</p>
-<source>ln -s $WEBAPP_DIR $CATALINE_HOME/webapps</source>
+<source>ln -s $WEBAPP_DIR $CATALINA_HOME/webapps</source>
<p>Another way would be to simply copy
$WEBAPP_DIR to $CATALINE_HOME/webapps.</p>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlDevGuide.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlDevGuide.xml?rev=178318&r1=178317&r2=178318&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlDevGuide.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlDevGuide.xml Tue May 24 16:27:09 2005
@@ -451,8 +451,8 @@
<source>
import javax.transaction.Transaction;
- import weblogic.transaction.TransactionManager;
- import weblogic.transaction.TxHelper;
+ import javax.transaction.TransactionManager;
+ import javax.transaction.TxHelper;
TransactionManager tm = TxHelper.getTransactionManager();
Transaction saveTx = null;
@@ -527,8 +527,8 @@
<source>
import javax.transaction.Transaction;
- import weblogic.transaction.TransactionManager;
- import weblogic.transaction.TxHelper;
+ import javax.transaction.TransactionManager;
+ import javax.transaction.TxHelper;
TransactionManager tm = TxHelper.getTransactionManager();
Transaction saveTx = null;
@@ -1091,14 +1091,14 @@
<xsd:element name="XCustomerRow">
<xsd:complexType>
<xsd:sequence>
- <xsd:element name="CUSTID" type="xsd:int" wld:JDBCType="INTEGER" minOccurs="0" wld:TableName="WEBLOGIC.CUSTOMER" nillable="true"><xsd:element>
- <xsd:element name="NAME" type="xsd:string" wld:JDBCType="VARCHAR" minOccurs="0" wld:TableName="WEBLOGIC.CUSTOMER" nillable="true"><xsd:element>
- <xsd:element name="ADDRESS" type="xsd:string" wld:JDBCType="VARCHAR" minOccurs="0" wld:TableName="WEBLOGIC.CUSTOMER" nillable="true"><xsd:element>
- <xsd:element name="CITY" type="xsd:string" wld:JDBCType="VARCHAR" minOccurs="0" wld:TableName="WEBLOGIC.CUSTOMER" nillable="true"><xsd:element>
- <xsd:element name="STATE" type="xsd:string" wld:JDBCType="CHAR" minOccurs="0" wld:TableName="WEBLOGIC.CUSTOMER" nillable="true"><xsd:element>
- <xsd:element name="ZIP" type="xsd:string" wld:JDBCType="VARCHAR" minOccurs="0" wld:TableName="WEBLOGIC.CUSTOMER" nillable="true"><xsd:element>
- <xsd:element name="AREA_CODE" type="xsd:string" wld:JDBCType="CHAR" minOccurs="0" wld:TableName="WEBLOGIC.CUSTOMER" nillable="true"><xsd:element>
- <xsd:element name="PHONE" type="xsd:string" wld:JDBCType="CHAR" minOccurs="0" wld:TableName="WEBLOGIC.CUSTOMER" nillable="true"><xsd:element>
+ <xsd:element name="CUSTID" type="xsd:int" wld:JDBCType="INTEGER" minOccurs="0" wld:TableName="MYSCHEMA.CUSTOMER" nillable="true"><xsd:element>
+ <xsd:element name="NAME" type="xsd:string" wld:JDBCType="VARCHAR" minOccurs="0" wld:TableName="MYSCHEMA.CUSTOMER" nillable="true"><xsd:element>
+ <xsd:element name="ADDRESS" type="xsd:string" wld:JDBCType="VARCHAR" minOccurs="0" wld:TableName="MYSCHEMA.CUSTOMER" nillable="true"><xsd:element>
+ <xsd:element name="CITY" type="xsd:string" wld:JDBCType="VARCHAR" minOccurs="0" wld:TableName="MYSCHEMA.CUSTOMER" nillable="true"><xsd:element>
+ <xsd:element name="STATE" type="xsd:string" wld:JDBCType="CHAR" minOccurs="0" wld:TableName="MYSCHEMA.CUSTOMER" nillable="true"><xsd:element>
+ <xsd:element name="ZIP" type="xsd:string" wld:JDBCType="VARCHAR" minOccurs="0" wld:TableName="MYSCHEMA.CUSTOMER" nillable="true"><xsd:element>
+ <xsd:element name="AREA_CODE" type="xsd:string" wld:JDBCType="CHAR" minOccurs="0" wld:TableName="MYSCHEMA.CUSTOMER" nillable="true"><xsd:element>
+ <xsd:element name="PHONE" type="xsd:string" wld:JDBCType="CHAR" minOccurs="0" wld:TableName="MYSCHEMA.CUSTOMER" nillable="true"><xsd:element>
<xsd:sequence>
<xsd:anyAttribute namespace="http://www.bea.com/2002/10/weblogicdata" processContents="skip">lt;xsd:anyAttribute>
<xsd:complexType>
@@ -1293,7 +1293,7 @@
<title>PointBase 4.4 Type Mappings</title>
<p>The following table lists the relationships between database types and Java types for the
- PointBase Version 4.4 database, which is installed with WebLogic Server.</p>
+ PointBase Version 4.4 database.</p>
<table>
<tr><th>Java Data Types</th><th>JDBC Data Types</th><th>PointBase SQL Data Types (Version 4.4)</th></tr>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_JWSFiles.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_JWSFiles.xml?rev=178318&r1=178317&r2=178318&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_JWSFiles.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_JWSFiles.xml Tue May 24 16:27:09 2005
@@ -58,9 +58,7 @@
<wsdl:types> <schema elementFormDefault="qualified"
targetNamespace="targetNamespace = http://www.openuri.org/my/web/service/wsdl">
<element name="sayHelloWorld"> ... </source>
- <p>SOAP documents generated by the this web service will reference
- the namespace as so:</p>
- <source>[todo]</source>
+
</section>
<section id="at_webmethod">
@@ -83,7 +81,7 @@
return "Hello world!";
}
}</source>
- <p>[todo]</p>
+ <!--<p>[todo]</p>-->
</section>
<section id="at_webparam">
<title>@WebParam</title>
@@ -176,41 +174,41 @@
</source>
<p><!--Changing the method invoked...[todo: doable?]--></p>
</section>
- <section id="at_webresult"><title>@WebResult</title>
- <p>[todo]</p></section>
+ <!--<section id="at_webresult"><title>@WebResult</title>
+ <p>[todo]</p></section>-->
</section>
<section id="binding_annotations">
<title>Binding Annotations</title>
<p>These annotations let you control the network protocols and
message formats supported by your web service.</p>
- <section>
+ <!--<section>
<title>@SOAPBinding</title>
<p>[todo]</p>
- </section>
+ </section>-->
</section>
<section id="security_annotations">
<title>Security Annotations</title>
<p>These annotations let you request authentication and
authorization services from the web service's deployment
container.</p>
- <section>
+ <!--<section>
<title>@SecurityIdentity</title>
<p>[todo]</p>
</section>
<section>
<title>@SecurityRoles</title>
<p>[todo]</p>
- </section>
+ </section>-->
</section>
<section id="handler_annotations">
<title>Handler Annotations</title>
<p>These annotations let you intercept incoming and outgoing SOAP
messages for additional processing before and after the
execution of web service's business processes.</p>
- <section id="at_soapmessagehandlers">
+ <!--<section id="at_soapmessagehandlers">
<title>@SOAPMessageHandlers</title>
<p>[todo]</p>
- </section>
+ </section>-->
</section>
</body>
<footer>