axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hemap...@apache.org
Subject cvs commit: ws-axis/contrib/ews/docs usage.html TODO.txt index.html ews.css developer-Guide.html build.html userGuide.html build.txt architecture.html
Date Sun, 13 Jun 2004 16:12:10 GMT
hemapani    2004/06/13 09:12:09

  Modified:    contrib/ews/docs userGuide.html
  Added:       contrib/ews/docs usage.html TODO.txt index.html ews.css
                        developer-Guide.html build.html
  Removed:     contrib/ews/docs build.txt architecture.html
  Log:
  update the ews documentations
  merge old documnetations and updates them
  remove outdated documents
  
  Revision  Changes    Path
  1.4       +49 -8     ws-axis/contrib/ews/docs/userGuide.html
  
  Index: userGuide.html
  ===================================================================
  RCS file: /home/cvs/ws-axis/contrib/ews/docs/userGuide.html,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- userGuide.html	24 May 2004 16:16:06 -0000	1.3
  +++ userGuide.html	13 Jun 2004 16:12:09 -0000	1.4
  @@ -1,14 +1,48 @@
   <html>
  +<head>
  +<link rel="stylesheet" type="text/css" href="ews.css">
  +</head>
   <body>
  -<h1>Ws4J2ee tool</h1>
  -<h2>using with WSDL</h2>
  -you need the webservice.xml file, jaxrpcmapper.xml file, x.wsdl file
  -<p>look at the org.apache.geronimo.ews.ws4j2ee.GenerateTest</p>
  -<h2>using without WSDL</h2>
  +<h1>Using the Ws4J2ee tool</h1>
  +<p>you need to have the following files 
  +<ol>
  +<li>webservice.xml file</li>
  +<li>SEI(class file)</li>
  +<li>Implementation bean(class file)</li>
  +<li>ejb-jar.xml/web.xml file</li>
  +<li>(optional wsdl file and jaxrpcmapping file/both or none) 
  +</ol>
  +</p>
  +<p>Above files should be packaged in to a jar file as 
  +follows</p>
  +
  +<h2>Use with JAR/(WAR/EAR not yet implemented) file</h2>
  +<code>
  +org.apache.geronimo.ews.ws4j2ee.toWs.Ws4J2EEwithoutWSDL jar-filec out-dir
  +</code>
  +<br><br>
  +(WAR/EAR file is not implemented)
  +<p> for sample jar files build the ews and look in the <code>target/generated/samples</code>
  +
  +<h3>If EJB based jar file should be like this</h3>
  +<pre> 
  +	/-META-INF/webservice.xml
  +	 -META-INF/ejb-jar.xml
  +         -SEI class
  +         -service implementation bean class
  +         -any other referance classes
  +</pre>
  +<h3>If web based jar file should be like this</h3>
  +<pre> 
  +	/-META-INF/webservice.xml
  +	 -META-INF/web.xml
  +         -SEI class
  +         -service implementation bean class
  +         -any other referance classes
  +</pre>
   
  -	<p>you need to have the 
  -	webservice.xml file AND SEI (optional Implemntation bean and ejb-jar.xml/web.xml file)

  -	</p>
  +<h2>Use with Class files and DD are in directory hirachey</h2>
  +	<code>org.apache.geronimo.ews.ws4j2ee.toWs.Ws4J2EEwithoutWSDL arguments</code>
   	<p>args is String array s.t.</p>
   	<ol>
   		<li>first argument is webservice.xml file</li> 
  @@ -24,6 +58,13 @@
   
   
   <p>look at the org.apache.geronimo.ews.ws4j2ee.GenerateWithoutWSDLTest</p>
  +
  +<!--
  +<h2>Using with WSDL</h2>
  +you need the webservice.xml file, jaxrpcmapper.xml file, x.wsdl file
  +<p>look at the org.apache.geronimo.ews.ws4j2ee.GenerateTest</p>
  +-->
  +
   <h2>Appendix</h2>
   <h3>Service Endpoint Interface</h3>
   <p>The JAX-RPC specification requires that a JAX-RPC service endpoint interface must
  
  
  
  1.1                  ws-axis/contrib/ews/docs/usage.html
  
  Index: usage.html
  ===================================================================
  <html>
  <head>
  <link rel="stylesheet" type="text/css" href="ews.css">
  </head>
  <body>
  <h1>Usage Scenario’s</h2>
  <p> by means of EWS we wish to implements the following Scenario’s</p>
  
  <p>
  The idea behind J2EE web service is to introduce a programming model that is similar to
the J2EE for java web services. In other words, the  deployer  will create following files.<p>
  <ol>
      <li><a href="dev/list4.txt">SEI (Service endpoint interface)</a></li>
      <li><a href="dev/list5.txt">Implementation bean</a></li> 
      <li><a href="dev/ejb-jar.xml">ejb-jar.xml</a> file or <a href="dev/web.xml">web.xml
file</a></li>
      <li><a href="dev/webservice.xml">Webservice.xml file</a></li>
  </ol>
  <p>Then he should package those files in a JAR file/WAR file/ EAR file. The EWS tool
should accept this EAR/WAR/JAR file and do the following</p>
  
      <h3><a href="dev/validate.html">Validate the deployment artifacts</a></h3>
  	<p>The module is check aginest the jsr109 specification requirenment. Please see
the requirement for each item of the <a href="userGuide.html">User Guide Appendix</a>.
      <h3><a href="dev/convert.html">Convert the Web services into standard J2EE
artifacts</a></h3>
  	<p>Deployment of each port-component is dependent upon the service implementation
and container used. Deployment of a JAX-RPC Service Endpoint requires different handling than
deployment of a session bean service.<p>
      <h3>Deploy and publish the WSDL's</h3>
  	<p>The deployment tool must deploy and publish all the ports of all WSDL documents
described in the Web services deployment descriptor. The deployment tool updates or generates
the WSDL port address for each deployed port-component. The updated WSDL documents are then
published to a location determined by the deployer. It could be as simple as publishing to
a file in the modules containing the deployed services, a URL location representing the deployed
services of the server, a UDDI or ebXML registry, or a combination of these. </p>
  <h3>Resolving references to Web services</h3>
   <p>For each <a href="dev/service-ref1.xml">service reference described in the
Web services client deployment descriptors</a>, the deployment tool ensures that the
client code can access the Web service. The deployment tool examines the information provided
in the client deployment descriptor (the Service interface class, the Service Endpoint Interface
class, and WSDL ports the client wants to access) as well as the JAX-RPC mapping information.
In general the procedure includes providing an implementation of the JAX-RPC Service interface
class declared in the deployment descriptor service reference, generating stubs for all the
service-endpoint-interface declarations (if generated Stubs are supported and the deployer
decides to use them), and binding the Service class implementation into a JNDI namespace.</p>
  
  <p>The specifics depend on whether or not the service is declared as a client managed
or container managed access. When client managed port access is used, the deployment tool
must provide generated stubs or dynamic proxy access to every port declared within the Web
services client deployment descriptor. The choice of generated stub or dynamic proxy is deploy
time binding information. The container must provide an implementation for a Generated Service
Interface if declared within the deployment descriptor. When container managed port access
to a service is used, the container must provide generated stubs or dynamic proxy access to
every port declared within the deployment descriptor. The choice of generated stub or dynamic
proxy is deploy time binding information. The deployment descriptor may contain a portcomponent-
link to associate the reference not only with the Service Endpoint Implementation, but with
the WSDL that defines it.<p>
  <h3>Deployment of generated J2EE artifacts</h3>
  Once the Web services enabled deployable artifact has been converted into a J2EE deployable
artifact, the deployment process continues using normal deployment processes
  
  
  </body>
  </html>
  
  
  1.1                  ws-axis/contrib/ews/docs/TODO.txt
  
  Index: TODO.txt
  ===================================================================
  1)generate a one jar that can be deployed - DONE
  2)add the code to address the security
  3)generate the code to adress the transaction
  4) use the GBeans ??
  5)generate the new ejb-jar.xml file using the given ejb-jar.xml  file 
  6)Architecutre guide - DONE 
  7)finish user guide - DONE
  8)replace JAXB with the JAXME
  9)JAXR support
  10)Binding client stubs in the JNDI
  11) support for the EAR file
  12)how to deploy the EJB and WS programatically
  13)Change the String file to represent file name or a input Stream
  14)Accsess EJB via ContinaerIndex
  15)calling the build.xml file programatically 
    
  
  
  
  1.1                  ws-axis/contrib/ews/docs/index.html
  
  Index: index.html
  ===================================================================
  <html>
  <head>
  <title>EWS - Enterprise Web Services or (jsr109)</title>
  <link rel="stylesheet" type="text/css" href="ews.css">
  </head>
  <body>
  <h1>Enterprise Web Services</h1>
  <p>JSR109 defines the Web Services for J2EE architecture. It does not interfere with
the J2EE components functionality instead open a new avenue to access them as web services.
This is a service architecture that leverages the J2EE component architecture to provide a
client and server programming model which is portable and interoperable across application
servers, provides a scalable secure environment, and yet is familiar to J2EE developers.</p>

  
  <h2>CVS location</h2> 
  	<p>the code is avalible under the <br><code>ws-axis/contrib/ews</code></p>
  	<code>
  	export CVS_RSH=/usr/bin/ssh<br>
  	cvs -d alex@cvs.apache.org:/home/cvs co ws-axis/contrib/ews<br>
  	</code>
    
     <h2>Documentation</h2>
      <ul>
          <li><a href="userGuide.html">User Guide</a></li>
  	<li><a href="usage.html">Usage Senario's</a>, Explains what does this
project going to do</li>
          <li><a href="developer-Guide.html">Developer Guide</a></li>
          <li><a href="build.html">build Guide</a></li>
          <li><a href="test.html">tests</a></li>
          <li><a href="faq.html">FAQ</a></li>
      </ul>
  
  
  
  <h2>Contributors (not in any order)</h2> 
      <ul>	
      <li>Srinath Perara <a href="mailto:hemapani@opensource">hemapani@opensource.lk</a></li>
      <li>Chathura Herath <a href="mailto:chathura@opensource.lk">chathura@opensource.lk</a></li>
      <li>Guillaume Sauthier <a href="mailto:Guillaume.Sauthier@Objectweb.org">Guillaume.Sauthier@Objectweb.org</a></li>
      <li>Dasarath Weerathunge <a href="mailto:dasaru@opensource.lk">dasaru@opensource.lk</a></li>
      <li>Davanum Srinivas <a href="mailto:dims@yahoo.com">dims@yahoo.com</a></li>
      <li>Ranjit Priyanga <a href="mailto:priyanga@opensource.lk">priyanga@opensource.lk</a></li>
      <li>Ias <a href="mailto:iasandcb@tmax.co.kr">iasandcb@tmax.co.kr</a></li>
      <li>Luis Avila <a href="mailto:lavila@axer.cl">lavila@axer.cl</a></li>
      <li>Jeremy Lemaire <a href="mailto:Jeremy.Lemaire@online.fr">Jeremy.Lemaire@online.fr</a></li>
      <li>Richard Monson-Haefel <a href="mailto:Richard@Monson-Haefel.com">Richard@Monson-Haefel.com</a></li>
      </ul>
  
  
  
  
  
  </body>
  <html>
  
  
  
  
  
  1.1                  ws-axis/contrib/ews/docs/ews.css
  
  Index: ews.css
  ===================================================================
  .example {
  	BACKGROUND: #ccccff
  }
  .xml {
  	BACKGROUND: #eeeeee
  }
  .java {
  	BACKGROUND: #eeeeee
  }
  
  H2 {
  	BACKGROUND-COLOR: #ffdda8
  }
  H3 {
  	BACKGROUND-COLOR: #ffdda8;
  }
  H1 {
  	BACKGROUND-COLOR: #ffdda8;
  }
  
  code {
  	 BACKGROUND-COLOR: #ffeefa; 
  }
  .note {
  	FONT-WEIGHT: bold
  }
  .head {
  	FONT-WEIGHT: bold; FONT-SIZE: 240%; TEXT-ALIGN: center
  }
  TD.section {
  	FONT-WEIGHT: bold; FONT-SIZE: 180%; BACKGROUND-COLOR: #82adf6; TEXT-ALIGN: center
  }
  SMALL.red {
  	COLOR: red
  }
  
  
  
  1.1                  ws-axis/contrib/ews/docs/developer-Guide.html
  
  Index: developer-Guide.html
  ===================================================================
  <html>
  <head>
  <title>Developer Guide-EWS</title>
  <link rel="stylesheet" type="text/css" href="ews.css">
  </head>
  <body>
  <h1>EWS</h1>
  <p>How it is implemented</p>
  <h2><a href="dev/server.html">Server Side Implementation</a></h2>
  <h2><a href="dev/client.html">Client Side Implementation</a></h2>
  <h3>Deployment Descriptor (DD) parsing</h3> 
  <p>There are two DD added to the JSR109, they are webservice.xml file and the jaxrpc-mapping
file. For those two we are using JAXB to parse them.</p>
  <p>For deal with WSDL file we are using the JAXRPC-Mapper which is a extension of
WSDL2Java and Java2WSDL of axis.</p>
  <p>To parse the web.xml file and ejb-jar.xml the tool use DOM for the time been. We
are considering possibility of using Geronimo DD parsing technique. (Use the method standalone,
maybe we can get the information from Geronimo when our tool is used inside Geronimo)</p>
  <h2><a href="dev/Geronimov-axisIntegration.html">Geronimov Axis Integration</a></h2>
  <h2><a href="proposedframework.html">Proposed Framework</a></h2>
  <h2><a href="dev/sec.html">Security</h2>
  <h2><a href="dev/trans.html">Transaction</h2>
  
  
  </body>
  </html>
  
  
  1.1                  ws-axis/contrib/ews/docs/build.html
  
  Index: build.html
  ===================================================================
  <html>
  <head>
  <title>how to build EWS</title>
  <link rel="stylesheet" type="text/css" href="ews.css">
  </head>
  <body>
  <h1>Building EWS</h1>
  
  To build EWS use maven. 
  <ul>
  <li>Download and install  maven</li>
  <li>Check out EWS code from the <a href="ws.apache.org/axis/cvs.html">ws-axis/contrib/ews</a></li>
  <li>cd to the project dir and type one of the following command to build the project.
  <code>maven or maven jar</code></li> 
  
  <li><code>maven –o</code> 
  Used for offline build (you need to have the jar’s at the repository to do the offline build.
But if you are build it in some machine copy the .maven dir and put it in the right place
in the machine you want to build in than use –o option. But be careful for the outdated files.)</li>
  <li>if you are behind a firewall create a build.properties file in the home dir with
following entries</li>
  <br>
  <code> 
  maven.proxy.host = cache.mrt.ac.lk (put your proxy)<br>
  maven.proxy.port = 3128 (put your port)<br>
  </code>
  </br>
  To run the EWS look at the <a href="userGuide.html">User Guide</a>
  
  </body>
  </html>
  
  

Mime
View raw message