Chapter 8 Using the Sybase Web Services Client Proxy

Installing the Client Proxy

Un-jar the Client Proxy jar file (whose name is determined by the server) into a directory on the client machine. When the archive is expanded, the proxy and Webservices directories are created.

The proxy directory contains the following files:

wsclient.jar file
Proxy.html file
Server-specified impl.wsdl file
Server-specified templates xml file (optional)
ClientProxy.props file
proxyviewer.bat file
proxyviewer file
The Webservices directory contains the following directories and files:
- transport.props file
  
  The following directories are created in the Webservices directory to hold the WSDL interface file:
- work directory
  - wsdl directory
    - server-specified interface wsdl file

ClientProxy.props contains properties for the WSDL and SOAP template file names and the language values used for internationalization of the Proxy Viewer. English is the default language.
Transport.props contains a property, soap.cacerts.filename, that specifies the cacerts file - the keystore - that the Proxy uses when sending SOAP requests over HTTPS. Application developers using the Proxy should set this property to the file where they have installed the HTTPS certificates provided by the Web service provider.

For more information about the cacerts file, certificates, or Secure Socket Layers (SSL), refer to the Sun Java Secure Socket Extension API User's Guide http://java.sun.com/products/jsse/doc/guide/API_users_guide.html
wsclient.jar contains the classes that perform all the work of the client proxy.
A WSDL implementation file contains the implementation descriptions of the Web services (the file name ends with Impl.wsdl). The interface WSDL file is located in the proxy subdirectory.
A SOAP template file (optional) contains templates of the SOAP messages required to invoke the Web services described in the WSDL document.
Proxy.html contains the information in this chapter.
A viewer start-up script sets the environment and executes the Proxy Viewer application. The file name is proxyviewer for UNIX systems and proxyviewer.bat for Windows systems.

Setting environment variables and system properties for the Client Proxy

The Client Proxy jar uses the following environment variables:

JAVA_HOME - points to a Java Developer Kit 1.2.2 or later.
Classpath - for HTTPS, be sure to put the following .jar files in your classpath: jsse.jar, jcert.jar, jnet.jar, xerces.jar.

In addition to the environment variables listed above, the Java system property SYBASE_SOAP must be passed in as a jvm option:

SYBASE_SOAP points to the location where you unjar the ClientProxy.jar. This System property must be set before the SoapProxy class is instantiated. This variable may be set by using the -D flag after the Java command executing the client application, for example:-DSYBASE_SOAP=MyProxyClientLocation where MyProxyClientLocation is the path to your installed client proxy. Or, this variable may be set inside the client application code, for example: java.lang.System.setProperty ("SYBASE_SOAP", MyClientProxyLocation);. It can also be read in from a properties file or any other way you choose.

Setting environment variables and system properties for the Proxy Viewer

The Proxy Viewer uses the following environment variables and system properties:

SYBASE_SOAP - see "Setting environment variables and system properties for the Client Proxy" for a description. This System property must be set before the Proxy Viewer is executed.
JAVA_HOME - environment variable that points to a Java Developer Kit 1.2.2 or later.
PARSER_HOME - environment variable that points to your xerces.jar (Xerces 1.2 or later). This variable must be specified as a system environment variable.