Author: ips
Date: Mon Apr 4 13:13:30 2005
New Revision: 160093
URL: http://svn.apache.org/viewcvs?view=rev&rev=160093
Log:
applied patch from Pankaj that adds a "getting started" help page
Added:
incubator/apollo/trunk/src/site/content/xdocs/getting_started.xml
Modified:
incubator/apollo/trunk/BUILD.txt
incubator/apollo/trunk/project.properties
incubator/apollo/trunk/src/java/org/apache/ws/resource/tool/Wsdl2Java.java
incubator/apollo/trunk/src/site/content/tutorial/build.xml
incubator/apollo/trunk/src/site/content/xdocs/site.xml
Modified: incubator/apollo/trunk/BUILD.txt
URL:
http://svn.apache.org/viewcvs/incubator/apollo/trunk/BUILD.txt?view=diff&r1=160092&r2=160093
==============================================================================
--- incubator/apollo/trunk/BUILD.txt (original)
+++ incubator/apollo/trunk/BUILD.txt Mon Apr 4 13:13:30 2005
@@ -2,14 +2,32 @@
--------------------------------------------------
1) Install Maven as desribed below.
2) cd to the Apollo project directory (e.g. /projects/apollo/trunk).
-3) Run 'maven jar'.
+3) If you are behind a corporate firwall and use an HTTP proxy to reach out to
+ the World Wide Web, edit 'project.properties' file to uncomment the
following
+ line:
+
+ # maven.junit.jvmargs=-DproxySet=true -Dhttp.proxyHost=<proxy-host>
-Dhttp.proxyPort=<proxy-port>
+
+ and replace <proxy-name> and <proxy-port> with appropriate values for your
setup.
+4) Run 'maven jar'.
Building the Apollo distribution zipfiles
-----------------------------------------
1) Install Maven as described below.
2) Install Forrest as described below.
3) cd to the Apollo project directory (e.g. /projects/apollo/trunk).
-4) Run 'maven dist'. (Note: this can take five minutes or longer to complete)
+4) If you are behind a corporate firwall and use an HTTP proxy to reach out to
+ the World Wide Web, edit 'project.properties' file to uncomment the
following
+ line:
+
+ # maven.junit.jvmargs=-DproxySet=true -Dhttp.proxyHost=<proxy-host>
-Dhttp.proxyPort=<proxy-port>
+
+ and replace <proxy-name> and <proxy-port> with appropriate values for your
setup.
+5) Run 'maven dist'. (Note: this can take five minutes or longer to complete)
+ This command creates binary and source zip files 'apollo-<rev_label>.zip'
and
+ 'apollo-<rev_label>-src.zip' under target/distributions sub directory. To
work
+ with Apollo, unzip the binary zip file to a convenient location and follow
the
+ 'Getting Started' instructions.
Installing Maven
----------------
Modified: incubator/apollo/trunk/project.properties
URL:
http://svn.apache.org/viewcvs/incubator/apollo/trunk/project.properties?view=diff&r1=160092&r2=160093
==============================================================================
--- incubator/apollo/trunk/project.properties (original)
+++ incubator/apollo/trunk/project.properties Mon Apr 4 13:13:30 2005
@@ -20,6 +20,8 @@
log4j.configuration = test-log4j.properties
maven.junit.fork = on
+# If you are behind a HTTP proxy, uncomment and modify the following line for
your setup
+#maven.junit.jvmargs=-DproxySet=true -Dhttp.proxyHost=<proxy-host>
-Dhttp.proxyPort=<proxy-port>
# WAR PLUGIN
##############
Modified:
incubator/apollo/trunk/src/java/org/apache/ws/resource/tool/Wsdl2Java.java
URL:
http://svn.apache.org/viewcvs/incubator/apollo/trunk/src/java/org/apache/ws/resource/tool/Wsdl2Java.java?view=diff&r1=160092&r2=160093
==============================================================================
--- incubator/apollo/trunk/src/java/org/apache/ws/resource/tool/Wsdl2Java.java
(original)
+++ incubator/apollo/trunk/src/java/org/apache/ws/resource/tool/Wsdl2Java.java
Mon Apr 4 13:13:30 2005
@@ -429,30 +429,22 @@
private boolean isDraft05Specific(ResourceDefinition resourceDef)
{
-
if(resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_11.porttype.GetMultipleResourcePropertiesPortType.NAME)
+ return
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_11.porttype.GetMultipleResourcePropertiesPortType.NAME)
||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_11.porttype.GetResourcePropertyDocumentPortType.NAME)
||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_11.porttype.DeleteResourcePropertiesPortType.NAME)
||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_11.porttype.GetResourcePropertyPortType.NAME)
||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_11.porttype.InsertResourcePropertiesPortType.NAME)
||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_11.porttype.QueryResourcePropertiesPortType.NAME)
||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_11.porttype.SetResourcePropertiesPortType.NAME)
- ||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_11.porttype.UpdateResourcePropertiesPortType.NAME))
- {
- return true;
- }
- return false;
+ ||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_11.porttype.UpdateResourcePropertiesPortType.NAME);
}
private boolean isDraft01Specific(ResourceDefinition resourceDef)
{
- if(
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_06.porttype.GetMultipleResourcePropertiesPortType.NAME)
+ return
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_06.porttype.GetMultipleResourcePropertiesPortType.NAME)
||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_06.porttype.GetResourcePropertyPortType.NAME)
||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_06.porttype.QueryResourcePropertiesPortType.NAME)
- ||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_06.porttype.SetResourcePropertiesPortType.NAME))
- {
- return true;
- }
- return false;
+ ||
resourceDef.implementsResourceCapability(org.apache.ws.resource.properties.v2004_06.porttype.SetResourcePropertiesPortType.NAME);
}
private void generateXmlBeans( File wsdlFile )
Modified: incubator/apollo/trunk/src/site/content/tutorial/build.xml
URL:
http://svn.apache.org/viewcvs/incubator/apollo/trunk/src/site/content/tutorial/build.xml?view=diff&r1=160092&r2=160093
==============================================================================
--- incubator/apollo/trunk/src/site/content/tutorial/build.xml (original)
+++ incubator/apollo/trunk/src/site/content/tutorial/build.xml Mon Apr 4
13:13:30 2005
@@ -32,8 +32,7 @@
<pathelement location="${mail.jar}" />
</path>
<property name="apollo.classpath" refid="apollo.classpath.id" />
-
-
+
</target>
<target name="generate"
@@ -45,8 +44,7 @@
<copy file="${filesystem.wsdl}" todir="${tmp.dir}" overwrite="true" />
<copy file="${sysprop.wsdl}" todir="${tmp.dir}" overwrite="true" />
<mkdir dir="${wsrf.webapp.dir}/wsdl" />
-
-
+
<taskdef name="wsdl2Java"
classname="org.apache.ws.resource.tool.Wsdl2JavaTask"
classpath="${apollo.classpath}" />
<wsdl2Java outputDir="${out.dir}"
@@ -56,7 +54,7 @@
proxyPort="${http.proxyPort}"
nonProxyHosts="${http.nonProxyHosts}">
<wsdls dir="${tmp.dir}">
- <include name="**/*.wsdl" />
+ <include name="**/*.wsdl" />
</wsdls>
</wsdl2Java>
Added: incubator/apollo/trunk/src/site/content/xdocs/getting_started.xml
URL:
http://svn.apache.org/viewcvs/incubator/apollo/trunk/src/site/content/xdocs/getting_started.xml?view=auto&rev=160093
==============================================================================
--- incubator/apollo/trunk/src/site/content/xdocs/getting_started.xml (added)
+++ incubator/apollo/trunk/src/site/content/xdocs/getting_started.xml Mon Apr
4 13:13:30 2005
@@ -0,0 +1,105 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+ "http://forrest.apache.org/dtd/document-v20.dtd";>
+
+<document>
+
+ <header>
+ <title>Getting Started with Apollo</title>
+ </header>
+
+ <body>
+
+ <section>
+ <title>Introduction</title>
+
+ <p>
+ This page lists the steps required to run the Apollo tutorial sample
application,
+ assuming that you have already
+ </p>
+ <ul>
+ <li>installed Apollo binary distribution obtained by unzipping the
zip file.</li>
+ <li>installed Apache Tomcat or an another similar Web container.</li>
+ <li>installed a recent version of Apache Ant and environment variable
PATH includes
+ its <code>bin</code> directory.</li>
+ </ul>
+
+ <p>
+ For simplicity, let us assume that everything runs on the same machine
and Tomcat
+ is configured to listen at the default HTTP port 8080. Also, we will
refer to Tomcat
+ home directory (say, <code>c:\jakarta-tomcat-4.1.30</code>)
+ by TOMCAT_HOME and Apollo home directory
+ (say, <code>c:\apollo-incubating-1.0-alpha3-SNAPSHOT</code>)
+ by APOLLO_HOME.
+ </p>
+ </section>
+
+ <section>
+ <title>Getting Started Steps</title>
+ <p>Carry out the following steps to see your Apollo installation in
action:</p>
+
+ <ol>
+ <li><strong>Deploy the WSRF webapp to Tomcat:</strong> Copy directory
tree
+ <code>APOLLO_HOME/webapps/wsrf</code> to
<code>TOMCAT_HOME/webapps</code> directory.
+ At this stage, if you start Tomcat and point your browser to
+ <a
href="http://localhost:8080/wsrf";>http://localhost:8080/wsrf</a>, you should
+ be able to see the Apache-Axis welcome page (Yes, WSRF webapp is
just Axis webapp and
+ some additional stuff). Clicking on
+ <em><a
href="http://localhost:8080/wsrf/servlet/AxisServlet";>View</a> the list of
+ deployed Web services</em> should show two default
+ Axis services -- 'AdminService' and 'Version'.<br/></li>
+
+ <li><strong>Property changes for Tomcat installation and HTTP
Proxy:</strong> Change
+ directory to <code>APOLLO_HOME/docs/tutorial</code> and edit
+ <code>build.properties</code> file, following the instructions in
the file.<br/></li>
+
+ <li><strong>Generate Java code from WSDL:</strong> Issue the command
+ <strong><code>ant generate</code></strong>. Successful execution of
this command
+ will create a bunch of directories and files under
<code>generated</code> sub-directory.<br/></li>
+
+ <li><strong>Supply Application specific code:</strong> Some of the
generated source files
+ need application specific code to be supplied. Change directory to
+
<code>generated/filesystem/src/java/org/apache/ws/resource/example/filesystem</code>,
and
+ edit files <code>FilesystemHome.java</code>,
<code>FilesystemResource.java</code> and
+ <code>FilesystemService.java</code>
+ as per the embedded instructions. Just do a Copy-Paste of code
fragments available in
+ directory <code>APOLLO_HOME/docs/tutorial/method_impls</code>. Which
fragment goes
+ in which
+ source file can be inferred from code fragment filenames.
+ <br/>
+ The code fragments use additional classes. To get the source files
for these classes
+ at appropriate place, copy sub directories <code>backend</code> and
<code>callback</code> from
+ <code>APOLLO_HOME/docs/tutorial/src/example/filesystem</code> to
+
<code>APOLLO_HOME/docs/tutorial/generated/filesystem/src/java/org/apache/ws/resource/example/filesystem</code>.
+ <br/></li>
+
+ <li><strong>Compile and deploy filesystem service:</strong> Change
directory to
+ <code>APOLLO_HOME/docs/tutorial/generated/filesystem</code> and
issue the
+ command: <strong><code>ant compile deploy</code></strong>.<br/></li>
+
+ <li><strong>Verify service deployment:</strong> Restart Tomcat and
point your browser
+ to <a href="http://localhost:8080/wsrf/servlet/AxisServlet";>
+ http://localhost:8080/wsrf/servlet/AxisServlet</a>. You should see
the additional
+ service
+ 'filesystem'. You should be able to drill down into the link labelled
'wsdl' and retrieve
+ the WSDL document of the newly deployed WSRF service.<br/></li>
+
+ <li><strong>Perform WSRF operations:</strong> Change directory to
+ <code>APOLLO_HOME/docs/tutorial</code>
+ directory and issue the following command:
+ <br/>
+ <strong><code>ant -f soapclient.xml
-Durl=http://localhost:8080/wsrf/services/filesystem
-Dxml=requests/GetMultipleResourceProperties.soap</code></strong>
+ <br/>
+ You should also try other request messages kept under
<code>requests</code> sub-directory.
+ </li>
+ </ol>
+ <p>
+ For a more detailed description about what happens behind the scene at
each step, refer to
+ the <a href="tutorial/index.html">Apollo Tutorial</a>.
+ </p>
+ </section>
+
+ </body>
+
+</document>
Modified: incubator/apollo/trunk/src/site/content/xdocs/site.xml
URL:
http://svn.apache.org/viewcvs/incubator/apollo/trunk/src/site/content/xdocs/site.xml?view=diff&r1=160092&r2=160093
==============================================================================
--- incubator/apollo/trunk/src/site/content/xdocs/site.xml (original)
+++ incubator/apollo/trunk/src/site/content/xdocs/site.xml Mon Apr 4 13:13:30
2005
@@ -28,7 +28,8 @@
<releases label="Releases" href="release.html" />
</project>
- <docs label="Documentation">
+ <docs label="Documentation">
+ <website label="Getting Started" href="getting_started.html" />
<website label="WSRF" href="wsrf.html" />
<tutorial label="Tutorial" href="tutorial/index.html" />
<!--<manual label="Manual" href="manual/index.html" />-->
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
