Distribution
- Server SDK — This is a Java-based API that can be used within Java code to interact with WorldServer. There are two primary types of consumers of these APIs: WorldServer components (filters, automatic actions, etc.) that need to interact with the WorldServer system and Java-based command line tools that operate directly against WorldServer.
- SDK Components — This is a set of Java APIs that can be used to create “plug-ins” to WorldServer (filters, automatic actions, etc.). The components are uploaded into WorldServer and invoked by WorldServer.
- Client SDK — This is a set of APIs that provide access to WorldServer via Web services. SDL provides client APIs for both Java and Microsoft .NET. The APIs offered through the Client SDK are a subset of those offered through the Server SDK. These APIs are used by developers who want to interact remotely with WorldServer, potentially from an external application.
Portions of the SDK distribution mirror these high-level areas.
Installation of the WorldServer SDK
SDL provides an installation archive called wssdk_build#.zip via download. This archive contains the libraries required for creating and compiling SDK applications, Java documentation for the SDK, supplemental documentation, and sample code that illustrates how to develop WorldServer SDK applications. The archive is organized into these directories:
- doc — All of the necessary documentation for the SDK including the WorldServer SDK User Guide and the Javadoc. In the doc directory is an apidoc directory that includes the Javadoc. The Javadoc is divided into client and server subdirectories containing the documentation for each use type. The documentation for the "Server SDK" and "SDK Components" is all under the server directory while the documentation for the "Client SDK" is under the client directory.
- dotnet — All of the libraries needed to create a Microsoft .NET application that interacts with WorldServer via Web services.
- lib — All of the libraries needed to compile samples and custom applications. The lib directory is also divided into client and server subdirectories containing the libraries required by each type of consumer. The client directory can be used to build Java Web service clients. The server directory can be used to build WorldServer components or Java-based WorldServer tools. In addition, there is a misc directory that may optionally be used by other tools during the development process.
- samples — Sample applications for supported components, external access modules, and Web services.
- wsdl — The the WorldServer Services WSDL (Web Services Description Language) file. For information about using Web Services to interoperate with WorldServer, see SDK Web Services Developer Guide.
To install the SDK, simply extract the contents of the archive to the desired location. Be sure to keep the internal directory names.
Development Dependencies
The WorldServer SDK is packaged separately from the core WorldServer WAR file. This package contains all the compiled classes (wssdk-server.jar), JavaDoc generated documentation, samples of miscellaneous custom components and SDK user documentation.
The wssdk-server.jar contains all of the compile-time dependencies that you need to create your own server-side SDK applications or components. The wssdk-client.jar contains all of the compile-time dependencies that you need to create your own client-side SDK applications.
In the case of developing a server-side application or component, the developer needs access to a WorldServer installed environment to test custom implementations. Customers should consider purchasing a staging license to facilitate the development of custom components.
SDL does not distribute source code for SDK classes, but SDL does distribute source code for the sample applications and components.