WS-I Sample Application 1.0 Package
Provider |
Sun Microsystems, Inc. |
Date |
Nov 11th , 2003 |
Version |
1.0 |
Status |
The Working Group believes this Working Group Draft
to be substantively complete with regards to the technical refinements,
clarifications and constraints specified. The Working Group will be publishing
another Working Group Draft reflecting the remaining issue resolutions,
additional rationale text, and editorial changes within the next month, and
intends to pursue an aggressive schedule for completion of its work. Therefore,
the Working Group invites all parties interested in contributing to the review
and feedback process to do so based on this version so that any technical
concerns expressed can be considered by the Working Group before it concludes
its formal review period. |
Delivered as contribution to Web Services Interoperability Organization
(WS-I) under Section (2) of the WS-I IPR Agreement. Copyright © 2003 Sun
Microsystems, Inc. All Rights reserved.
Notice
The
material contained herein is not a license, either expressly or implicitly, to
any intellectual property owned or controlled by any of the authors or
developers of this material or WS-I. The material contained herein is provided
on an "AS IS" basis and to the maximum extent permitted by applicable
law, this material is provided AS IS AND WITH ALL FAULTS, and the authors and developers of this
material and WS-I hereby disclaim all other warranties and conditions, either
express, implied or statutory, including, but not limited to, any (if any)
implied warranties, duties or conditions of merchantability, of fitness for a
particular purpose, of accuracy or completeness of responses, of results, of
workmanlike effort, of lack of viruses, and of lack of negligence. ALSO, THERE
IS NO WARRANTY OR CONDITION OF TITLE, QUIET ENJOYMENT, QUIET POSSESSION, CORRESPONDENCE
TO DESCRIPTION OR NON-INFRINGEMENT WITH REGARD TO THIS MATERIAL.
IN
NO EVENT WILL ANY AUTHOR OR DEVELOPER OF THIS MATERIAL OR WS-I BE LIABLE TO ANY
OTHER PARTY FOR THE COST OF PROCURING SUBSTITUTE
GOODS OR SERVICES, LOST PROFITS, LOSS OF USE, LOSS OF DATA, OR ANY INCIDENTAL,
CONSEQUENTIAL, DIRECT, INDIRECT, OR SPECIAL DAMAGES WHETHER UNDER CONTRACT,
TORT, WARRANTY, OR OTHERWISE, ARISING IN ANY WAY OUT OF THIS OR ANY OTHER
AGREEMENT RELATING TO THIS MATERIAL, WHETHER OR NOT SUCH PARTY HAD ADVANCE
NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.
1.0 Pre-Requisites
WS-I Sample Application from Sun Microsystems, Inc. is developed and deployed
on JavaTM Web Services Developer Pack 1.2, hence forth referred as
Java WSDP. It uses Java 2 Standard Edition 1.4.1 as the Java platform. Pointbase
database server is used for data storage and retrieval. Please download all these
software before proceeding ahead.
- Java Web Sevices Developer Pack 1.2
- Java WSDP is an integrated toolset that in conjunction with the Java platform allows Java developers to build, test and deploy XML applications, Web services, and Web applications. The Java WSDP provides Java standard implementations of existing key Web services standards including WSDL, SOAP, ebXML, and UDDI as well as important Java standard implementations for Web application development such as JavaServer
PagesTM (JSPTM pages) and the JSP Standard Tag Library.
- WS-I sample app can be run on all platforms supported by
Java WSDP 1.2.
- Java 2 Standard Edition
1.4.1
- The Java 2 Platform, Standard Edition is at the core of Java technology, and version 1.4.x raises the Java platform to a higher standard. From client to server, from desktop to supercomputer, improvements have been made to
J2SETM across the board. With version 1.4.x, enterprises can now use Java technology to develop more demanding business applications with less effort and in less time.
- Pointbase database
- An evaluation version of Pointbase database can be downloaded from www.pointbase.com.
All the latest source code, binaries and instructions are also available as
part of Java WSDP download.
2.0 Pre-Install Instructions
3.0 Install Instructions
- Install the Java 2 Standard Edition 1.4.x
- If you are installing on Solaris Sparc or Solaris X86, please refer to
the download page mentioned above for the requisite patches that are
required before the installation.
- Install the Java Web Services Developer Pack 1.2
- Installation instructions for various platforms are available here.
For reference purposes, lets say Java WSDP 1.2 is installed in
${JWSDP_HOME} directory.
- Install the Pointbase database server
- Installation instructions for Pointbase database server are available
with the downloaded Pointbase server.
4.0 Post-Install Instructions
- Database configuration
- Please refer to ${JWSDP_HOME}/wsi-sampleapp/docs/index.html, section
3.0 for database configuration instructions.
- Once the database is running, you need to create a database with the URL "jdbc:pointbase://localhost/wsi" by invoking startconsole.[sh | bat] script bundled with pointbase release.
Note: At the time of JWSDP 1.2 release going public, pointbase 4.5 was the latest version available on www.pointbase.com. Instructions may differ for a later pointbase release.
If the version of Pointbase server is other than 4.5, then you need to
replace the pointbase client library bundled with
${JWSDP_HOME}/wsi-sampleapp/wsi-server.war [WEB-INF/lib/pbclient.jar] to
match your pointbase server.
- Configuring logging in Java WSDP container
- Please refer to ${JWSDP_HOME}/wsi-sampleapp/docs/index.html, section
6.0 for logging configuration instructions.
5.0 Install Verification Instructions
- To verify Java platform is correctly installed
- Go to ${JAVA_HOME}/bin and give the command "java -version".
It should correctly show the version of the Java platform that has been
installed.
- To verify Java WSDP 1.2 is correctly installed
- Go to ${JWSDP_HOME}/bin directory and give the following command
- Solaris or Linux: "
startup.sh
"
- Windows: "
startup.bat
"
- Wait for sometime and open a new browser window on the same machine
- Type the URL "http://localhost:8080/index.html".
If you are able to view the web page correctly, that verifies the
correct installation of Java WSDP 1.2.
- To verify that the sample app is correctly installed, the following URLs
should be correctly viewable in the browser (if the sample app is installed on
host "localhost" and port "8080")
6.0 Run Instructions
6.1 Build Instructions
- Client
- Go to src directory and invoke
ant client
command. This will
overwrite the existing wsi-client.jar in JWSDP_HOME/wsi-sampleapp/lib directory
- Follow the instructions in 4.0 to run the client
- Server
- Go to src directory and invoke
ant
server
command. This will overwrite the existing wsi-server.war in JWSDP_HOME/wsi-sampleapp
directory.
- You need to (re)start Java WSDP container explicitly.
6.2 Configure Logging
The Java WSDP supports the Jakarta Commons Logging API.
By default, the sample app in the Java WSDP has it's logging level set
to "info". The following levels are available, in ascending order
of granularity
- fatal
- error
- warn
- info
- debug
- trace
You can change the default level of logging for the sample app on the client and server side as follows:
- Server-side logging: To change the default logging level on server-side to
a different level, you need to set the following property:
CATALINA_OPTS="-Dorg.apache.commons.logging.log=org.apache.commons.logging.log.SimpleLog
-Dorg.apache.commons.logging.simplelog.log.com.sun.wsi.scm=<LEVEL>"
where LEVEL is one of the six logging levels mentioned above.
- Client-side logging: To change the default logging level on
client-side to a different level, specify the following properties when
invoking the scripts
-Dclient.logger.level=<LEVEL>
where LEVEL is one of the six logging levels mentioned above.
6.3 Trouble Shooting
- All the endpoints are configured in etc/endpoints.props file. The
default endpoints are configured for host "localhost" and port
"8080". If your application is deployed at a different port, then
please ensure that these are reflected correctly in etc/endpoints.props.
- If your Retailer endpoint is outside the firewall, you need to change
your_proxy_host
and your_proxy_port
in etc/wsi.props to the proxy host and port entries so that they
specify the system on your network through which you access the
Internet.
- Order configurations are specified in etc/order-config.xml. You can
specify endpoints from multiple vendors in etc/endpoints.props and then mix
and match the various endpoints in this file.
- Default logging level is "info". You can set the logging to a
higher level such as "debug" or "trace" to view the
debug and SOAP messages. Refer to section 6.2 above for more details.
- Service invocation results are generated in logs/order-results.xml.
You can apply the stylesheet etc/order-results.xsl to generate an HTML report. An
ant target (results) is provided in build.xml to generate such a report.
- If you are not using Ant provided with JWSDP, then you need to explicitly
set jwsdp.home property in src/build.xml referring to the location of JWSDP
installation directory.
run-query.
[sh
| bat
] uses the default Configurator web service bundled
with JWSDP. If you need to use another Configurator web service, you need to
specify the following argument when invoking the script
-Dconfigurator.endpoint=<ANOTHER_CONFIGURATOR_ENDPOINT>
- Retailer client invokes getCatalog and places all the pre-defined orders
to the Retailer web service by default. To override the default and place
only a specific order, you need to specify -Dretailer.orders=<ORDERS_VALUE>
where ORDERS_VALUE can be either "all" or a combination of 1, 2, 3, 4, 5, 6,7 separated
through commas. ORDERS_VALULE=7 corresponds to invoking getCatalog.
- To view the SOAP request and response messages, turn the logging level to
trace. Refer to section 6.2 on how to configure logging. Retailer client
SOAP request and response messages are available in logs/retailer-soap-messages.txt and
logs/logging-soap-messages.txt. Server-side log messages are available in
standard JWSDP_HOME/logs.
7.0 Example Test Results
7.1 Functional test results
Functional test results are available in results/functional directory.
7.2 Conformance test results
Conformance test results are available in results/compliance directory.
7.3 Interop test results
Interop test results are available in results/interop directory.
Last updated: 11 November, 2003 02:14 PM