Author: steveh
Date: Fri May 13 13:54:20 2005
New Revision: 170088
URL: http://svn.apache.org/viewcvs?rev=170088&view=rev
Log:
Fix for BEEHIVE-724: Need a "how to run" document for the
controls-webservices-blank sample
Added:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/webservices/sample-ws-control-blank.xml
(with props)
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml?rev=170088&r1=170087&r2=170088&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
Fri May 13 13:54:20 2005
@@ -76,6 +76,7 @@
<netui-blank label="Page Flow Project"
href="pageflow/sample_netui-blank.html"/>
<control-blank label="Control Project"
href="controls/sample_controls-blank.html"/>
<wsm-blank label="Web Service Project"
href="wsm/sample_wsm-blank.html"/>
+ <ws-control-blank label="Web Service Control Project"
href="system-controls/webservices/sample-ws-control-blank.html" />
</samples>
<ref label="Reference Docs">
<controls label="Controls">
Added:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/webservices/sample-ws-control-blank.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/webservices/sample-ws-control-blank.xml?rev=170088&view=auto
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/webservices/sample-ws-control-blank.xml
(added)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/webservices/sample-ws-control-blank.xml
Fri May 13 13:54:20 2005
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd";>
+<document>
+ <header>
+ <title>Web Service Control Template</title>
+ </header>
+ <body>
+ <section>
+ <title>Introduction</title>
+
+ <p>Use the web service control template (located at
+
<code><BeehiveRoot>/samples/controls-webservices-blank</code>) as a starting
point for your
+ web service control.</p>
+ <p>A web service control makes it easy for
other applications
+ to become clients of the target web
service.</p>
+ </section>
+ <section>
+ <title>Generating a Service Control</title>
+ <p>To generate a service control you will need a WSDL
file from the target web service.</p>
+ <p>Drop the WSDL file (along with any other schemas
required by the web service)
+ into the schemas directory
(<BeehiveRoot>/samples/controls-webservices-blank/schemas).</p>
+ <p>Run the ant target <code>ant build</code> to
generate a JAR for the service
+ control. The build generates the types used by
the web service
+ along with the control interfaces and compiles
them into a JAR file.
+ The final service control JAR is saved in the
build directory.</p>
+ <p>The controls-webservice-blank sample contains the
WSDL file for the
+ <a
href="site:address">EnhancedAddressBookWS</a> sample, but the web service
+ doesn't need to be running to
+ generate its service control.</p>
+
+ </section>
+ <section>
+ <title>Junit Testing</title>
+
+ <p>The <code>controls-webservice-blank</code> shows how
to write junit tests for
+ the service control, but it is not mandatory to
have junit tests for a control.</p>
+ <p>The junit tests call the web service using the
control interfaces generated based
+ on the WSDL. The tests add an entry and
retrieve it to verify the web service.
+ The run the junit tests make sure you have the
+ <a
href="site:address">EnhancedAddressBookWS</a> up and running.
+ </p>
+ <note>Controls are meant to be used in a container; in
a container
+ (servlet, ejb, spring) the initialization
happens transparent to the
+ application. The junit tests here are
standalone and are running
+ outside a container, so we have to do some of
the work that the container
+ normally would do.
+ The junit setUp includes the control
initialization.
+ In the junit environment this is done in the
set up. Be aware that the
+ in the future we plan to automate the junit
initialization for the running
+ controls.</note>
+ <note>The build file uses XMLBeans to generate types.
XMLBeans should only be
+ used for the Literal use (RPC or Document
style) WSDLs. For RPC-Encoded
+ WSDLs Axis tools must be used to generate the
types. The build.xml file
+ contains the targets to generate Axis types
but they are commented out.
+ To use Axis tools uncomment the Axis related
lines and make the necessary
+ changes to the build file.
+
+ </note>
+ </section>
+ </body>
+</document>
Propchange:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/system-controls/webservices/sample-ws-control-blank.xml
------------------------------------------------------------------------------
svn:eol-style = native
