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

This demo illustrates $SUBSTITUTE_NAME$'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, $SUBSTITUTE_NAME$ 
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
-------------

$SUBSTITUTE_PREREQ$



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

From the samples/soap_header directory, use the following commands to build and run 
the demo on 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

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

For Windows:

  mkdir build\classes
    (Use back slashes.)

  $THE_TOOL$ wsdl2java -d build\classes -compile .\wsdl\soap_header.wsdl
    (Use either forward or back slashes.)

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

For UNIX:  
  
  export CLASSPATH=$CLASSPATH:./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%;.\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 on a single 
command line:

For UNIX (use forward slashes):

    java -Djava.util.logging.config.file=$$SUBSTITUTE_HOME$/etc/logging.properties
         demo.soap_header.server.Server &

    java -Djava.util.logging.config.file=$$SUBSTITUTE_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 (use either forward or back slashes):

  start 
    java -Djava.util.logging.config.file=%$SUBSTITUTE_HOME$%\etc\logging.properties
         demo.soap_header.server.Server

    java -Djava.util.logging.config.file=%$SUBSTITUTE_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.



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

From the samples/soap_header directory, use the following command to 
create the WAR file that is deployed to the servlet container.

  ant war

Set the CATALINA_HOME environment to your Apache Tomcat home directory.
    
Deploy the web application into Tomcat with the following command:

  ant deploy -Dtomcat=true

Note: This step checks whether the $SUBSTITUTE_NAME_LOWER$ JAR files are present in Tomcat, 
      if not, it automatically copies all the JARs to CATALINA_HOME/shared/lib.

The servlet container extracts the WAR and deploys the application.

Running the client 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, for example, 8080.

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

You can omit -Dhost and -Dport if Tomcat is already running on this host and port.

Running the client using java
-----------------------------

Run the client application with the command:

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

  For Windows:

    java -Djava.util.logging.config.file=%$SUBSTITUTE_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, for example, 8080.

Undeploying the application
---------------------------

Undeploy the web application from Tomcat with the command:

   ant undeploy -Dtomcat=true
