SOAP Headers
============

This demo illustrates Apache CXF's support for SOAP headers.  In the
WSDL file, the SOAP header is included as an additional part within
the message and binding definitions.  Using this approach to defining a
SOAP header, Apache CXF treats the header content as another parameter
to the operation.  Consequently, the header content is simply
manipulated within the method body.

The client application creates the header content, which is simply
a string value.  The server application views the supplied values
and may set these values into the operation's return values or
out/inout headers.

Please review the README in the samples directory before
continuing.



Prerequisites
-------------

If your environment already includes cxf.jar on the
CLASSPATH, and the JDK and ant bin directories on the PATH
it is not necessary to set the environment as described in
the samples directory's README.  If your environment is not
properly configured, or if you are planning on using wsdl2java,
javac, and java to build and run the demos, you must set the
environment.



Building and running the demo using ant
---------------------------------------

From the samples/soap_header directory, the ant build script
can be used to build and run the demo.

Using either UNIX or Windows:

  ant build
  ant server 
  ant client
    

To remove the code generated from the WSDL file and the .class
files, run:

  ant clean



Building the demo using wsdl2java and javac
------------------------------------------

From the samples/soap_header directory, first create the target
directory build/classes and then generate code from the WSDL file.

For UNIX:
  mkdir -p build/classes

  wsdl2java -d build/classes -compile ./wsdl/soap_header.wsdl

For Windows:
  mkdir build\classes
    Must use back slashes.

  wsdl2java -d build\classes -compile .\wsdl\soap_header.wsdl
    May use either forward or back slashes.

Now compile the provided client and server applications with the commands:

For UNIX:  
  
  export CLASSPATH=$CLASSPATH:$CXF_HOME/lib/cxf.jar:./build/classes
  javac -d build/classes src/demo/soap_header/client/*.java
  javac -d build/classes src/demo/soap_header/server/*.java

For Windows:
  set classpath=%classpath%;%CXF_HOME%\lib\cxf.jar;.\build\classes
  javac -d build\classes src\demo\soap_header\client\*.java
  javac -d build\classes src\demo\soap_header\server\*.java

Running the demo using java
---------------------------

From the samples/soap_header directory run the following commands.
They are entered on a single command line:

For UNIX (must use forward slashes):
    java -Djava.util.logging.config.file=$CXF_HOME/etc/logging.properties
         demo.soap_header.server.Server &

    java -Djava.util.logging.config.file=$CXF_HOME/etc/logging.properties
         demo.soap_header.client.Client ./wsdl/soap_header.wsdl

The server process starts in the background.  After running the client,
use the kill command to terminate the server process.

For Windows (may use either forward or back slashes):
  start 
    java -Djava.util.logging.config.file=%CXF_HOME%\etc\logging.properties
         demo.soap_header.server.Server

    java -Djava.util.logging.config.file=%CXF_HOME%\etc\logging.properties
       demo.soap_header.client.Client .\wsdl\soap_header.wsdl

A new command windows opens for the server process.  After running the
client, terminate the server process by issuing Ctrl-C in its command window.

To remove the code generated from the WSDL file and the .class
files, either delete the build directory and its contents or run:

  ant clean



Building and running the demo in a servlet container
----------------------------------------------------

From the samples/soap_header directory, the ant build script
can be used to create the war file that is deployed into the
servlet container.

Build the war file with the command:

  ant war

Preparing deploy to APACHE TOMCAT

* set CATALINA_HOME environment to your TOMCAT home directory
    
Deploy the war file into APACHE TOMCAT with the commond:
[NOTE] This step will check if the cxf jars present in Tomcat, 
       if not, it will automatically copy all the jars into CATALINA_HOME/shared/lib
  
  ant deploy -Dtomcat=true

The servlet container will extract the war and deploy the application.


Using ant, run the client application with the command:

  ant client-servlet -Dbase.url=http://localhost:#

Where # is the TCP/IP port used by the servlet container,
e.g., 8080.

Or
  ant client-servlet -Dhost=localhost -Dport=8080

You can ignore the -Dhost and -Dport if your tomcat setup is same, i.e ant client-servlet

Using java, run the client application with the command:

  For UNIX:
    
    java -Djava.util.logging.config.file=$CXF_HOME/etc/logging.properties
         demo.soap_header.client.Client http://localhost:#/soapheader/services/soap_header?wsdl

  For Windows:

    java -Djava.util.logging.config.file=%CXF_HOME%\etc\logging.properties
       demo.soap_header.client.Client http://localhost:#/soapheader/services/soap_header?wsdl

Where # is the TCP/IP port used by the servlet container,
e.g., 8080.

Undeploy the application from the APACHE TOMCAT with the command:

   ant undeploy -Dtomcat=true