Author: steveh
Date: Mon Mar 21 19:57:34 2005
New Revision: 158533
URL: http://svn.apache.org/viewcvs?view=rev&rev=158533
Log:
(1) Integrating changes to 'downloads.xml' in /trunk
(2) New WSM samples documentation
(3) Misc. Beta-related content
Added:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsmAnnoSamples.xml
(with props)
Modified:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/downloads.xml
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_databinding.xml
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_datagrid.xml
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_jsp.xml
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/site.xml
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/tabs.xml
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml
Modified:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/downloads.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/downloads.xml?view=diff&r1=158532&r2=158533
==============================================================================
---
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/downloads.xml
(original)
+++
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/downloads.xml
Mon Mar 21 19:57:34 2005
@@ -7,7 +7,16 @@
</header>
<body>
<section>
- <title>Beehive V1 Alpha Binary Distribution</title>
+ <title>Beehive 1.0 Beta RC1 Binary Distribution</title>
+ <p>The first Beehive 1.0 Beta Release Candidate #1 (RC1) binary
distribution is available for
+ download at <a
href="http://cvs.apache.org/dist/incubator/beehive/nightlies/v1.0-beta-rc1/bin/";>http://cvs.apache.org/dist/incubator/beehive/nightlies/v1.0-beta-rc1/bin/</a>.
+ This distribution is a <em>candidate</em> for
the beta release and is
+ <em>not</em> intended for creating
production-level
+ applications. Please try it out and file "v1beta" bugs
against it; we are in the final stages of
+ locking down for beta, so this is your last chance to
influence what goes into it.</p>
+ </section>
+ <section>
+ <title>Beehive 1.0 Alpha Binary Distribution</title>
<p>The Beehive 1.0 Alpha binary distribution is
available for
download at <a
href="http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/";>http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/</a>.
@@ -17,10 +26,9 @@
</section>
<section>
<title>Daily Binary Distributions</title>
- <p>Beehive doesn't have automated daily drops yet. But
we do
- periodically post manually built drops. We
currently have one
- daily drop, dated March 2nd, 2005, available at
<a
-
href="http://cvs.apache.org/dist/incubator/beehive/nightlies/";>http://cvs.apache.org/dist/incubator/beehive/nightlies/</a>
+ <p>Beehive doesn't have automated daily drops yet, but
we do
+ periodically post manually built drops,
available at:
+ <a
href="http://cvs.apache.org/dist/incubator/beehive/nightlies/";>http://cvs.apache.org/dist/incubator/beehive/nightlies/</a>
</p>
</section>
<section>
@@ -41,4 +49,4 @@
<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
+</document>
Modified:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_databinding.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_databinding.xml?view=diff&r1=158532&r2=158533
==============================================================================
---
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_databinding.xml
(original)
+++
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_databinding.xml
Mon Mar 21 19:57:34 2005
@@ -20,7 +20,7 @@
can pass data in the opposite direction from
the presentation layer to the processing layer.
</p>
<p>The one-way, read-only contexts are: requestScope,
url, sessionScope, container, pageContext, bundle, pageInput</p>
- <p>The two-way, read-write contexts are: pageFlow,
globalApp, actionForm</p>
+ <p>The two-way, read-write contexts are: pageFlow,
sharedFlow, actionForm</p>
</section>
<section id="contexts">
<title>Summary of Binding Contexts</title>
@@ -145,14 +145,65 @@
</tr>
</table>
</section>
- <section>
+ <section id="individual_binding_contexts">
<title>Individual Binding Contexts</title>
<section id="actionForm">
<title>
<code>actionForm</code>
</title>
+ <p>To bind to data in a form bean, you use the
<code>actionForm</code>
+ context.
+ In the following example a JSP's form
fields are pre-populated
+ by binding to the fields of a form
bean.
+ Assume that you navigate to the JSP page via the following
action method.
+ Notice that the <code>Forward</code>
object is constructed with
+ two parameters: the first parameter is
the string "update", the second
+ parameter is a form bean
(DatabaseForm). By constructing the
+ Forward object in this way, the
<code>actionForm</code> context
+ is automatically filled with the form
bean values, values which can
+ be retrieved by the navigated-to JSP
page.
+ </p>
+ <source>@Jpf.Action(
+ forwards={
+ @Jpf.Forward( name="update", path="updateItems.jsp" )
+ }
+)
+public Forward updateItems(DatabaseForm form)
+{
+ ...
+ // Read from the database
+ // and apply the values to the form bean.
+ form.applyValuesToForm(getCurrentRow());
+
+ // Construct a Forward object using the form bean.
+ return new Forward("update", form);
+}</source>
+ <p>The action method above reads a record from
a database using a
+ Database control (the control code is
omitted in the
+ example) and populates the fields in
the form bean with the
+ record data before navigating to the
JSP <code>updateItems.jsp</code>.
+ The values are retrieved by the JSP page, using the
<code>actionForm</code>
+ context:</p>
+ <source><netui:form action="submitUpdate">
+ <netui:content value="{actionForm.itemnumber}"/>
+ <netui:textBox dataSource="{actionForm.itemname}"/>
+ ...
+</netui:form></source>
+ <p>When the <netui:form> is submitted
+ (<code>submitUpdate</code>), you can
then write the updated
+ values back to the database:</p>
+ <source>@Jpf.Action(
+ forwards={
+ @Jpf.Forward( name="updated", path="getItems.jsp" )
+ }
+)
+public Forward submitUpdate(DatabaseForm aDatabaseForm)
+{
+ // code that calls the database control and updates the database
+ return new Forward("updated");
+}</source>
</section>
- <section id="application">
+ <section id="applicationScope">
<title>
<code>applicationScope</code>
</title>
@@ -167,6 +218,99 @@
<code>container</code>
</title>
</section>
+ <section id="pageFlow">
+ <title>
+ <code>pageFlow</code>
+ </title>
+ <p>When you define a variable in your
controller class, you can access this
+ variable from any JSP page that is part
of that page flow. For example,
+ if the JPF file contains this code:</p>
+
+<source>public class SimpleflowController extends PageFlowController
+{
+ public String labelName = "This is a label"
+ ...
+</source>
+<p>You can access this variable on a JSP, for instance by using a
<netui:label>:</p>
+
+<source><netui:label value="{pageFlow.labelName}" /></source>
+
+<p>The variable is read-write and can be changed, for instance in the
controller's action
+ method as is shown in the next example:</p>
+
+<source>
+
[EMAIL PROTECTED](
+ forwards={
+ @Jpf.Forward( name="success", path="nextPage.jsp" )
+ }
+)
+public Forward labelAction(NameActionForm form)
+{
+ ...
+ labelName = "Default Label";
+ return new Forward( "success");
+}
+</source>
+
+<p>It can also be changed in a JSP by using a form, as is shown next:</p>
+
+<source> <netui:form action="submitAction">
+ <netui:textBox dataSource="{pageFlow.labelName}"/>
+ ...
+ <netui:button value="submit"/>
+ </netui:form></source>
+
+<p>In this example, the text box will display the current value of the
pageFlow's labelName
+variable when the form is first loaded, and upon submit the variable will hold
the new
+value the user entered.</p>
+
+<p><strong>Accessing Page Flow Properties</strong></p>
+
+<p>In the example used above, the page flow property was defined as a public
member variable
+ in the page flow controller class. Alternatively you can define a
private variable and
+ provide access with a getter and setter method, as is shown in the
following example:</p>
+
+<source> private String firstName;
+
+ public String getFirstName() {
+ return firstName;
+ }
+
+ public void setFirstName(String aStr) {
+ firstName = aStr;
+ }</source>
+
+<p>You can access this variable on a JSP exactly like before. For instance,
you can bind the
+ value to a netui:label as is shown next:</p>
+
+<source><netui:label value="{pageFlow.firstName}" /></source>
+
+<p>In the example the method getFirstName is used to provide read access to
the variable. </p>
+
+<p>You can also define and access variables that are part of an object created
in the
+ controller class. You can provide access by using getter and setter
methods, or
+ by referencing the object and property name. The latter option is shown
next.
+ For instance, if the JPF file contains the code:</p>
+
+<source>public class dataFlowController extends PageFlowController
+{
+ ...
+ public Names myNames = new Names();
+ ...
+ public class Names implements Serializable {
+ public String firstName;
+ public String lastName;
+ }
+ ...</source>
+
+<p>You can access the firstName property in a JSP like this:</p>
+
+<source><netui:label value="{pageFlow.myNames.firstName}" /></source>
+
+<p>The comments in this section regarding access of page flow properties also
apply to
+ properties defined to the <a
href="#sharedFlow"><code>sharedFlow</code></a> context.</p>
+ </section>
<section id="pageInput">
<title>
<code>pageInput</code>
@@ -181,12 +325,58 @@
<title>
<code>sessionScope</code>
</title>
+<p>You can use the <code>sessionScope</code> context to read data from the
+ session object (an implicit JSP object). Assuming that the session
object contains
+ some data in its attribute map:</p>
+
+<source>getSession().setAttribute("myAttributeKey", myObject);</source>
+
+<p>then, you can read the data onto a JSP page as follows:</p>
+
+<source><netui:content
value="{sessionScope.myAttributeKey.someProperty}"></netui:content></source>
+
</section>
<section id="sharedFlow">
<title>
<code>sharedFlow</code>
</title>
- <p>SharedFlow properties can be accessed from a
JSP using the scope sharedFlow, for example,</p>
+<p>If you need an attribute to be available across all the page flows in a web
application's
+ user (browser) session, such as a user's unique session key, you can
use shared flow.
+ By convention, shared flows are located in WEB-INF/src/shared. (For
details on creating
+ a shared flow, see <a href="site:pageflow_sharedFlow">Shared Flow</a>.)
In addition to
+ session-wide attributes, you can also use the shared flow to define
fallback action methods
+ and exception handlers. </p>
+
+<p>If you define a variable in the shared flow class:</p>
+
+<source>public class SharedFlow extends SharedFlowController
+{
+ public String defaultText = "Please Define";
+
+ ...
+}
+</source>
+
+<p>and your controller file references the shared flow:</p>
+
+<source>@Jpf.Contoller(
+ sharedFlowsRefs = {
+ @Jpf.SharedFlowRef(name = "specificSharedFlow", type =
"SharedFlow.class")
+ }
+)
+public class SomeController extends Controller
+{
+...
+}</source>
+
+<p>you can use the databinding context <code>shareFlow</code> in a JSP
file:</p>
+
+<source><netui:textBox dataSource="{actionForm.firstName}"
defaultValue="{sharedFlow.specificSharedFlow.defaultText}"/></source>
+
+<p>Notice that the <netui:textBox> tag in the example binds to a form bean
to post data and
+ binds to sharedFlow's defaultText to receive its default value.</p>
+
+<p>SharedFlow properties can be accessed from a JSP using the scope
sharedFlow, for example,</p>
<source>dataSource="sharedFlow.specificSharedFlow.someProperty"</source>
@@ -194,7 +384,8 @@
<source>action="specificSharedFlow.someAction"</source>
- <p>where specificSharedFlow was the name given to the sharedFlow in
the JPF annotation</p>
+ <p>where specificSharedFlow was the name given to the sharedFlow in
the JPF
+ annotation <code>Jpf.SharedFlowRef</code>.</p>
</section>
<section id="url">
<title>
Modified:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_datagrid.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_datagrid.xml?view=diff&r1=158532&r2=158533
==============================================================================
---
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_datagrid.xml
(original)
+++
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_datagrid.xml
Mon Mar 21 19:57:34 2005
@@ -6,20 +6,114 @@
</header>
<body>
<section id="database_driven">
- <title>Database Driven Web Applications</title>
+ <title>Database-Driven Web Applications</title>
+ <p>A database-driven Beehive web application has the
the follow components:
+ </p>
+ <ul>
+ <li>one or more page flows (= a
controller file + JSP pages)</li>
+ <li>one or more database control
files</li>
+ <li>one or more databases</li>
+ </ul>
+ <p>A basic schema for a database-driven application is
shown below.</p>
<p><img src="images/pageflow_database_app_1.png"
alt="pageflow_database"/></p>
+ <p><strong>The Database</strong></p>
+ <p>The role of the database is as a storehouse for the
data. The database persists
+ the data from session to session and is the
common object which users view and
+ operate upon.</p>
+ <p><strong>The Database Control</strong></p>
+ <p>The database control handles the data traffic with
the database. The database
+ control is a Java class that handles the
database connection and handles the individual
+ operations on the database. Typically, the
methods in the class have associated
+ SQL statements: when a method is called, the
associated SQL statement is sent to the
+ database. Any data returned by the database is
transformed by the method
+ into an appropriate Java object so it is
available to the rest of the web
+ application.</p>
+ <p>For more database control implementations you can
download and use in applications,
+ see <a href="site:db-sample">Database Control
Sample</a>
+ and <a href="http://jdbc.controlhaus.org/";
class="fork">Controlhaus's JDBC Control</a></p>
+
+ <p><strong>The Page Flow</strong></p>
+ <p>The Page Flow(s) form the front-end user
interface of the application. Through
+ the JSP pages, users can add, delete, update,
and view the data in the database.
+ Beehive provides a specialized tag libarary for
viewing and managing
+ the complex data sets associated with database
applications:
+ <a
href="../apidocs/taglib/taglib-overview-summary.html#netui-data"><code><netui-data:xxx></code></a>.</p>
+ <p>The remainder of this topic concentrates on using
the <netui-data:xxx>
+ tab library to handle data sets.</p>
</section>
<section id="pager">
<title>The <netui-data:pager> Tag</title>
</section>
<section id="filtering">
<title>Filtering a Data Grid</title>
+ <p>A filter is specified using three bits of information -- the filter
expression,
+ the filter operation, and the filter value. The filter
expression is specified
+ as an attribute on a grid's header cell and is used to loosely
couple the filetr
+ information for the header from the data displayed in the
header. </p>
+ <source>netui_filter=<grid name>~<filter expression>~<filter
operation>~<filter value></source>
+ <p>For example, the filter</p>
+ <source>netui_filter=portfolio~symbol~eq~beas</source>
+ <p>converts into the SQL filter</p>
+ <source>WHERE symbol = beas</source>
+ <p>Filters are added to the URL using JavaScript to convert an HTML
form from the
+ input fields into query parameters in the above format. </p>
</section>
<section id="sorting">
<title>Sorting a Data Grid</title>
+<p>A sort is specified using two bits of information -- the sort expression
and the sort
+ direction. The sort expression is specified as an attribute on a
grid's header cell
+ and is used to loosely couple the sort information for the header from
the data displayed
+ in the header. A sort appears in the URL as:</p>
+
+<source>netui_sort=<grid name>~<direction><sort
expression>[,<direction><sort expression>]</source>
+
+<p>The sort parameter is scoped to a data grid using the <grid name>. The
<direction>
+ defaults to ascending and is set to descending when <direction> is
"-"
+There can be two sorts specified in the query param; if two are present, they
are
+separated by a comma.</p>
+
+<p>A sort link is added to a <headerCell> when the disableFilterRendering
attribute is false.
+ If set to true, no sort link is rendered. The sort link for a header
cell consists of all
+ of the parameters on the previous URL with the direction of the current
column's sort
+ switched using the following state transitions:</p>
+
+<ul>
+ <li>no sort > ascending</li>
+ <li>ascending > descending</li>
+ <li>descending > no sort</li>
+</ul>
</section>
- <section>
+ <section id="sample_code">
<title>Sample Code</title>
+
+ <p><strong>carDB.java</strong></p>
+ <source>package controls.data;
+
+import java.sql.SQLException;
+import java.sql.ResultSet;
+import org.controlhaus.jdbc.JdbcControl;
+
+/**
+ * This control contains access to the car inventory
+ */
+
[EMAIL PROTECTED]
[EMAIL PROTECTED](databaseDriverClass="org.apache.derby.jdbc.EmbeddedDriver",
databaseURL="jdbc:derby:C:/beehive_projects/Westside/Westside/data/testdb")
+
+public interface carDB extends JdbcControl {
+
+ // countCars() - this is more of a test to see if everything is working
+ @SQL(statement="SELECT COUNT(*) FROM CARS")
+ public int countCars() throws SQLException;
+
+ // getInventoryRS() - get all the cars from the inventory view
+ @SQL(statement="SELECT * FROM CARINVENTORY")
+ public ResultSet getInventoryRS() throws SQLException;
+
+ // getItem() - get an individual car from the inventory view
+ @SQL(statement="SELECT * FROM CARINVENTORY WHERE SKU = {nSKU}")
+ public ResultSet getItem(int nSKU) throws SQLException;
+}</source>
<p><strong>Controller.jpf</strong></p>
<source>import java.sql.ResultSet;
import javax.servlet.http.HttpSession;
Modified:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_jsp.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_jsp.xml?view=diff&r1=158532&r2=158533
==============================================================================
---
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_jsp.xml
(original)
+++
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_jsp.xml
Mon Mar 21 19:57:34 2005
@@ -8,7 +8,6 @@
<section id="introduction">
<title>Introduction</title>
-
<p>
Continuing with the same model used in previous pages of this
documentation set,
examples will reference this:
@@ -20,9 +19,20 @@
<p>
Java Page Flow adds a handful of tag libraries to normal JSP usage to
assist with the
- binding of the JSP pages to the controller class. Of primary importance
is the
- <code>netui/tags-html</code> taglib. Other taglibs provide additional
functionality
+ binding of the JSP pages to the controller class. Of primary importance
in this topic is the
+ <a
href="../apidocs/taglib/taglib-overview-summary.html#netui"><code><netui:xxx></code></a>
+ tag library.</p>
+ <p>Other tag libraries provide additional functionality. The
+ <a
href="../apidocs/taglib/taglib-overview-summary.html#netui-data"><code><netui-data:xxx></code></a>
+ tag library binds to complex data sets (especially result sets) and
renders them as HTML.
+ The <a
href="../apidocs/taglib/taglib-overview-summary.html#netui-template"><code><netui-template:xxx></code></a>
+ tag library lets you templatize common parts of the presentation layer,
so that you can re-use
+ common elements (such as headers, footers, etc.) across the different
JSP pages in the web app.
</p>
+
+ <p>Page Flows also make extensive use of <strong><em>databinding
expressions</em></strong>
+ to bind the JSP pages to data in the controller class. For a detailed
explanation
+ of databinding expressions see <a
href="site:pageflow_databinding">Databinding: Passing Data Between Controller
Classes and JSP Pages</a> </p>
</section>
Modified:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/site.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/site.xml?view=diff&r1=158532&r2=158533
==============================================================================
---
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/site.xml
(original)
+++
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/site.xml
Mon Mar 21 19:57:34 2005
@@ -17,10 +17,10 @@
<pageflow_overview label="Overview"
href="pageflow/pageflow_overview.html"/>
<pageflow_controllers label="Controller Files"
href="pageflow/pageflow_controllers.html"/>
<pageflow_jsp label="JSP Files" href="pageflow/pageflow_jsp.html"/>
- <pageflow_databinding label="Databinding"
href="pageflow/pageflow_databinding.html"/>
<pageflow_building label="Building a Web-App"
href="pageflow/pageflow_building.html"/>
<pageflow_altering label="Altering a Page Flow"
href="pageflow/pageflow_altering.html"/>
- <pageflow_sharedFlow label="Using Data Grids"
href="pageflow/pageflow_datagrid.html"/>
+ <pageflow_databinding label="Databinding"
href="pageflow/pageflow_databinding.html"/>
+ <pageflow_datagrid label="Using Data Grids"
href="pageflow/pageflow_datagrid.html"/>
<pageflow_sharedFlow label="Shared Flow"
href="pageflow/sharedFlow.html"/>
<pageflow_popups label="Popup Windows"
href="pageflow/popupWindows.html"/>
<pageflow_programming label="Page Flow Programming"
href="pageflow/guide.html"/>
@@ -41,8 +41,9 @@
<sam_index label="Samples" href="samples/index.html"/>
<jpetstore label="Petstore" href="jpetstore.html"/>
<!--<dash label="Petstore Dashboard"
href="wsm/sample_Dashboard.html"/>-->
+ <db-sample label="Database Control"
href="controls/sample_controls-db.html"/>
<address label="AddressBook" href="wsm/sample_AddressBook.html"/>
- <db label="Database Control"
href="controls/sample_controls-db.html"/>
+ <wsm-samples label="WSM Annotation Samples"
href="wsm/sample_wsmAnnoSamples.html"/>
<control-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"/>
@@ -70,7 +71,7 @@
<controlhaus label="Controlhaus" href="http://www.controlhaus.com/"/>
<jira label="Bugs and Issues"
href="http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10570"/>
<pollinate label="Pollinate" href="http://www.eclipse.org/pollinate/"/>
- <svn label="Browse SVN"
href="http://svn.apache.org/repos/asf/incubator/beehive/trunk/"/>
+ <svn label="Browse SVN"
href="http://svn.apache.org/viewcvs.cgi/incubator/beehive/"/>
</links>
</site>
<!--
Modified:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/tabs.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/tabs.xml?view=diff&r1=158532&r2=158533
==============================================================================
---
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/tabs.xml
(original)
+++
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/tabs.xml
Mon Mar 21 19:57:34 2005
@@ -17,6 +17,6 @@
be displayed when their parent tab is selected.
-->
- <tab id="welcome" label="Beehive" dir="" indexfile="index.html"/>
+ <tab id="welcome" label="Beehive 1.0 Beta" dir="" indexfile="index.html"/>
<!--<tab id="docs" label="Documentation" dir="docs"
indexfile="index.html"/>-->
</tabs>
Modified:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBook.xml?view=diff&r1=158532&r2=158533
==============================================================================
---
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
(original)
+++
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
Mon Mar 21 19:57:34 2005
@@ -3,11 +3,11 @@
"http://forrest.apache.org/dtd/document-v20.dtd";>
<document>
<header>
- <title>Beehive AddressBookWSSample</title>
+ <title>Beehive AddressBookWS and EnhancedAddressBookWS
Samples</title>
</header>
<body>
<section id="intro">
- <title>The AddressBookWS Sample</title>
+ <title>The Samples</title>
<p>The <strong>AddressBookWS</strong> sample is an
annotation-aware
web service based on the Apache Axis sample of
the same name.
AddressBookWS is organized as an application
with POJO (Plain
@@ -16,6 +16,9 @@
provides automatic client-generation and junit
test cases for
the sample. The directory structure and Ant
build file can be
used as a template for building new standalone
web services.</p>
+ <p>The <strong>EnhancedAddressBookWS</strong> sample is
a more comprehensive
+ version of the AddressBookWS sample: it uses
more metadata annotations,
+ has customized annotations properties, and
shows exception handling.</p>
<!--<p><strong>EmployeeWS</strong> provides a web
service interface for
an Employee database. Using SOAP messages, the
web service
queries the backend database: selecting,
updating and inserting
@@ -31,11 +34,11 @@
<p><!--Apache Derby supplies the database
implementation. (Installing
Derby requires a simple JAR file download,
described below.)-->
Apache Axis provides the automatic
client-generation for the
- web service. Custom unit tests are provided to
exercise the
- webservice methods. The unit tests create the
database table,
+ web services. Custom unit tests are provided to
exercise the
+ webservice methods. The unit tests create the
database tables,
insert new records, query the database, and
finally drop
- the table. Use the junit tests as a template
for building
- automatic tests for your own controls.</p>
+ the tables. Use the junit tests as a template
for building
+ automatic tests for your own web services</p>
</section>
<section id="running">
<title>Running the Samples</title>
@@ -85,9 +88,8 @@
</section>
<section id="setup_server">
<title>To Set up the Server</title>
- <section id="copy_app">
- <title>To Copy the Petstore Application
to a Project
- Folder</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
<code>AddressBookWS</code> and <code>EmployeeWS</code>
folders to
@@ -99,8 +101,13 @@
<source>C:
beehive_projects
wsm-addressbook
- <!--EmployeeWS--></source>
- </section>
+ EmployeeWS</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="external_jars">
<title>To Download Junit the JAR
File<!--and Derby JAR Files--></title>
<p>Download the junit ZIP archive from <a
@@ -113,25 +120,43 @@
<p>Unzip the archive, locate
<code>derby.jar</code>, and copy <code>derby.jar</code> to
<code>C:/beehive_projects/EmployeeWS/WEB-INF/lib</code>.</p>-->
</section>
-<section id="edit_build_file"><title>Edit the <code>build.xml</code>
File</title>
- <p>Open the following build file.</p>
-
<source>C:\beehive_projects\wsm-addressbook\WEB-INF\build.xml</source>
- <p>Edit the following line</p>
- <source> <import
file="../../../beehive-imports.xml" /></source>
- <p>so that it points to the
- <code>beehive-import.xml</code> file,
for example:</p>
- <source> <import
file="C:/apache/apache-beehive-1.0/beehive-imports.xml" /></source>
- </section>
+ <section id="edit_properties_file"><title>Edit the
<code>build.properties</code> Files</title>
+ <p>In this section you will edit the
<code>build.properties</code> files--the files
+ that set the build-related properties
for the web services.</p>
+ <p>Open the files
<code>BEEHIVE_HOME/samples/wsm-addressbook/WEB-INF/src/build.properties</code>
+ and
<code>BEEHIVE_HOME/samples/wsm-addressbook-enhanced/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 id="compile">
- <title>To Compile the App</title>
+ <title>To Compile the Apps</title>
<p>To compile the AddressBookWS app, enter the following Ant
command.</p>
<source>ant
- -f C:\beehive_projects\wsm-addressbook\WEB-INF\build.xml
- build
+ -f %BEEHIVE_HOME%\samples\wsm-addressbook\WEB-INF\build.xml
+ -Dto.dir=%CATALINA_HOME%\webapps
+ clean
+ build
+ deploy
+
+<strong>Copy and paste version:</strong>
+
+ant -f %BEEHIVE_HOME%\samples\wsm-addressbook\WEB-INF\build.xml
-Dto.dir=%CATALINA_HOME%\webapps clean build deploy</source>
+
+ <p>To compile the EnhancedAddressBookWS
app, enter the following Ant command.</p>
+<source>ant
+ -f %BEEHIVE_HOME%\samples\wsm-addressbook-enhanced\WEB-INF\build.xml
+ -Dto.dir=%CATALINA_HOME%\webapps
+ clean
+ build
+ deploy
<strong>Copy and paste version:</strong>
-ant -f C:\beehive_projects\wsm-addressbook\WEB-INF\build.xml build</source>
+ant -f %BEEHIVE_HOME%\samples\wsm-addressbook-enhanced\WEB-INF\build.xml
-Dto.dir=%CATALINA_HOME%\webapps clean build deploy</source>
<!-- <p>To compile the EmployeeWS app, enter the following Ant
command.</p>
<source>ant
-f %BEEHIVE_HOME%\ant\buildWebapp.xml
@@ -141,88 +166,47 @@
<strong>Copy and paste version:</strong>
ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=C:\beehive_projects\EmployeeWS build</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_to_tomcat">
- <title>To Deploy to Tomcat</title>
- <p>To deploy the applications, click the following links. We recommend
that you open the
- links in new browser windows. Each time you want to redeploy
an application,
- simply refresh the appropriate browser.</p>
- <p>This method of application deployment assumes that you have added
the <code>manager</code>
- role to your Tomcat installation. For instructions on adding
the <code>manager</code> role,
- see <a class="fork" href="../setup.html#optional">Beehive
Installation and Setup</a>.</p>
- <p class="quote">
- <a class="fork"
href="http://localhost:8080/manager/deploy?path=/AddressBookWS&war=file:C:/beehive_projects/wsm-addressbook&update=true";>http://localhost:8080/manager/deploy?path=/AddressBookWS&war=file:C:/pageflow_projects/wsm-addressbook&update=true</a>
- </p>
-<!-- <p class="quote">
- <a class="fork"
href="http://localhost:8080/manager/deploy?path=/EmployeeWS&war=file:C:/beehive_projects/EmployeeWS&update=true";>http://localhost:8080/manager/deploy?path=/EmployeeWS&war=file:C:/pageflow_projects/EmployeeWS&update=true</a>
- </p>-->
- <p>If you are prompted for a username/password, enter:
<code>manager/manager</code></p>
- <p>(For an explanation of this method of deploying an application to
Tomcat,
- see the Tomcat 5 documentation:
- <a class="fork"
href="http://jakarta.apache.org/tomcat/tomcat-5.0-doc/manager-howto.html#Deploy%20A%20New%20Application%20from%20a%20Local%20Path";>Deploy
A New Application from a Local Path</a>)</p>
- </section>
<section id="verify_deploy"><title>To Verify the
Deployments</title>
- <p>Verify that the web service is running by
pointing your
+ <p>Verify that the web services is running by
pointing your
browser to:</p>
<p>
<a class="fork"
href="http://localhost:8080/AddressBookWS/";>
http://localhost:8080/AddressBookWS/</a>
</p>
-<!-- <p>and</p>
- <p>
- <a class="fork"
href="http://localhost:8080/EmployeeWS/";>
-
http://localhost:8080/EmployeeWS/</a>
- </p>-->
- <p>Follow the validation link (<a class="fork"
-
href="http://localhost:8080/AddressBookWS/happyaxis.jsp";>http://localhost:8080/AddressBookWS/happyaxis.jsp</a>
- <!--and <a class="fork"
-
href="http://localhost:8080/EmployeeWS/happyaxis.jsp";>http://localhost:8080/EmployeeWS/happyaxis.jsp</a>)
- -->
- to see the verification page.</p>
- <p>For the WSDLs visit</p>
+ <p>and</p>
<p>
- <a
href="http://localhost:8080/AddressBookWS/web/Service.jws?wsdl";>http://localhost:8080/AddressBookWS/web/Service.jws?wsdl</a>
+ <a class="fork"
href="http://localhost:8080/EnhancedAddressBookWS/";>
+
http://localhost:8080/EnhancedAddressBookWS/</a>
</p>
-<!-- <p>
- <a
href="http://localhost:8080/EmployeeWS/web/Service.jws?wsdl";>http://localhost:8080/EmployeeWS/web/Service.jws?wsdl</a>
- </p>-->
+ <p>Follow the validation WSDL links for each
web service.</p>
</section>
</section>
<section id="setup_clients">
<title>To Run the Web Service Clients</title>
- <p>Open the following build file.</p>
-
<source>C:\beehive_projects\AddressBookWS\WEB-INF\build-client-dist.xml</source>
-
<!--<source>C:\beehive_projects\EmployeeWS\WEB-INF\build-client-dist.xml</source>-->
- <p>Edit the following line</p>
- <source> <import
file="../../../beehive-imports.xml" /></source>
- <p>so that it points to the
- <code>beehive-import.xml</code> file,
for example:</p>
- <source> <import
file="C:/apache/apache-beehive-1.0/beehive-imports.xml" /></source>
- <p>To generate and run the client, run the
following build file.</p>
-<source>ant -f
C:/beehive_projects/AddressBookWS/WEB-INF/build-client-dist.xml</source>
+
+ <p>To generate and run the client, run the
following build files.</p>
+<source>ant -f
%BEEHIVE_HOME%\samples\wsm-addressbook\WEB-INF\build-client.xml</source>
+<source>ant -f
%BEEHIVE_HOME%\samples\wsm-addressbook-enhanced\WEB-INF\build-client.xml</source>
<!-- <p>and</p>
<source>ant -f
C:/beehive_projects/EmployeeWS/WEB-INF/build-client-dist.xml</source>-->
- <p>Note that you do not need to run a
particular target within
+ <p>Note that you do not need to run a
particular target within the build files
<code>client-build.xml</code>. Simply
run the Ant command
- shown above and the client will be
generated in
+ shown above and the clients will be
generated in
<code>WEB-INF/build/generated</code>.</p>
- <p>The client consist of JUnit test cases that
exercise the
+ <p>The clients consist of JUnit test cases that
exercise the
contract published in the WSDL. The
final result shows the
number of successfully passed JUnit
tests.</p>
<p>The code generated in
<code>/WEB-INF/build/generated/</code>
can be used as a template to write your
own client side
applications.</p>
<p>Note that the client-build.xml script makes
certain
- assumptions about the Tomcat deployment
context path, namely, that the app is
- deployed
- on the context path
<code>AddressBookWS</code> <!--and <code>EmployeeWS</code>-->.
- If the context path differs from these
values, the URL in
- the build-client.xml file must be
adjusted accordingly. </p>
+ assumptions about the Tomcat deployment
context path, namely,
+ that the apps are deployed
+ on the context paths
+ <code>AddressBookWS</code> and
<code>EnhancedAddressBookWS</code> <!--and <code>EmployeeWS</code>-->.
+ If the context paths differ from these
values, the URL in
+ the build-client.xml files must be
adjusted accordingly. </p>
</section>
</section>
</body>
Modified:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml?view=diff&r1=158532&r2=158533
==============================================================================
---
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml
(original)
+++
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml
Mon Mar 21 19:57:34 2005
@@ -31,37 +31,41 @@
the renamed <code>wsm-blank</code> is
<strong><code><Project-Folder></code></strong>. </p>
</section>
- <section id="copy_runtime">
- <title>Copy the Runtime JARs into the Template
Folder</title>
- <p>Copy the runtime JARs to the project's
WEB-INF/lib
- directory.</p>
- <p>The following Ant command will copy the
necessary runtime JARs to
-
<code><Project-Folder>/WEB-INF/lib</code>.</p>
-<source>ant -f
- %BEEHIVE_HOME%\ant\webappRuntimeCore.xml
- -Dwebapp.dir=<strong><Path-to-Project-Folder></strong>
- deploy.wsm.webapp.runtime
+ <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 your web application.</p>
+ <p>Open the file
<code>C:/beehive_projects/petstoreWeb/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. For example, if you beehive installation
+ resides at
<code>C:/apache/apache-beehive-1.0</code>, then your
<code>build.properties</code> file
+ would appear as follows.</p>
+
<source>beehive.home=<strong>C:/apache/apache-beehive-1.0</strong>
-<strong>Copy and paste version:</strong>
+servlet-api.jar=${os.CATALINA_HOME}/common/lib/servlet-api.jar
+jsp-api.jar=${os.CATALINA_HOME}/common/lib/jsp-api.jar
-ant -f %BEEHIVE_HOME%\ant\webappRuntimeCore.xml
-Dwebapp.dir=<strong><Path-to-Project-Folder></strong>
deploy.wsm.webapp.runtime</source>
- </section>
+contextPath=<strong>myWebService</strong></source>
+ </section>
<section><title>Build the Template Web App</title>
<p>To build the template web service, run the
following Ant command.</p>
<source>ant
- -f %BEEHIVE_HOME%\ant\buildWebapp.xml
+ -f C:\beehive_projects\petstoreWeb\WEB-INF\src\build.xml
-Dwebapp.dir=<strong><Path-to-Project-Folder></strong>
+ clean
build
+ war
<strong>Copy and paste version:</strong>
-ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=<strong><Path-to-Project-Folder></strong> build</source>
+ant -f C:\beehive_projects\petstoreWeb\WEB-INF\src\build.xml
-Dwebapp.dir=<strong><Path-to-Project-Folder></strong> clean build war
+</source>
</section>
<section>
<title>To Deploy and Run the Template Web
Service</title>
<p>Before deploying the web service, ensure
that Tomcat is turned on.</p>
<source>%CATALINA_HOME%\bin\startup.bat</source>
- <p>To deploy the web service, visit the following URL in a web browser.
(We recommend that you open the
+<!-- <p>To deploy the web service, visit the following URL in a web browser.
(We recommend that you open the
link in a new browser window. Each time you want to redeploy
the application,
simply refresh the browser.)</p>
<p>In the URL below, replace <strong><SomeContext></strong> with
some string that is appropriate for
@@ -73,7 +77,9 @@
<p>This method of application deployment assumes that you have added
the <code>manager</code>
role to your Tomcat installation. For instructions on adding
the <code>manager</code> role,
see <a class="fork" href="../setup.html#optional">Beehive
Installation and Setup</a>.</p>
- <p>If you are prompted for a username/password, enter:
<code>manager/manager</code></p>
+ <p>If you are prompted for a username/password, enter:
<code>manager/manager</code></p>-->
+<p>To deploy the web service to Tomcat, copy the WAR file to Tomcat's
<code>webapps</code> directory.</p>
+<source>copy C:\beehive_projects\netui-blank.war
%CATALINA_HOME%\webapps</source>
<p>You can now try out the web service by
pointing your browser at
the following link.</p>
<ul>
Added:
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsmAnnoSamples.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsmAnnoSamples.xml?view=auto&rev=158533
==============================================================================
---
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsmAnnoSamples.xml
(added)
+++
incubator/beehive/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsmAnnoSamples.xml
Mon Mar 21 19:57:34 2005
@@ -0,0 +1,113 @@
+<?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>WSM Annotation Samples</title>
+ </header>
+ <body>
+ <section id="intro">
+ <title>Introduction</title>
+ <p>This sample demonstrates the different
+ metadata annotations available to a Beehive web
service.
+ The sample takes the form of a web site (with
web service backends)
+ with links to SOAP resonses for different
requests of the web services.
+ </p>
+ </section>
+ <section id="running">
+ <title>Running the Sample</title>
+ <section id="reqs">
+ <title>Requirements for Running the
Samples</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>BEEHIVE_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="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> Files</title>
+ <p>In this section you will edit the
<code>build.properties</code> files--the files
+ that set the build-related properties
for the web services.</p>
+ <p>Open the file
+
<code>BEEHIVE_HOME/samples/wsm-sample/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. For example, if you beehive installation
+ resides at
<code>C:/apache/apache-beehive-1.0</code>,
+ then your <code>build.properties</code>
file
+ would appear as follows.</p>
+
<source>beehive.home=<strong>C:/apache/apache-beehive-1.0</strong></source>
+ </section>
+ <section id="compile">
+ <title>To Compile the App</title>
+ <p>To compile the app, enter the following Ant command.</p>
+<source>ant
+ -f %BEEHIVE_HOME%\samples\wsm-sample\WEB-INF\build.xml
+ -Dto.dir=%CATALINA_HOME%\webapps
+ clean
+ build
+ deploy
+
+<strong>Copy and paste version:</strong>
+
+ant -f %BEEHIVE_HOME%\samples\wsm-samples\WEB-INF\build.xml
-Dto.dir=%CATALINA_HOME%\webapps clean build deploy</source>
+
+ </section>
+ <section id="test_the_app"><title>To Test the Samples</title>
+ <p>Verify that the web services is running by
pointing your
+ browser to:</p>
+ <p>
+ <a class="fork"
href="http://localhost:8080/wsm-samplesWS/";>
+
http://localhost:8080/wsm-samplesWS/</a>
+ </p>
+ <p>Follow the links for demonstrations of
different metadata annotations.</p>
+ </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/branches/v1/beta/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsmAnnoSamples.xml
------------------------------------------------------------------------------
svn:eol-style = native
