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 [1/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/
Author: ekoneil
Date: Mon Aug 22 13:40:15 2005
New Revision: 239246
URL: http://svn.apache.org/viewcvs?rev=239246&view=rev
Log:
You guessed it -- more doc work.
- fixup the controls and JPF tutorial instructions for how to get the project setup
- code reformatting in the controls and JPF tutorials (not quite done with this yet)
- fix the terms Jms, Jdbc, Ejb in the system-controls tutorials
- set svn:eol-style on the system-controls sub-directory
- remove the system-controls/webservices/webservicesControlTutorial.xml file which is empty
BB: self
DRT: build.release pass
Removed:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservicesControlTutorial.xml
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/setup.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejb-annotations.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbControlTutorial.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbDoc.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbc-annotations.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlDevGuide.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlTutorial.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jms-annotations.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsControlTutorial.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsDoc.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservices-annotations.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/webservices/webservicesDoc.xml (contents, props changed)
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/tutorial/setup.xml
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml Mon Aug 22 13:40:15 2005
@@ -9,114 +9,112 @@
<title>Introduction</title>
<section>
<title>Tutorial Goals</title>
- <p>In this tutorial, you will learn:</p>
+ <p>The Controls tutorial is provided as a way to become familiar with the concepts of Controls in Beehive. The tutorial
+ walks through creating, building, and deploying a sample project that uses a Control from a Page Flow. Note, Page Flows
+ aren't required to use Controls; they just provide a convenient way to demonstrate running a Control. In this tutorial,
+ you will learn:</p>
<ul>
- <li>what Beehive Controls are for and what they do.</li>
- <li>how to create a Beehive Control interface and implementation.</li>
- <li>how to compile a Beehive Control.</li>
- <li>how to use a Beehive Control as a component in a larger application.</li>
- <li>how to use metadata annotations in Beehive Controls.</li>
- <li>how to create custom metadata annotations.</li>
+ <li>What Beehive Controls are for and what they do.</li>
+ <li>How to create a Beehive Control interface and implementation.</li>
+ <li>How to compile a Beehive Control.</li>
+ <li>How to use a Beehive Control as a component in a larger application.</li>
+ <li>How to use metadata annotations in Beehive Controls.</li>
+ <li>How to create custom metadata annotations.</li>
</ul>
</section>
</section>
- <section id="step1">
- <title>Step 1: Begin the Control Tutorial</title>
- <section id="setup">
- <title>To Set up the Development Environment</title>
- <p>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>After completing the instructions, leave the command shell
- open to use throughout this tutorial.</p>
- <p>Before proceding, confirm that you have the following
- variables set in your shell:</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="make_test_enviro">
- <title>To Create a Development and Test Application</title>
- <p>In this step you create a web application that serves as the
- development and testing ground
- for your control. To test the control, you will
- invoke the control methods from the web application.</p>
- <p>Copy the folder <code><BeehiveRoot>/samples/netui-blank</code> into
- <code>C:/beehive_projects</code>.</p>
- <note><BeehiveRoot> refers to the top-level directory of your Beehive installation.
- A typical value for <BeehiveRoot> is <code>C:/apache/apache-beehive-1.0</code>. </note>
- <p>Rename the folder
- <code>C:/beehive_projects/</code><strong><code>netui-blank</code></strong> to the name
- <code>C:/beehive_projects/</code><strong><code>control_tutorial</code></strong></p>
- <p>Before proceeding, confirm that the following directory structure exists:</p>
- <source>C:
- beehive_projects
- control_tutorial
- resources
- WEB-INF
- Controller.java
- index.jsp</source>
+ <section id="step1">
+ <title>Step 1: Begin the Control Tutorial</title>
+ <section id="setup">
+ <title>To Set up the Development Environment</title>
+ <p>Complete all of the necessary and optional steps in the following topic: <a class="fork" href="site:setup">Beehive Installation and Setup</a></p>
</section>
- <section><title>Edit the <code>build.properties</code> File</title>
- <p>Next you will edit the <code>build.properties</code> file--the file
- that sets the build-related properties for your test environment.</p>
- <p>Open the file <code>C:/beehive_projects/control_tutorial/WEB-INF/src/build.properties</code>
- in a text editor.</p>
- <p>Edit the <code>beehive.home</code> property so it points to the
- top-level folder of your beehive installation.</p>
- <p>Edit the <code>context.path</code> property so it has the value
- <strong><code>control_tutorial</code></strong> (as shown below).</p>
- <p>For example, if your 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>
-
+ <section id="make_project">
+ <title>Create a Web Project</title>
+ <p>
+ In order to follow the steps in this tutorial, it's necessary to create a Beehive-enabled web application. This web application is derived from Beehive's
+ <a href="site:netui-blank">netui-blank</a> NetUI web project which contains a skeleton Ant build file and an example Page Flow Controller. To create the
+ tutorial's project, we'll copy and then rename the <a href="site:netui-blank">netui-blank</a> project using these steps:
+ </p>
+ <ol>
+ <li>On your C: drive, create a directory named <code>beehive_projects</code>.</li>
+ <li>Copy the folder <code><BeehiveRoot>/samples/netui-blank</code> into
+ <code>C:/beehive_projects</code>. (<code><BeehiveRoot</code> is the top level folder of your
+ Beehive distribution. A typical value might be <code>C:/apache/apache-beehive-1.0</code>.)</li>
+ <li>Rename the folder <code>C:\beehive_projects\</code><strong><code>netui-blank</code></strong> to <code>C:\beehive_projects\</code><strong><code>control_tutorial</code></strong></li>
+ <li>Before proceeding, confirm that the following directory structure exists:</li>
+ </ol>
+ <source>
+c:\
+ beehive_projects\
+ control_tutorial\
+ Controller.java
+ index.jsp
+ resources\
+ WEB-INF\
+ </source>
+<p>
+Note, this directory structure is just an example; you are free to put the <code>pageflow_tutorial</code> directory anywhere on disk. Just be sure to adjust
+the rest of the directory names in the tutorial below.
+</p>
+ </section>
+ <section id="configure_properties">
+ <title>Configure Build Properties</title>
+ <p>
+ The <code>WEB-INF/src/build.properties</code> file contains several project-related properties that must be set in order to build the web application. Specifically, the
+ paths to your Beehive distribution and to the JSP / Servlet API JARs for your application container must be set. The following steps will set these properties
+ for the <code>pageflow_tutorial</code> webapp.
+ </p>
+ <ol>
+ <li>Open the file <code>C:/beehive_projects/pageflow_tutorial/WEB-INF/src/build.properties</code> in a text editor.</li>
+ <li>Edit the <code>beehive.home</code> property so it points to the top-level folder of your Beehive distribution.</li>
+ <li>Edit the <code>context.path</code> so it has the value <code>pageflow_tutorial</code>.</li>
+ </ol>
+ <note>The <code>context.path</code> property determines both (1) the name of the application WAR file and (2) the application URL.
+ <br/><br/>
+ If <code>context.path=myWebApp</code>, then the following WAR file will be produced:
+ <br/><br/>
+ <strong><code>myWebApp</code></strong><code>.war</code>
+ <br/><br/>
+ and the following URL will invoke the web application:
+ <br/><br/>
+ <code>http://someserver/</code><strong><code>myWebApp</code></strong>
+ </note>
+ <p>For example, if your Beehive distribution is located in <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>
servlet-api.jar=${os.CATALINA_HOME}/common/lib/servlet-api.jar
jsp-api.jar=${os.CATALINA_HOME}/common/lib/jsp-api.jar
-<strong>context.path=control_tutorial</strong>
+context.path=<strong>control_tutorial</strong></source>
+<note>Properties files should use the '/' character to separate drive, directory, and file names.</note>
+<p>
+If you are using an application container other than Tomcat, be sure to set the <code>servlet-api.jar</code> and <code>jsp-api.jar</code> properties
+to reference the JAR your server provides which contains the JSP and Servlet API classes.
+</p>
+ </section>
+ <section id="add_control_files">
+ <title>Add Sample Control Interface and Implementation Source Files</title>
+<p>This tutorial uses a sample Hello World control that is contained in <strong><code><BeehiveRoot>/samples/controls-blank/src/pkg</code></strong>. Copy the <code>pkg</code>
+sub-directory from this path into the directory <strong><code>C:/beehive_projects/control_tutorial/WEB-INF/src</code></strong>.</p>
+<p>Now, confirm that the following directory structure exists:</p>
+<source>C:\
+ beehive_projects\
+ control_tutorial\
+ WEB-INF\
+ src\
+ pkg\
+ Hello.java
+ HelloImpl.java
</source>
-<note>Windows users must use forwardslashes (/) not backslashes (\) in the
- <code>build.properties</code> file.</note>
- </section>
- <section id="add_control_files">
- <title>Add the Control Interface and Implementation Files</title>
- <p>Copy the folder <strong><code><BeehiveRoot>/samples/controls-blank/src/pkg</code></strong>
- into the folder <strong><code>C:/beehive_projects/control_tutorial/WEB-INF/src</code></strong>.</p>
- <p>Before proceeding, confirm that the following directory structure exists:</p>
- <source>C:
- beehive_projects
- control_tutorial
- WEB-INF
- src
- pkg
- Hello.java
- HelloImpl.java</source>
- </section>
- <section id="start_tomcat">
- <title>To Start the Tomcat Server</title>
- <p>At the command prompt, enter:</p>
- <source>%CATALINA_HOME%\bin\startup.bat</source>
- </section>
- </section>
+</section>
+ <section id="start_server">
+ <title>Start the Server</title>
+ <p>If you are using Tomcat, enter the following at the command prompt:</p>
+ <source>%CATALINA_HOME%\bin\startup.bat</source>
+ <p>If you aren't using Tomcat, start your application container as per its directions.</p>
+ </section>
+ </section>
<section id="step_2">
<title>Step 2: Compile the Control Implementation and Interface Files</title>
<section id="intro_2">
@@ -130,28 +128,29 @@
<p>Open the file <code>C:/beehive_projects/control_tutorial/WEB-INF/src/pkg/HelloImpl.java</code>.</p>
<p>The implementation file appears as follows. (There is no need to edit the file at
this point in the tutorial.)</p>
-<source>package pkg;
+<source>
+package pkg;
-import org.apache.beehive.controls.api.bean.*;
+import org.apache.beehive.controls.api.bean.ControlImplementation;
@ControlImplementation(isTransient=true)
-public class HelloImpl implements Hello
-{
- public String hello()
- {
+public class HelloImpl
+ implements Hello {
+
+ public String hello() {
return "hello!";
}
}</source>
<p>Open the file <code>C:/beehive_projects/control_tutorial/WEB-INF/src/pkg/Hello.java</code>.</p>
<p>The interface file appears as follows. (There is no need to edit the file at
this point in the tutorial.)</p>
-<source>package pkg;
+<source>
+package pkg;
import org.apache.beehive.controls.api.bean.*;
@ControlInterface
-public interface Hello
-{
+public interface Hello {
String hello();
}</source>
</section>
@@ -165,7 +164,8 @@
</p>
<p>Open the file <code>C:/beehive_projects/control_tutorial/Controller.java</code> in a text editor.</p>
<p>Edit <code>Controller.java</code> so it appears as follows:</p>
- <source>import javax.servlet.http.HttpSession;
+ <source>
+import javax.servlet.http.HttpSession;
import org.apache.beehive.netui.pageflow.Forward;
import org.apache.beehive.netui.pageflow.PageFlowController;
@@ -183,8 +183,8 @@
}
)
public class Controller
- extends PageFlowController
-{
+ extends PageFlowController {
+
@Jpf.SharedFlowField(name="shared")
private shared.SharedFlow sharedFlow;
@@ -203,20 +203,8 @@
return f;
}</strong>
- /**
- * Callback that is invoked when this controller instance is created.
- */
- protected void onCreate()
- {
- }
-
- /**
- * Callback that is invoked when this controller instance is destroyed.
- */
- protected void onDestroy(HttpSession session)
- {
- }
-}</source>
+}
+</source>
<p>The two import statements import the @Control annotation and the Hello
control, respectively.</p>
<p>The <code>@Jpf.SimpleAction</code> named "<code>begin</code>" is
@@ -253,21 +241,21 @@
</source>
</section>
<section id="compile_2">
- <title>To Compile and Deploy the Control</title>
- <p>You are now ready to compile the test web application and the embedded the control.</p>
- <p>To build the web application, enter:</p>
-<source>ant
- -f C:\beehive_projects\control_tutorial\WEB-INF\src\build.xml
- clean
- build
- war
-
-<strong>Copy and Paste version:</strong>
-ant -f C:\beehive_projects\control_tutorial\WEB-INF\src\build.xml clean build war
+ <title>To Compile and Deploy the Page Flow</title>
+ <p>You are now ready to compile the Page Flow and deploy it to Tomcat.</p>
+ <p>The following Ant command assumes that you are in the <code>c:/beehive_projects/control_tutorial/WEB-INF/src</code> directory. At the command prompt, enter:</p>
+<source>
+ ant clean build war
</source>
-<p>To deploy the web application to Tomcat, copy the WAR file into Tomcat's <code>webapps/</code> directory.</p>
-<source>copy C:\beehive_projects\control_tutorial.war %CATALINA_HOME%\webapps /Y</source>
- </section>
+<p>
+This will build the webapp by running the Beehive annotation processors and will produce class files in <code>WEB-INF/classes</code>.
+</p>
+<p>Now, the application is ready to deploy to your server. On Tomcat, copy the WAR file into Tomcat's <code>$CATALINA_HOME/webapps</code> directory.</p>
+<source>
+ copy C:\beehive_projects\control_tutorial.war %CATALINA_HOME%\webapps /Y
+</source>
+<p>If you are not using Tomcat, follow your server's web application deployment instructions to deploy the webapp.</p>
+</section>
<section id="test_2">
<title>To Test the Control</title>
<p>Open a web browser and enter the following in the address bar:</p>
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml Mon Aug 22 13:40:15 2005
@@ -9,92 +9,96 @@
<title>Introduction</title>
<section id="goals">
<title>Tutorial Goals</title>
- <p>In this tutorial, you will learn:</p>
+ <p>The Page Flow tutorial is provided as a way to become familiar with NetUI's Page Flow Controllers and JSP tags. The tutorial
+ walks through creating, building, and deploying a sample project Page Flow that uses JavaBeans to submit data from a browser
+ to the server. In this tutorial, you will learn:</p>
<ul>
- <li>how to create a basic Page Flow web application.</li>
- <li>how to coordinate user navigation with Forward methods.</li>
- <li>how to handle data submission and processing with data binding and Form Beans.</li>
- <li>how to create a user interface with the <netui> JSP tag library.</li>
- <li>how Page Flows help to separate data processing and data presentation.</li>
- <li>how to use declarative validation with data submission.</li>
- <li>how to collect data from a nested Page Flow and 'return' it to the nesting Page Flow.</li>
- <li>how to make an action available to multiple Page Flows.</li>
+ <li>How to create a basic Page Flow web application.</li>
+ <li>How to coordinate user navigation with Forward methods.</li>
+ <li>How to handle data submission and processing with data binding and Form Beans.</li>
+ <li>How to create a user interface with the <netui> JSP tag library.</li>
+ <li>How Page Flows help to separate data processing and data presentation.</li>
+ <li>How to use declarative validation with data submission.</li>
+ <li>How to collect data from a nested Page Flow and 'return' it to the nesting Page Flow.</li>
+ <li>How to make an action available to multiple Page Flows.</li>
</ul>
</section>
</section>
<section id="step1_begin">
<title>Step 1: Begin the Page Flow Tutorial</title>
<section id="setup">
- <title>To Set up the Development Environment</title>
- <p>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 you have set the 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="make_proj">
- <title>Make a Project Folder</title>
- <p>On your C: drive, create a directory named <code>beehive_projects</code>.</p>
- <p>Copy the folder <code><BeehiveRoot>/samples/netui-blank</code> into
- <code>C:/beehive_projects</code>. (<code><BeehiveRoot</code> is the top level
- folder of your Beehive installation; a typical value might be
- <code>C:/apache/apache-beehive-1.0</code>.)</p>
- <p>Rename the folder
- <code>C:/beehive_projects/</code><strong><code>netui-blank</code></strong> to the name
- <code>C:/beehive_projects/</code><strong><code>pageflow_tutorial</code></strong></p>
- <p>Before proceeding, confirm that the following directory structure exists:</p>
- <source>C:
- beehive_projects
- pageflow_tutorial
- resources
- WEB-INF
- Controller.java
- index.jsp</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 your web application.</p>
- <p>Open the file <code>C:/beehive_projects/pageflow_tutorial/WEB-INF/src/build.properties</code>
- in a text editor.</p>
- <p>Edit the <code>beehive.home</code> property so it points to the
- top-level folder of your beehive installation.</p>
- <p>Edit the <code>context.path</code> so it has the value <code>pageflow_tutorial</code>.</p>
- <note>The <code>context.path</code> property determines both (1) the name of the application
- WAR file and (2) the application URL.
- <br/><br/>
- If <code>context.path=myWebApp</code>, then the following WAR file will be produced:
- <br/><br/>
- <strong><code>myWebApp</code></strong><code>.war</code>
- <br/><br/>
- and the following URL will invoke the web application:
- <br/><br/>
- <code>http://someserver/</code><strong><code>myWebApp</code></strong>
- </note>
- <p>For example, if your 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>
-
+ <title>Setup a Development Environment</title>
+ <p>Complete all of the necessary and optional steps in the following topic: <a class="fork" href="site:setup">Beehive Installation and Setup</a></p>
+ </section>
+ <section id="make_project">
+ <title>Create a Web Project</title>
+ <p>
+ In order to follow the steps in this tutorial, it's necessary to create a Beehive-enabled web application. This web application is derived from Beehive's
+ <a href="site:netui-blank">netui-blank</a> NetUI web project which contains a skeleton Ant build file and an example Page Flow Controller. To create the
+ tutorial's project, we'll copy and then rename the <a href="site:netui-blank">netui-blank</a> project using these steps:
+ </p>
+ <ol>
+ <li>On your C: drive, create a directory named <code>beehive_projects</code>.</li>
+ <li>Copy the folder <code><BeehiveRoot>/samples/netui-blank</code> into
+ <code>C:/beehive_projects</code>. (<code><BeehiveRoot</code> is the top level folder of your
+ Beehive distribution. A typical value might be <code>C:/apache/apache-beehive-1.0</code>.)</li>
+ <li>Rename the folder <code>C:\beehive_projects\</code><strong><code>netui-blank</code></strong> to <code>C:\beehive_projects\</code><strong><code>pageflow_tutorial</code></strong></li>
+ <li>Before proceeding, confirm that the following directory structure exists:</li>
+ </ol>
+ <source>
+c:\
+ beehive_projects\
+ pageflow_tutorial\
+ Controller.java
+ index.jsp
+ resources\
+ WEB-INF\
+ </source>
+<p>
+Note, this directory structure is just an example; you are free to put the <code>pageflow_tutorial</code> directory anywhere on disk. Just be sure to adjust
+the rest of the directory names in the tutorial below.
+</p>
+ </section>
+ <section id="configure_properties">
+ <title>Configure Build Properties</title>
+ <p>
+ The <code>WEB-INF/src/build.properties</code> file contains several project-related properties that must be set in order to build the web application. Specifically, the
+ paths to your Beehive distribution and to the JSP / Servlet API JARs for your application container must be set. The following steps will set these properties
+ for the <code>pageflow_tutorial</code> webapp.
+ </p>
+ <ol>
+ <li>Open the file <code>C:/beehive_projects/pageflow_tutorial/WEB-INF/src/build.properties</code> in a text editor.</li>
+ <li>Edit the <code>beehive.home</code> property so it points to the top-level folder of your Beehive distribution.</li>
+ <li>Edit the <code>context.path</code> so it has the value <code>pageflow_tutorial</code>.</li>
+ </ol>
+ <note>The <code>context.path</code> property determines both (1) the name of the application WAR file and (2) the application URL.
+ <br/><br/>
+ If <code>context.path=myWebApp</code>, then the following WAR file will be produced:
+ <br/><br/>
+ <strong><code>myWebApp</code></strong><code>.war</code>
+ <br/><br/>
+ and the following URL will invoke the web application:
+ <br/><br/>
+ <code>http://someserver/</code><strong><code>myWebApp</code></strong>
+ </note>
+ <p>For example, if your Beehive distribution is located in <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>
servlet-api.jar=${os.CATALINA_HOME}/common/lib/servlet-api.jar
jsp-api.jar=${os.CATALINA_HOME}/common/lib/jsp-api.jar
context.path=<strong>pageflow_tutorial</strong></source>
-<note>Windows users must use forwardslashes (/) not backslashes (\) in the
- <code>build.properties</code> file.</note>
- </section>
- <section id="start_tomcat">
- <title>To Start the Tomcat Server</title>
- <p>At the command prompt, enter:</p>
+<note>Properties files should use the '/' character to separate drive, directory, and file names.</note>
+<p>
+If you are using an application container other than Tomcat, be sure to set the <code>servlet-api.jar</code> and <code>jsp-api.jar</code> properties
+to reference the JAR your server provides which contains the JSP and Servlet API classes.
+</p>
+ </section>
+ <section id="start_server">
+ <title>Start the Server</title>
+ <p>If you are using Tomcat, enter the following at the command prompt:</p>
<source>%CATALINA_HOME%\bin\startup.bat</source>
+ <p>If you aren't using Tomcat, start your application container as per its directions.</p>
</section>
</section>
<section id="step_2_create">
@@ -150,13 +154,13 @@
</p>
<source>@Jpf.SimpleAction(name="begin", path="index.jsp")</source>
<p>The begin action <em>could</em> have been expressed using method syntax: </p>
- <source>@Jpf.Action(
+ <source>
+@Jpf.Action(
forwards = {
@Jpf.Forward(name="success", path="index.jsp")
}
)
-public Forward begin()
-{
+public Forward begin() {
return new Forward("success");
}</source>
<p>We have used the Simple Action syntax for the sake of syntactical simplicity.
@@ -188,19 +192,6 @@
@Jpf.SharedFlowField(name="shared")
private shared.SharedFlow sharedFlow;
- /**
- * Callback that is invoked when this controller instance is created.
- */
- protected void onCreate()
- {
- }
-
- /**
- * Callback that is invoked when this controller instance is destroyed.
- */
- protected void onDestroy(HttpSession session)
- {
- }
}</source>
<p>Open the file <code>C:/beehive_projects/pageflow_tutorial/index.jsp</code>.
</p>
@@ -227,19 +218,19 @@
<section id="compile_2">
<title>To Compile and Deploy the Page Flow</title>
<p>You are now ready to compile the Page Flow and deploy it to Tomcat.</p>
- <p>At the command prompt, enter:</p>
-<source>ant
- -f C:\beehive_projects\pageflow_tutorial\WEB-INF\src\build.xml
- clean
- build
- war
-
-<strong>Copy and Paste version:</strong>
-ant -f C:\beehive_projects\pageflow_tutorial\WEB-INF\src\build.xml clean build war
+ <p>The following Ant command assumes that you are in the <code>c:/beehive_projects/pageflow_tutorial/WEB-INF/src</code> directory. At the command prompt, enter:</p>
+<source>
+ ant clean build war
</source>
-<p>To deploy the application to Tomcat, copy the WAR file into Tomcat's <code>webapps</code> directory.</p>
-<source>copy C:\beehive_projects\pageflow_tutorial.war %CATALINA_HOME%\webapps /Y</source>
- </section>
+<p>
+This will build the webapp by running the Beehive annotation processors and will produce class files in <code>WEB-INF/classes</code>.
+</p>
+<p>Now, the application is ready to deploy to your server. On Tomcat, copy the WAR file into Tomcat's <code>$CATALINA_HOME/webapps</code> directory.</p>
+<source>
+ copy C:\beehive_projects\pageflow_tutorial.war %CATALINA_HOME%\webapps /Y
+</source>
+<p>If you are not using Tomcat, follow your server's web application deployment instructions to deploy the webapp.</p>
+</section>
<section id="test_2">
<title>To Test the Page Flow Web Application</title>
<p>Visit the following address:</p>
@@ -303,7 +294,8 @@
<p>Edit <code>Controller.java</code> so it appears as follows. Don't forget
the comma after the first <code>Jpf.SimpleAction(...)</code> element!</p>
<p><strong><code>Controller.java</code></strong></p>
- <source>import javax.servlet.http.HttpSession;
+ <source>
+import javax.servlet.http.HttpSession;
...
@@ -321,8 +313,7 @@
}
)
public class Controller
- extends PageFlowController
-{
+ extends PageFlowController {
...
}</source>
<p>Save <code>Controller.java</code>.</p>
@@ -384,30 +375,28 @@
<p>Edit <code>C:/beehive_projects/pageflow_tutorial/WEB-INF/src/forms/ProfileForm.java</code> so it appears as follows.</p>
<p><strong><code>ProfileForm.java</code></strong></p>
- <source>package forms;
+ <source>
+package forms;
+
+public class ProfileForm
+ implements java.io.Serializable {
-public class ProfileForm implements java.io.Serializable
-{
private int age;
private String name;
- public void setName(String name)
- {
+ public void setName(String name) {
this.name = name;
}
- public String getName()
- {
+ public String getName() {
return this.name;
}
- public void setAge(int age)
- {
+ public void setAge(int age) {
this.age = age;
}
- public int getAge()
- {
+ public int getAge() {
return this.age;
}
}</source>
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/setup.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/setup.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/setup.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/setup.xml Mon Aug 22 13:40:15 2005
@@ -29,11 +29,11 @@
ANT_HOME = C:\apache\apache-ant-1.6.2
JAVA_HOME = C:\jdk1.5.0
</source>
- <p>(3) Ensure that <code>JAVA_HOME/bin</code> and <code>ANT_HOME/bin</code> are on your <code>PATH</code>.</p>
+ <p>(3) Ensure that <code>$JAVA_HOME/bin</code> and <code>$ANT_HOME/bin</code> are on your <code>$PATH</code>.</p>
</section>
<section>
<title>What Now?</title>
- <p>You are now ready to begin developing Beehive applications! Follow the tutorial and samples links <a href="index.html">here</a> to get started.</p>
+ <p>You are now ready to begin developing Beehive applications! Follow the tutorial and samples links <a href="index.html">here</a> to get started.</p>
</section>
<section>
<title>Troubleshooting</title>
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml Mon Aug 22 13:40:15 2005
@@ -10,7 +10,6 @@
<control label="EJB Control" href="system-controls/ejb/ejbControlTutorial.html"/>
<control label="JDBC Control" href="system-controls/jdbc/jdbcControlTutorial.html"/>
<control label="JMS Control" href="system-controls/jms/jmsControlTutorial.html"/>
- <control label="Web Service Control" href="system-controls/webservices/webservicesControlTutorial.html"/>
</tutorial_system-controls>
</tutorials>
<pageflow label="Page Flows">
@@ -118,5 +117,6 @@
<jsr181 href="http://jcp.org/en/jsr/detail?id=181"/>
<java5download href="http://java.sun.com/j2se/1.5.0/download.jsp"/>
<ant16download href="http://ant.apache.org/bindownload.cgi"/>
+ <tomcatdownload href="http://jakarta.apache.org/site/binindex.cgi#tomcat"/>
</external-refs>
</site>
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejb-annotations.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejb-annotations.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejb-annotations.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejb-annotations.xml Mon Aug 22 13:40:15 2005
@@ -1,19 +1,19 @@
-<?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>Ejb Control Annotations</title>
- </header>
- <body>
- <section>
- <title>Ejb Control Annotations</title>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/ejb/EJBControl.EJBHome.html">@EJBControl.EJBHome</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/ejb/EJBControl.JNDIContextEnv/EJBControl.JNDIContextEnv.html">@EJBControl.JNDIContextEnv</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>Ejb Control Annotations</title>
+ </header>
+ <body>
+ <section>
+ <title>Ejb Control Annotations</title>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/ejb/EJBControl.EJBHome.html">@EJBControl.EJBHome</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/ejb/EJBControl.JNDIContextEnv/EJBControl.JNDIContextEnv.html">@EJBControl.JNDIContextEnv</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/ejb/ejb-annotations.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbControlTutorial.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbControlTutorial.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbControlTutorial.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbControlTutorial.xml Mon Aug 22 13:40:15 2005
@@ -1,73 +1,73 @@
-<?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>EJB Control Tutorial</title>
- </header>
- <body>
- <section>
- <title>Tutorial Overview</title>
-
- <p>The EJB Control is an extensible control, and you do not use it directly. To create an EJB control
- for an EJB, you would create a control extending the EJB Control. An extended EJB control can
- only represent one EJB, so you must create one for each EJB.
- </p>
- </section>
- <section>
- <title>Extending the EJB control</title>
-
- <ol>
- <li>Create a Java interface extending the appropriate EJB Control interface. If the EJB is a
- session bean, you must extend org.apache.beehive.controls.system.ejb.SessionEJBControl, or if it is an
- entity bean, extend org.apache.beehive.controls.system.ejb.EntityEJBControl.</li>
-
- <li>Annotate the Java interface with @ControlExtension
- (org.apache.beehive.controls.api.bean.ControlExtension), so the Control Annotation
- Processor will know that the Java interface is a control extension.</li>
-
- <li>Have the Java interface also extend the EJB's home and business interfaces. The
- business interface may either by the EJB's local interface or the remote interface.</li>
-
- <li>Specifiy how the EJB control should lookup the EJB. To lookup the EJB by its JNDI name,
- set the EJB control's @EJBHome.jndiName annotation to the EJB's JNDI name. To lookup
- the EJB using an EJB link, set the EJB control's @EJBHome.ejbLink annotation to the name
- of the EJB link. (see Annotation).</li>
-
- <li>If the EJB control uses JNDI to look up an EJB, you may optionally specify the JNDI context
- environment properties using the @JNDIContextEnv annotation (see Annotation).</li>
- </ol>
- </section>
- <section>
- <title>EJB Control Extension Example</title>
-
- <source>
-package org.apache.beehive.controls.system.ejb.sample.control;
-
-import org.apache.beehive.controls.api.bean.ControlExtension;
-import org.apache.beehive.controls.system.ejb.SessionEJBControl;
-import org.apache.beehive.controls.system.ejb.EJBControl.EJBHome;
-import org.apache.beehive.controls.system.ejb.EJBControl.JNDIContextEnv;
-import org.apache.beehive.controls.system.ejb.sample.bean.HelloHome;
-import org.apache.beehive.controls.system.ejb.sample.bean.HelloRemote;
-
-@ControlExtension
-@EJBHome(
- jndiName="org.apache.beehive.controls.system.ejb.sample.HelloHome")
-@JNDIContextEnv(
- contextFactory="weblogic.jndi.WLInitialContextFactory",
- providerURL="t3://localhost:7001",
- principal="weblogic",
- credentials="weblogic")
-public interface HelloEJBControl
- extends SessionEJBControl, HelloHome, HelloRemote
-{
-}
- </source>
-
-
- <p>This code is part of the EJB Control samples that is available in the samples directory of
- the Beehive source tree.</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>EJB Control Tutorial</title>
+ </header>
+ <body>
+ <section>
+ <title>Overview</title>
+
+ <p>The EJB Control is an extensible control, and you do not use it directly. To create an EJB control
+ for an EJB, you would create a control extending the EJB Control. An extended EJB control can
+ only represent one EJB, so you must create one for each EJB.
+ </p>
+ </section>
+ <section>
+ <title>Extending the EJB control</title>
+
+ <ol>
+ <li>Create a Java interface extending the appropriate EJB Control interface. If the EJB is a
+ session bean, you must extend org.apache.beehive.controls.system.ejb.SessionEJBControl, or if it is an
+ entity bean, extend org.apache.beehive.controls.system.ejb.EntityEJBControl.</li>
+
+ <li>Annotate the Java interface with @ControlExtension
+ (org.apache.beehive.controls.api.bean.ControlExtension), so the Control Annotation
+ Processor will know that the Java interface is a control extension.</li>
+
+ <li>Have the Java interface also extend the EJB's home and business interfaces. The
+ business interface may either by the EJB's local interface or the remote interface.</li>
+
+ <li>Specifiy how the EJB control should lookup the EJB. To lookup the EJB by its JNDI name,
+ set the EJB control's @EJBHome.jndiName annotation to the EJB's JNDI name. To lookup
+ the EJB using an EJB link, set the EJB control's @EJBHome.ejbLink annotation to the name
+ of the EJB link. (see Annotation).</li>
+
+ <li>If the EJB control uses JNDI to look up an EJB, you may optionally specify the JNDI context
+ environment properties using the @JNDIContextEnv annotation (see Annotation).</li>
+ </ol>
+ </section>
+ <section>
+ <title>EJB Control Extension Example</title>
+
+ <source>
+package org.apache.beehive.controls.system.ejb.sample.control;
+
+import org.apache.beehive.controls.api.bean.ControlExtension;
+import org.apache.beehive.controls.system.ejb.SessionEJBControl;
+import org.apache.beehive.controls.system.ejb.EJBControl.EJBHome;
+import org.apache.beehive.controls.system.ejb.EJBControl.JNDIContextEnv;
+import org.apache.beehive.controls.system.ejb.sample.bean.HelloHome;
+import org.apache.beehive.controls.system.ejb.sample.bean.HelloRemote;
+
+@ControlExtension
+@EJBHome(
+ jndiName="org.apache.beehive.controls.system.ejb.sample.HelloHome")
+@JNDIContextEnv(
+ contextFactory="weblogic.jndi.WLInitialContextFactory",
+ providerURL="t3://localhost:7001",
+ principal="weblogic",
+ credentials="weblogic")
+public interface HelloEJBControl
+ extends SessionEJBControl, HelloHome, HelloRemote
+{
+}
+ </source>
+
+
+ <p>This code is part of the EJB Control samples that is available in the samples directory of
+ the Beehive source tree.</p>
+
+ </section>
+ </body>
+</document>
Propchange: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbControlTutorial.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbDoc.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbDoc.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbDoc.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbDoc.xml Mon Aug 22 13:40:15 2005
@@ -1,102 +1,102 @@
-<?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>EJB Control Overview</title>
- </header>
- <body>
- <section>
- <title>Overview</title>
-
- <p>The EJB control makes it easy for you to use an existing, deployed EJB from within an application
- by relieving you of all the preparatory work prior to invoking a method on an EJB's interface
- to perform tasks. The EJB control automatically manages locating and referencing the EJB
- instance, and directs method invocations to the correct instance of the target EJB.</p>
-
- <p>Here is an example of the code required to invoke a single method on an exposed EJB using standard
- J2EE APIs:</p>
-
- <source>
-Trader trader = null;
-try
-{
- InitialContext ic = new InitialContext();
- TraderHome home = (TraderHome)ic.lookup("MyTraderBean");
- Trader trader = home.create();
- TradeResult tradeResult = trader.buy(stock, shares);
- return tradeResult;
-}
-catch (NamingException ne)
-{
- ...
-}
-catch (CreateException ce)
-{
- ...
-}
-catch (RemoteException re)
-{
- ...
-}
-finally
-{
- if (trader != null)
- trader.remove();
-}
- </source>
-
- <p>The code can be reduced to the following using the EJB Control:</p>
-
- <source>
-@Control
-TraderControlBean traderControl;
-
-try
-{
- TradeResult tradeResult = traderControl.buy(stock, shares);
- return tradeResult;
-}
-catch (RemoteException re)
-{
- ...
-}
-finally
-{
- if (traderControl != null)
- traderControl.remove();
-}
- </source>
-
- <p>You can access EJBs on a different server with an EJB control, provided the server hosting
- the EJB control and the server to which the target EJB is deployed are in the same domain.</p>
- </section>
- <section>
- <title>Annotations</title>
-
- <p>The EJB control contains the following TYPE/FIELD level annotation:</p>
- <p><strong>@EJBHome</strong></p>
-
- <p>Specifies the target EJB's home interface for the EJB control.</p>
- <table>
- <tr><th>Attribute</th><th>Value</th><th>Description</th></tr>
- <tr><td>jndiName</td><td>String</td><td>Specifies the JNDI name of the target EJB's home interface (e.g. EJBNameHome) The JNDI name specified may be an URL using the JNDI protocol (e.g. jndi://username:password@host:7001/my.resource.jndi.object).</td></tr>
-
- <tr><td>ejbLink</td><td>String</td><td>Specifies the name of the target EJB using the application relative path to the EJB JAR. This syntax causes the runtime to use an application scoped name rather than a global JNDI name when locating the referenced EJB. The naming syntax is EJBJAR#BeanName (e.g. CustomerData.jar#CreditCard).</td></tr>
- </table>
-
- <p>Note: A value must be specified for exactly one of the attributes.</p>
-
- <p><strong>@JNDIContextEnv</strong></p>
- <p>Specifies the environment properties for the JNDI context that will be used to lookup the target EJB. This attribute is optional. If you are using an URL with the JNDI protocol or if you want to use a JNDI context with the default environment properties, you do not need to specify any values for this attribute.</p>
-
- <table>
- <tr><th>Attribute</th><th>Value</th><th>Description</th></tr>
- <tr><td>contextFactory</td><td>String</td><td>Specifies the name of the initial context factory class (e.g. weblogic.jndi.WLInitialContextFactory)</td></tr>
- <tr><td>providerURL</td><td>String</td><td>Specifies the URL of the service provider (e.g. t3://localhost:7001)</td></tr>
- <tr><td>principal</td><td>String</td><td>Specifies the identity of the principal for authenticating the caller to the service (e.g. username)</td></tr>
- <tr><td>credentials</td><td>String</td><td>Specifies the credentials of the principal for authenticating the caller to the service (e.g. password)</td></tr>
- </table>
- </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>EJB Control Overview</title>
+ </header>
+ <body>
+ <section>
+ <title>Overview</title>
+
+ <p>The EJB control makes it easy for you to use an existing, deployed EJB from within an application
+ by relieving you of all the preparatory work prior to invoking a method on an EJB's interface
+ to perform tasks. The EJB control automatically manages locating and referencing the EJB
+ instance, and directs method invocations to the correct instance of the target EJB.</p>
+
+ <p>Here is an example of the code required to invoke a single method on an exposed EJB using standard
+ J2EE APIs:</p>
+
+ <source>
+Trader trader = null;
+try
+{
+ InitialContext ic = new InitialContext();
+ TraderHome home = (TraderHome)ic.lookup("MyTraderBean");
+ Trader trader = home.create();
+ TradeResult tradeResult = trader.buy(stock, shares);
+ return tradeResult;
+}
+catch (NamingException ne)
+{
+ ...
+}
+catch (CreateException ce)
+{
+ ...
+}
+catch (RemoteException re)
+{
+ ...
+}
+finally
+{
+ if (trader != null)
+ trader.remove();
+}
+ </source>
+
+ <p>The code can be reduced to the following using the EJB Control:</p>
+
+ <source>
+@Control
+TraderControlBean traderControl;
+
+try
+{
+ TradeResult tradeResult = traderControl.buy(stock, shares);
+ return tradeResult;
+}
+catch (RemoteException re)
+{
+ ...
+}
+finally
+{
+ if (traderControl != null)
+ traderControl.remove();
+}
+ </source>
+
+ <p>You can access EJBs on a different server with an EJB control, provided the server hosting
+ the EJB control and the server to which the target EJB is deployed are in the same domain.</p>
+ </section>
+ <section>
+ <title>Annotations</title>
+
+ <p>The EJB control contains the following TYPE/FIELD level annotation:</p>
+ <p><strong>@EJBHome</strong></p>
+
+ <p>Specifies the target EJB's home interface for the EJB control.</p>
+ <table>
+ <tr><th>Attribute</th><th>Value</th><th>Description</th></tr>
+ <tr><td>jndiName</td><td>String</td><td>Specifies the JNDI name of the target EJB's home interface (e.g. EJBNameHome) The JNDI name specified may be an URL using the JNDI protocol (e.g. jndi://username:password@host:7001/my.resource.jndi.object).</td></tr>
+
+ <tr><td>ejbLink</td><td>String</td><td>Specifies the name of the target EJB using the application relative path to the EJB JAR. This syntax causes the runtime to use an application scoped name rather than a global JNDI name when locating the referenced EJB. The naming syntax is EJBJAR#BeanName (e.g. CustomerData.jar#CreditCard).</td></tr>
+ </table>
+
+ <p>Note: A value must be specified for exactly one of the attributes.</p>
+
+ <p><strong>@JNDIContextEnv</strong></p>
+ <p>Specifies the environment properties for the JNDI context that will be used to lookup the target EJB. This attribute is optional. If you are using an URL with the JNDI protocol or if you want to use a JNDI context with the default environment properties, you do not need to specify any values for this attribute.</p>
+
+ <table>
+ <tr><th>Attribute</th><th>Value</th><th>Description</th></tr>
+ <tr><td>contextFactory</td><td>String</td><td>Specifies the name of the initial context factory class (e.g. weblogic.jndi.WLInitialContextFactory)</td></tr>
+ <tr><td>providerURL</td><td>String</td><td>Specifies the URL of the service provider (e.g. t3://localhost:7001)</td></tr>
+ <tr><td>principal</td><td>String</td><td>Specifies the identity of the principal for authenticating the caller to the service (e.g. username)</td></tr>
+ <tr><td>credentials</td><td>String</td><td>Specifies the credentials of the principal for authenticating the caller to the service (e.g. password)</td></tr>
+ </table>
+ </section>
+
+ </body>
+</document>
Propchange: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbDoc.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbc-annotations.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbc-annotations.xml?rev=239246&r1=239245&r2=239246&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbc-annotations.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbc-annotations.xml Mon Aug 22 13:40:15 2005
@@ -1,22 +1,22 @@
-<?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 Annotations</title>
- </header>
- <body>
- <section>
- <title>Jdbc Control Annotations</title>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jdbc/JdbcControl.ConnectionDataSource.html">@JdbcControl.ConnectionDataSource</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jdbc/JdbcControl.ConnectionDriver.html">@JdbcControl.ConnectionDriver</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jdbc/JdbcControl.ConnectionOptions.html">@JdbcControl.ConnectionOptions</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jdbc/JdbcControl.SQL.html">@JdbcControl.SQL</a></p>
- <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jdbc/JdbcControl.TypeMapper.html">@JdbcControl.TypeMapper</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>Jdbc Control Annotations</title>
+ </header>
+ <body>
+ <section>
+ <title>Jdbc Control Annotations</title>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jdbc/JdbcControl.ConnectionDataSource.html">@JdbcControl.ConnectionDataSource</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jdbc/JdbcControl.ConnectionDriver.html">@JdbcControl.ConnectionDriver</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jdbc/JdbcControl.ConnectionOptions.html">@JdbcControl.ConnectionOptions</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jdbc/JdbcControl.SQL.html">@JdbcControl.SQL</a></p>
+ <p><a href="../../apidocs/classref_systemcontrols/org/apache/beehive/controls/system/jdbc/JdbcControl.TypeMapper.html">@JdbcControl.TypeMapper</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/jdbc/jdbc-annotations.xml
------------------------------------------------------------------------------
svn:eol-style = native