Documentation Center

Targets for building and running toolkit samples

A description of the targets included in the samples\build.xml script that generate, build, deploy, and run the toolkit web service.

TargetDescription
build.webservice.toolkit

Builds the original SDK application and generates the toolkit web service. Generates a .wsdl file from Tookit.java. Generates a Java service and client stubs from the .wsdl file. Builds the toolkit Java service, the client stubs, and the test application.

The resulting package, samples\dist\ToolkitWebServiceServer.zip, contains all the server classes required to deploy the web services on the application server.

run.app.toolkitRuns the original SDK application and verifies its intended server-side stand-alone functionality without involving any web services.
deploy.webservice.toolkit

Deploys the toolkit web service on the application server.

Before you run this target:
  • Make sure that the application server is running.
  • Make sure that you configured the WS_HOME environment variable.
  • Make sure that the application server context can reload the newly built web service server .jar files during deployment. Otherwise, you have to restart your application server after running this target.
  • Specify values for the ws.host and ws.context parameters to customize the WorldServer URL.
run.webservice.toolkit

Runs the Java toolkit web client application and verifies that its client-side functionality is identical to the server-side SDK functionality.

Before you run this target:
  • Make sure that you configured the WS_HOME environment variable.
  • Specify values for the ws.host and ws.context parameters to customize the WorldServer URL.

To run the Java web client application, you must specify the WorldServer Axis servlet URL. This is the web service equivalent of a user entering the WorldServer URL in a browser's address bar to start a WorldServer session on the application server.

build.dotnet.webservice.toolkit and run.dotnet.webservice.toolkit (.NET web service build and run targets)

Builds and runs the .NET toolkit web client application and verifies that its client-side functionality is identical to the server-side SDK functionality.

To build and run the Windows .NET web client samples, you must download the Microsoft .NET Framework SDK version 4.5.2 and the Microsoft .NET Framework version 4.5.2 Redistributable Package. Then, configure your shell by running, for example, c:\Program Files\Microsoft.NET\SDK\v4.5.2\Bin\sdkvars.

The build.dotnet.webservice.toolkit and run.dotnet.webservice.toolkit ANT targets are also available to build and run the .NET web client proxy and tests.

To build the .NET web client, run the following command: samples> ant build.dotnet.webservices.samples

As with the Java web client, to run the .NET web client application, you must specify the WorldServer Axis servlet URL.

Example: Java web client

Using the run.webservice.toolkit target, specify values for the ws.host and ws.context parameters to customize the WorldServer Axis servlet URL:
samples> ant -Dws.host=<ws-host>:<port> -Dws.context=ws-legacy run.webservice.toolkit
If you are not using the run.webservice.toolkit target, you need to specify the WorldServer Axis servlet URL, as shown in the following example:
toolkit>java -Dws.url=http://<ws-host>:<port>/ws-legacy/services com.idiominc.wssdk.samples.component.webservices.toolkit.test.ToolkitTest

Example: .NET web client

Using the run.dotnet.webservice.toolkit target, specify values for the ws.host and ws.context parameters to customize the WorldServer Axis servlet URL:
samples> ant -Dws.host=<ws-host>:<port> -Dws.context=ws-legacy run.dotnet.webservice.toolkit
If you are not using the run.dotnet.webservice.toolkit target, you must specify the WorldServer Axis servlet URL, as shown in the following example:
cd src/com/idiominc/wssdk/samples/component/webservices/toolkit
toolkit>set WS_URL=http://<ws-host>:<port>/ws-legacy/services
toolkit> dist\Toolkit.exe