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/21 00:57:26 UTC
svn commit: r171166 - in
/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs:
docs/index.xml pageflow/sample_jpf_jsf_integration.xml samples/index.xml
site.xml wsm/sample_AddressBookFromWSDL.xml
Author: steveh
Date: Fri May 20 15:57:25 2005
New Revision: 171166
URL: http://svn.apache.org/viewcvs?rev=171166&view=rev
Log: (empty)
Added:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/sample_jpf_jsf_integration.xml (with props)
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBookFromWSDL.xml (with props)
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/samples/index.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml?rev=171166&r1=171165&r2=171166&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml Fri May 20 15:57:25 2005
@@ -30,11 +30,7 @@
<ul>
<li><a href="site:jpetstore">Petstore Sample</a></li>
<li><a href="site:netui-samples">Page Flow Samples</a></li>
- <!--<li><a href="site:db-sample">Database Control Sample</a></li>
- <li><a href="site:address">AddressBookWS Sample</a></li>-->
<li><a href="site:address-enhanced">AddressBookEnhancedWS Sample</a></li>
- <!--<li><a href="site:employee">EmployeeWS Sample</a></li>-->
- <li><a href="site:wsm-samples">Web Service Annotation Samples</a></li>
</ul>
<p>The following <strong>application templates</strong> will help you get a project started:</p>
<ul>
Added: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/sample_jpf_jsf_integration.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/sample_jpf_jsf_integration.xml?rev=171166&view=auto
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/sample_jpf_jsf_integration.xml (added)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/sample_jpf_jsf_integration.xml Fri May 20 15:57:25 2005
@@ -0,0 +1,147 @@
+<?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>Page Flow: JSF Integration</title>
+ </header>
+ <body>
+ <section id="intro">
+ <title>Introduction</title>
+ <p>This sample shows how to integrate JSF (Java Server Faces) into your Page Flow
+ web app. For more information
+ see <a href="site:pageflow_jsf">Java Server Faces</a>.</p>
+ </section>
+ <section id="running">
+ <title>Running the Sample on Tomcat 5</title>
+ <p>The following instructions explain how to run the sample on Tomcat 5. The sample
+ will run on other web containers, but we have chosen Tomcat 5 for convenience.</p>
+ <section id="set_up">
+ <title>To Set up the Environment</title>
+ <p>Before proceeding, complete all of the necessary and optional steps in the
+ following topic:
+ <a class="fork" href="#setup">Beehive Installation and Setup</a></p>
+ <p>Open a command shell and confirm that you have set following variables:</p>
+ <ul>
+ <li><code>ANT_HOME</code></li>
+ <li><code>JAVA_HOME</code></li>
+ <li><code>CATALINA_HOME</code></li>
+ </ul>
+ <p>Also ensure that the following elements are on your <code>PATH</code>:</p>
+ <ul>
+ <li><code>ANT_HOME/bin</code></li>
+ <li><code>JAVA_HOME/bin</code></li>
+ </ul>
+ </section>
+ <section id="copy_app">
+ <title>To Copy the Application to a Project
+ Folder</title>
+ <p>To keep your Beehive distribution directory
+ pristine, you should copy the folder
+ <code><BeehiveRoot>/samples/netui-jsf</code> to another location before
+ proceeding.</p>
+
+ <note><BeehiveRoot> refers to the top-level directory of your Beehive installation.
+ A typical value for <BeehiveRoot> would be <code>C:/apache/apache-beehive-1.0</code>. </note>
+ <p>The following instructions assume that you have
+ copied the folder <code>netui-jsf</code> into the
+ directory <code>C:/beehive_projects</code>,
+ resulting in the following directory structure.</p>
+ <source>C:
+ beehive_projects
+ netui-jsf</source>
+ </section>
+ <section><title>To Download a JSF Implementation</title>
+ <p>Download and install one of the following JSF implementations:</p>
+ <ul>
+ <li><a href="http://www.marinschek.com/myfaces/tiki/tiki-index.php?page=GettingStarted">MyFaces</a></li>
+ <li><a href="http://java.sun.com/j2ee/javaserverfaces/download.html">JSF Reference Implementation</a></li>
+ </ul>
+ </section>
+ <section id="edit_properties_file"><title>To Edit the <code>build.properties</code> File</title>
+ <p>In this section you will edit the <code>build.properties</code> file--the file
+ that sets the build-related properties for your web application.</p>
+ <p>Open the file <code>C:/beehive_projects/netui-jsf/WEB-INF/src/build.properties</code>
+ in a text editor.</p>
+ <p>Edit the file so that the <code>beehive.home</code> property points to the
+ top-level folder of your beehive installation.</p>
+ <p>Also uncomment one of the properties <code>myfaces.dir</code> or <code>jsf-ri.dir</code>.
+ Point the uncommented property at the appropriate directory.</p>
+ <p>For example, if your beehive installation
+ resides at <code>C:/apache/apache-beehive-1.0</code>
+ and you have installed the JSF Reference Implementation,
+ then your <code>build.properties</code> file
+ would appear as follows.</p>
+ <source>beehive.home=<strong>C:/apache/apache-beehive-1.0</strong>
+
+servlet-api.jar=${os.CATALINA_HOME}/common/lib/servlet-api.jar
+jsp-api.jar=${os.CATALINA_HOME}/common/lib/jsp-api.jar
+
+context.path=netui-jsf
+
+# TODO:
+# if using MyFaces, uncomment the 'myfaces.dir' property and set it to a directory that contains
+# myfaces.jar (MyFaces v1.0.9 or later).
+#myfaces.dir=
+
+# TODO:
+# If using the JavaServer Faces Reference Implementation, uncomment the 'jsf-ri.dir' property and
+# set it to a directory that contains jsf-api.jar and jsf-impl.jar (JSF RI v1.1_01).
+<strong>jsf-ri.dir=C:/java/jsf-1_1_01/lib</strong></source>
+<note>Windows users must use forwardslashes (/) not backslashes (\) in the
+ <code>build.properties</code> file.</note>
+
+ </section>
+ <section id="compile">
+ <title>To Compile the Application</title>
+ <section><title>...If Using JSF Reference Implementation</title></section>
+ <p>If you are using the JSF Reference Implementation, enter the following Ant
+ command:</p>
+<source>ant
+ -f C:\beehive_projects\netui-jsf\WEB-INF\src\build.xml
+ clean
+ build-jsf-ri
+ war
+
+<strong>Copy and Paste version:</strong>
+ant -f C:\beehive_projects\netui-jsf\WEB-INF\src\build.xml clean build-jsf-ri war</source>
+ <section><title>...If Using MyFaces</title>
+ <p>If you are using MyFaces, enter the following Ant
+ command:</p>
+<source>ant
+ -f C:\beehive_projects\netui-jsf\WEB-INF\src\build.xml
+ clean
+ build-myfaces
+ war
+
+<strong>Copy and Paste version:</strong>
+ant -f C:\beehive_projects\netui-jsf\WEB-INF\src\build.xml clean build-myfaces war</source>
+
+ </section>
+ <p>Both of these targets build a WAR file and save it to:</p>
+ <source>C:/beehive_projects/netui-jsf.war</source>
+ </section>
+ <section id="start_tomcat">
+ <title>To Start Tomcat</title>
+ <p>To start Tomcat, run the following command:</p>
+ <source>%CATALINA_HOME%\bin\startup.bat</source>
+ </section>
+ <section id="deploy">
+ <title>To Deploy to Tomcat</title>
+ <p>To deploy the samples, copy the WAR file to Tomcat's <code>webapps</code> directory.</p>
+ <source>copy C:\beehive_projects\netui-jsf.war %CATALINA_HOME%\webapps /Y</source>
+ </section>
+ <section id="test">
+ <title>Running</title>
+ <p>To browse the JSF sample, visit the following link in a browser:</p>
+ <p><a class="fork" href="http://localhost:8080/netui-jsf">http://localhost:8080/netui-jsf</a></p>
+
+ </section>
+ </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/> © 2004, Apache Software Foundation </legal>
+ </footer>
+</document>
\ No newline at end of file
Propchange: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/sample_jpf_jsf_integration.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/samples/index.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/samples/index.xml?rev=171166&r1=171165&r2=171166&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/samples/index.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/samples/index.xml Fri May 20 15:57:25 2005
@@ -6,46 +6,52 @@
</header>
<body>
<p>Beehive ships with the following <strong>samples</strong> and
- <strong>application templates</strong>. Follow the links
+ <strong>project templates</strong>. Follow the links
for instructions on using the samples and templates.</p>
<p>
<strong>Samples</strong>
</p>
+<!--
+
+ <jpetstore label="Petstore" href="jpetstore.html"/>
+ <netui-samples label="Page Flow Samples" href="pageflow/netui-samples.html"/>
+ <netui-jsf label="Page Flow: JSF Integration" href="pageflow/sample_jpf_jsf_integration.html"/>
+ <address-enhanced label="Web Service: AddressBookEnhanced" href="wsm/sample_AddressBookEnhanced.html"/>
+ <address-wsdl label=" Web Service: AddressBookFromWSDL" href="wsm/sample_AddressBookFromWSDL.html"/>
+ <netui-blank label="Page Flow Project" href="pageflow/sample_netui-blank.html"/>
+ <control-blank label="Control Project" href="controls/sample_controls-blank.html"/>
+ <wsm-blank label="Web Service Project" href="wsm/sample_wsm-blank.html"/>
+ <ws-control-blank label="Web Service Control Project" href="system-controls/webservices/sample-ws-control-blank.html" />
+-->
<ul>
<li>
- <a href="../jpetstore.html">Beehive Sample: Petstore</a>
+ <a href="site:jpetstore">Petstore</a>
</li>
<li>
- <a href="../controls/sample_controls-db.html">Database Control
- Sample</a>
+ <a href="site:netui-jsf">Page Flow: JSF Integration</a>
</li>
- <!--<li>
- <a href="../wsm/sample_Dashboard.html">Beehive Web Service
- Sample: Petstore Dashboard</a>
- </li>-->
<li>
- <a href="../wsm/sample_AddressBook.html">Beehive AddressBookWS
- and EnhancedAddressBookWS Samples</a>
+ <a href="site:address-enhanced">Web Service: AddressBook Enhanced</a>
</li>
<li>
- <a href="site:wsm-samples">Web Service Annotation Samples</a>
+ <a href="site:address-wsdl">Web Service: AddressBook from WSDL</a>
</li>
</ul>
<p>
- <strong>Templates</strong>
+ <strong>Project Templates</strong>
</p>
<ul>
<li>
- <a href="../pageflow/sample_netui-blank.html">Page Flow Project
- Template</a>
+ <a href="site:netui-blank">Project: Page Flow</a>
</li>
<li>
- <a href="../controls/sample_controls-blank.html">Control
- Project Template</a>
+ <a href="site:control-blank">Project: Control</a>
</li>
<li>
- <a href="../wsm/sample_wsm-blank.html">Web Service Project
- Template</a>
+ <a href="site:wsm-blank">Project: Web Service</a>
+ </li>
+ <li>
+ <a href="site:ws-control-blank">Project: Web Service Control</a>
</li>
</ul>
</body>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml?rev=171166&r1=171165&r2=171166&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml Fri May 20 15:57:25 2005
@@ -69,16 +69,14 @@
<sam_index label="Samples" href="samples/index.html"/>
<jpetstore label="Petstore" href="jpetstore.html"/>
<netui-samples label="Page Flow Samples" href="pageflow/netui-samples.html"/>
- <!--<dash label="Petstore Dashboard" href="wsm/sample_Dashboard.html"/>-->
- <!--db-sample label="Database Control" href="controls/sample_controls-db.html"/-->
- <!--address label="AddressBook Web Service" href="wsm/sample_AddressBook.html"/-->
- <address-enhanced label="AddressBookEnhanced Web Service" href="wsm/sample_AddressBookEnhanced.html"/>
- <!--<employee label="Employee Web Service" href="wsm/sample_Employee.html"/>-->
- <wsm-samples label="Web Service Annotation Samples" href="wsm/sample_wsmAnnoSamples.html"/>
- <netui-blank label="Page Flow Project" href="pageflow/sample_netui-blank.html"/>
- <control-blank label="Control Project" href="controls/sample_controls-blank.html"/>
- <wsm-blank label="Web Service Project" href="wsm/sample_wsm-blank.html"/>
- <ws-control-blank label="Web Service Control Project" href="system-controls/webservices/sample-ws-control-blank.html" />
+ <netui-jsf label="Page Flow: JSF Integration" href="pageflow/sample_jpf_jsf_integration.html"/>
+ <address-enhanced label="Web Service: AddressBook Enhanced" href="wsm/sample_AddressBookEnhanced.html"/>
+ <address-wsdl label=" Web Service: AddressBook from WSDL" href="wsm/sample_AddressBookFromWSDL.html"/>
+ <!--<wsm-samples label="Web Service: Annotation Samples" href="wsm/sample_wsmAnnoSamples.html"/>-->
+ <netui-blank label="Project: Page Flow" href="pageflow/sample_netui-blank.html"/>
+ <control-blank label="Project: Control" href="controls/sample_controls-blank.html"/>
+ <wsm-blank label="Project: Web Service" href="wsm/sample_wsm-blank.html"/>
+ <ws-control-blank label="Project: Web Service Control" href="system-controls/webservices/sample-ws-control-blank.html" />
</samples>
<ref label="Reference Docs">
<controls label="Controls">
Added: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBookFromWSDL.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBookFromWSDL.xml?rev=171166&view=auto
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBookFromWSDL.xml (added)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBookFromWSDL.xml Fri May 20 15:57:25 2005
@@ -0,0 +1,145 @@
+<?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>Web Service Sample: AddressBook from WSDL</title>
+ </header>
+ <body>
+ <section id="intro">
+ <title>Introduction</title>
+ <p>This sample shows how to generate a web service from a WSDL file.</p>
+ </section>
+ <section id="running">
+ <title>Running the Sample</title>
+ <section id="reqs">
+ <title>Requirements for Running the Sample</title>
+ <p>To run the Samples, you need:</p>
+ <ul>
+ <li>Beehive</li>
+ <li>Tomcat 5</li>
+ <li>J2SE 5</li>
+ <li>Ant 1.6.2</li>
+ </ul>
+ </section>
+ <section id="enviro">
+ <title>To Set up the Environment</title>
+ <p>Before proceeding, complete all of the necessary and
+ optional steps in the following topic: <a class="fork"
+ href="../setup.html">Beehive Installation and Setup</a></p>
+ <p>Open a command shell and confirm that the following
+ variables have been set:</p>
+ <ul>
+ <li>
+ <code>ANT_HOME</code>
+ </li>
+ <li>
+ <code>CATALINA_HOME</code>
+ </li>
+ <li>
+ <code>JAVA_HOME</code>
+ </li>
+ </ul>
+ <p>Also ensure that the following elements are on your
+ <code>PATH</code>:</p>
+ <ul>
+ <li>
+ <code>ANT_HOME/bin</code>
+ </li>
+ <li>
+ <code>JAVA_HOME/bin</code>
+ </li>
+ </ul>
+ </section>
+ <section id="setup_server">
+ <title>To Set up the Server</title>
+ <section id="copy_app">
+ <title>To Copy the Application to a Project Folder</title>
+ <p>To keep your Beehive distribution directory pristine,
+ you should copy the application
+ folder to
+ another location before proceeding. The following
+ instructions assume that you have copied the folder</p>
+ <source><BeehiveRoot>/samples/wsm-addressbook-fromWSDL</source>
+<p> into the directory
+ <code>C:/beehive_projects</code>, resulting in the
+ following directory structure.</p>
+<source>C:
+ beehive_projects
+ wsm-addressbook-fromWSDL</source>
+ <note><BeehiveRoot> refers to the top-level directory of your Beehive installation.
+ A typical value for <BeehiveRoot> would be <code>C:/apache/apache-beehive-1.0</code>. </note>
+ </section>
+ <section id="start_tomcat">
+ <title>To Start Tomcat</title>
+ <p>To start Tomcat, run the following command:</p>
+ <source>%CATALINA_HOME%\bin\startup.bat</source>
+ </section>
+ <section id="edit_properties_file"><title>Edit the <code>build.properties</code> File</title>
+ <p>In this section you will edit the <code>build.properties</code> file--the file
+ that sets the build-related properties for the application.</p>
+ <p>Open the file <code>C:/beehive_projects/wsm-addressbook-fromWSDL/WEB-INF/src/build.properties</code>
+ in a text editor.</p>
+ <p>Edit the files so that the <code>beehive.home</code> property points to the
+ top-level folder of your beehive installation. For example, if you beehive installation
+ resides at <code>C:/apache/apache-beehive-1.0</code>, then your <code>build.properties</code> files
+ would appear as follows.</p>
+ <source>beehive.home=<strong>C:/apache/apache-beehive-1.0</strong></source>
+ </section>
+ <section><title>Select a Source WSDL</title>
+ <p>Select a source WSDL from which to generate a web service.
+ The generated web service will contain method signatures that
+ correspond to the request/response pattern outlined in the WSDL.
+ For example, if the WSDL contains an operation named "fooOperation" that takes an integer request
+ and responds with a string, then the following method will be generated:</p>
+ <source>String fooOperation(int n)
+ {
+ }</source>
+ <p>Place the selected WSDL in the following directory.</p>
+ <source>wsm-addressbook-fromWSDL/WEB-INF/wsdl/</source>
+ <p>The directory already contains a sample WSDL for the AddressBook web service.
+ </p></section>
+ <section><title>Generating a Web Service</title>
+ <p>To generate a web service from the WSDL file, run the following Ant target:</p>
+ <source>ant
+ -f C:\beehive_projects\wsm-addressbook-fromWSDL\WEB-INF\src\build.xml
+ source-gen
+
+<strong>Copy and paste version:</strong>
+ant -f C:\beehive_projects\wsm-addressbook-fromWSDL\WEB-INF\src\build.xml source-gen</source>
+ <p>Two artifacts are generated: (1) a web service file is written to WEB-INF/src-ws
+ and (2) the related Java types are written to WEB-INF/gen/types. (Note that the types
+ are also compiled directly into the WEB-INF/classes directory.)</p>
+ <p>The generated mehthods are all empty, so you must add code to implement
+ the remainder of the web service.</p>
+ <note>The <code>source-gen</code> target will overwrite previous build artifacts.
+ Beware that you do not lose work by running this target more than once.</note>
+ <note>This process only works for document-style web services.
+ For RPC-encoded web services, you must use Axis type generation.</note></section>
+ <section id="compile">
+ <title>Compiling the Generated Web Service</title>
+ <p>To compile the generated web service, enter the following Ant command.</p>
+<source>ant
+ -f C:\beehive_projects\wsm-addressbook-fromWSDL\WEB-INF\src\build.xml
+ clean
+ build
+ war
+
+<strong>Copy and paste version:</strong>
+
+ant -f C:\beehive_projects\wsm-addressbook-fromWSDL\WEB-INF\src\build.xml clean build war</source>
+
+<p>The command above creates a WAR file named <code>fromWSDLWS.war</code> and saves it
+ at C:\beehive_projects.</p>
+<p>To deploy the app to Tomcat, run the following command:</p>
+
+<source>copy C:\beehive_projects\fromWSDLWS.war %CATALINA_HOME%\webapps /Y</source>
+ </section>
+ </section>
+</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/> © 2004, Apache Software Foundation </legal>
+ </footer>
+</document>
\ No newline at end of file
Propchange: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBookFromWSDL.xml
------------------------------------------------------------------------------
svn:eol-style = native