Author: coheigea
Date: Mon Jan 7 11:36:50 2013
New Revision: 1429758
URL: http://svn.apache.org/viewvc?rev=1429758&view=rev
Log:
README cleanup
Modified:
cxf/trunk/distribution/src/main/release/samples/wsdl_first/README.txt
cxf/trunk/distribution/src/main/release/samples/wsdl_first_xmlbeans/README.txt
Modified: cxf/trunk/distribution/src/main/release/samples/wsdl_first/README.txt
URL:
http://svn.apache.org/viewvc/cxf/trunk/distribution/src/main/release/samples/wsdl_first/README.txt?rev=1429758&r1=1429757&r2=1429758&view=diff
==============================================================================
--- cxf/trunk/distribution/src/main/release/samples/wsdl_first/README.txt
(original)
+++ cxf/trunk/distribution/src/main/release/samples/wsdl_first/README.txt Mon
Jan 7 11:36:50 2013
@@ -1,12 +1,14 @@
WSDL First Demo
===============
-This demo shows how to build and call a webservice using a given WSDL (also
called Contract First).
-As writing a WSDL by hand is not so easy the following How-To may be a useful
read:
+This demo shows how to build and call a webservice using a given WSDL (also
+called Contract First). As writing a WSDL by hand is not so easy the following
+How-To may be a useful read:
http://cxf.apache.org/docs/defining-contract-first-webservices-with-wsdl-generation-from-java.html
-This demo mainly addresses SOAP over HTTP in Document/Literal or
Document/Literal wrapped style.
-For other transports or styles the configuration may look different.
+This demo mainly addresses SOAP over HTTP in Document/Literal or
+Document/Literal wrapped style. For other transports or styles the
+configuration may look different.
The Demo consist of three parts:
@@ -19,12 +21,12 @@ Code generation
When using Maven the code generation is done using the Maven cxf-codegen-plugin
(http://cxf.apache.org/docs/maven-cxf-codegen-plugin-wsdl-to-java.html).
-The code generation is tuned using a binding.xml file. In this case the file
configures
-normal Java Dates to be used for xsd:date and xsd:DateTime. If this is not
present then
-XMLGregorianCalendar will be used.
+The code generation is tuned using a binding.xml file. In this case the file
+configures normal Java Dates to be used for xsd:date and xsd:DateTime. If this
+is not present then XMLGregorianCalendar will be used.
-One other common use of the binding file is to also generate asynchronous
stubs. The line
-jaxws:enableAsyncMapping has to be uncommented to use this.
+One other common use of the binding file is to also generate asynchronous
+stubs. The line jaxws:enableAsyncMapping has to be uncommented to use this.
More info about the binding file can be found here:
http://jax-ws.java.net/jax-ws-20-fcs/docs/customizations.html
@@ -32,36 +34,38 @@ http://jax-ws.java.net/jax-ws-20-fcs/doc
Server implementation
---------------------
-The service is implemented in the class CustomerServiceImpl. The class simply
implements
-the previously generated service interface. The method getCustomersByName
demonstrates
-what a query function could look like. The idea is to search and return all
customers
-with a given name. If the searched name is none then the method returns an
exception
-to indicate that no matching customer was found. (In a real implementation a
list with
-zero objects would probably be used. This is mainly to show how custom
exceptions can be
-created). For any other name the method will return a list of two Customer
objects. The
-number of objects can be increased to test how fast CXF works for larger data.
-
-Now that the service is implemented it needs to be made available. This
sample provides
-two options for deploying the web service provider: standalone server (using
embedded
-Jetty) or as a WAR file in Tomcat (Version 6.x or 7.x).
+The service is implemented in the class CustomerServiceImpl. The class simply
+implements the previously generated service interface. The method
+getCustomersByName demonstrates what a query function could look like. The
+idea is to search and return all customers with a given name. If the searched
+name is none then the method returns an exception to indicate that no matching
+customer was found. (In a real implementation a list with zero objects would
+probably be used. This is mainly to show how custom exceptions can be
+created). For any other name the method will return a list of two Customer
+objects. The number of objects can be increased to test how fast CXF works for
+larger data.
+
+Now that the service is implemented it needs to be made available. This sample
+provides two options for deploying the web service provider: standalone server
+(using embedded Jetty) or as a WAR file in Tomcat (Version 6.x or 7.x).
Client implementation
---------------------
-The main client code lives in the class CustomerServiceTester. This class
needs a proxy
-to the service and then demonstrates some calls and their expected outcome
using junit
-assertions.
-
-The first call is a request getCustomersByName for all customers with name
"Smith".
-The result is then checked. Then the same method is called with the invalid
name "None".
-In this case a NoSuchCustomerException is expected. The third call shows that
the one
-way method updateCustomer will return instantly even if the service needs some
time to
-process the request.
-
-The classes CustomerServiceClient and CustomerServiceSpringClient show how to
get a
-service proxy using JAX-WS or Spring and how to wire it to your business class
-(in this case CustomerServiceTester).
+The main client code lives in the class CustomerServiceTester. This class
+needs a proxy to the service and then demonstrates some calls and their
+expected outcome using junit assertions.
+
+The first call is a request getCustomersByName for all customers with name
+"Smith". The result is then checked. Then the same method is called with the
+invalid name "None". In this case a NoSuchCustomerException is expected. The
+third call shows that the one way method updateCustomer will return instantly
+even if the service needs some time to process the request.
+
+The classes CustomerServiceClient and CustomerServiceSpringClient show how to
+get a service proxy using JAX-WS or Spring and how to wire it to your business
+class (in this case CustomerServiceTester).
Prerequisite
------------
@@ -81,20 +85,23 @@ Using either UNIX or Windows:
If you're using Tomcat for the web service provider:
----------------------------------------------------
-1.) Update the soap:address value in the resources/CustomerService.wsdl value,
switching the
-soap:address value to the servlet-specific one (presently commented-out).
+1.) Update the soap:address value in the resources/CustomerService.wsdl value,
+switching the soap:address value to the servlet-specific one (presently
+commented-out).
+
+2.) You can manually copy the generated WAR file to the Tomcat webapps folder,
+or, if you have Maven and Tomcat set up to use the Tomcat Maven Plugin
+(http://mojo.codehaus.org/tomcat-maven-plugin/) you can use the
+mvn tomcat:redeploy command instead. Important: if you're using this command,
+and are using Tomcat 6 instead of Tomcat 7, update the tomcat-maven-plugin
+configuration in the pom.xml, switching to the the Tomcat 6-specific "url"
+element.
-2.) You can manually copy the generated WAR file to the Tomcat webapps folder,
or, if you
-have Maven and Tomcat set up to use the Tomcat Maven Plugin
-(http://mojo.codehaus.org/tomcat-maven-plugin/) you can use the mvn
tomcat:redeploy
-command instead. Important: if you're using this command, and are using
Tomcat 6
-instead of Tomcat 7, update the tomcat-maven-plugin configuration in the
pom.xml,
-switching to the the Tomcat 6-specific "url" element.
+To remove the code generated from the WSDL file and the .class files, run
+"mvn clean".
-To remove the code generated from the WSDL file and the .class files, run "mvn
clean".
-
-There is no special Maven profile for the spring client and server but you can
easily
-set it up yourself.
+There is no special Maven profile for the spring client and server but you can
+easily set it up yourself.
Using Eclipse to run and test the demo
--------------------------------------
@@ -102,9 +109,11 @@ Run the following in the demo base direc
mvn eclipse:eclipse
-Then use Import / Existing projects into workspace and browse to the
wsdl_first directory.
-Import the wsdl_first project.
+Then use Import / Existing projects into workspace and browse to the
+wsdl_first directory. Import the wsdl_first project.
+
+The demo can now be started using "Run as Java Application" on the
+CustomerServiceServer.java and the CustomerServiceClient. For the spring demo
+run the classes CustomerServiceSpringClient.java or
+CustomerServiceSpringServer.java
-The demo can now be started using "Run as Java Application" on the
CustomerServiceServer.java
-and the CustomerServiceClient. For the spring demo run the classes
CustomerServiceSpringClient.java
-or CustomerServiceSpringServer.java
Modified:
cxf/trunk/distribution/src/main/release/samples/wsdl_first_xmlbeans/README.txt
URL:
http://svn.apache.org/viewvc/cxf/trunk/distribution/src/main/release/samples/wsdl_first_xmlbeans/README.txt?rev=1429758&r1=1429757&r2=1429758&view=diff
==============================================================================
---
cxf/trunk/distribution/src/main/release/samples/wsdl_first_xmlbeans/README.txt
(original)
+++
cxf/trunk/distribution/src/main/release/samples/wsdl_first_xmlbeans/README.txt
Mon Jan 7 11:36:50 2013
@@ -1,8 +1,9 @@
Hello World Demo using Document/Literal Style and XMLBeans
==========================================================
-This demo illustrates the use of the JAX-WS APIs and with the XMLBeans data
binding
-to run a simple client against a standalone server using SOAP 1.1 over HTTP.
+This demo illustrates the use of the JAX-WS APIs and with the XMLBeans data
+binding to run a simple client against a standalone server using SOAP 1.1 over
+HTTP.
It also shows how CXF configuration can be used to enable schema validation
on the client and/or server side: By default the message parameters would not
@@ -10,19 +11,23 @@ be validated, but the presence of the cx
the classpath, and its content change this default behavior:
The configuration file specifies that
-a) if a JAX-WS client proxy is created for port
{http://apache.org/hello_world_soap_http}SoapPort
-it should have schema validation enabled.
-
-b) if a JAX-WS server endpoint is created for port
{http://apache.org/hello_world_soap_http}SoapPort
-it should have schema validation enabled.
+a) if a JAX-WS client proxy is created for port
+{http://apache.org/hello_world_soap_http}SoapPort it should have schema
+validation enabled.
+
+b) if a JAX-WS server endpoint is created for port
+{http://apache.org/hello_world_soap_http}SoapPort it should have schema
+validation enabled.
The client's second greetMe invocation causes an exception (a marshalling
error) on the client side, i.e. before the request with the invalid parameter
goes on the wire.
+
After commenting the definition of the <jaxws:client> element in cxf.xml you
-will notice that the client's second greetMe invocation still throws an
exception,
-but that this time the exception is caused by an unmarshalling error on the
-server side.
+will notice that the client's second greetMe invocation still throws an
+exception, but that this time the exception is caused by an unmarshalling
+error on the server side.
+
Commenting both elements, or renaming/removing the cfg.xml file, and thus
restoring the default behavior, results in the second greetMe invocation
not causing an exception.
