The SSC Client Library for Java

Client Library Classes

The client library provides proxy classes for accessing the web services described previously. These are:

These classes implement a one-to-one mapping of methods and parameters with their corresponding web service methods. There is one important exception to this.

ComponentExecutor.Execute

The client implementation of the ComponentExecutor service provides an alternative implementation of the Execute method with the following signature:

void Execute(
     String authentication,
     String licensing,
     String component, 
     String method,
     String group,
     Reader payload,
     Writer response 
 )

This method allows the input payload and the response payload to be streamed to/from the SunSystems Connect server. This allows very large payloads to be handled with a minimal impact on the memory requirements of the overall system.

A side effect of streaming the payloads is that the server starts executing the payload before it has received a complete SOAP packet. It is not advisable to use this method where the payload and/or network integrity cannot be guaranteed.

The default method is also provided. For example,

String Execute(
     String authentication,
     String licensing,
     String component,
     String method,
     String group,
     String payload
 )
 

Using the Client Library

The client library is called connect-client.jar and installed in the <install_folder>\ssc\lib folder (where <install_folder> is the folder where SunSystems was installed). In order to use the client library you must also use another file. This is xercesimpl.jar which is also installed in the <install_folder>\ssc\lib folder.

Both of these files must be added to the classpath of the application wanting to use the client library. A typical command line for an application would be as follows:

java cp yourapp.jar; \
     <install_folder>\ssc\lib\connect-client.jar; \
     <install_folder>\ssc\lib\xercesimpl.jar \
     com.yourcompany.yourapp.ApplicationEntryPoint

It is better to point the classpath to the install directory rather than move the files to another location. This keeps the files in step with any changes made during upgrades to the system.