VMware vSphere Web Services SDK: JAX-WS Samples Readme

  VMware vSphere Web Services SDK Readme

This document describes the vSphere Web Services SDK samples that use the JAX-WS bindings for the vSphere API. The examples have been developed to work with the JAX-WS bundled with the JDK 1.8.

• Sample Directories
• Sample Program Structure
• Building the Sample Programs
• Running the Sample Programs
• Sample Documentation

Sample Directories

The vSphere Web Services SDK samples are located in sub-directories in the following vSphere Management SDK directory:

The sample sub-directories are organized into the following capabilities:

Sample Program Structure

Every vCenter client application performs the following basic tasks:

• Authenticating and connecting to a vCenter Server to establish a session.
• Obtaining access to vSphere methods.
• Using the methods to perform vSphere operations.

The samples use custom Java annotations to organize these tasks. These annotations are @Before, @Action, and @After. The SDK sample code includes a samples framework that runs the samples and executes the sample code.

• Each sample extends the class ConnectedVimServiceBase (.../SDK/vsphere-ws/java/JAXWS/samples/com/vmware/connection/ConnectedVimServiceBase.java). This class contains the @Before and @After declarations. The @Before code performs authentication, connects to the vCenter Server, and obtains access to the vSphere methods. The @After code disconnects from the Server.
  
  
• Authentication and connection are handled in the connection sample implementation. For example, SsoConnection.java contains the SSO connection implementation. It obtains an SSO token for vCenter login, and it obtains access to the vSphere API methods.

  The SSO connection implementation uses the VMware Single Sign On sample code that is contained in the vSphere Management SDK (.../SDK/ssoclient/). See the VMware Single Sign On Programming Guide.

• Each sample file contains the @Action declaration, which contains the code that performs the capability of the particular sample.

  For example, the GetCurrentTime sample contains the @Action code - a call to the CurrentTime method. GetCurrentTime.java is located in the general directory (.../SDK/vsphere-ws/java/JAXWS/samples/com/vmware/general/).

  public class GetCurrentTime extends ConnectedVimServiceBase {
    @Action
    public void getCurrentTime() throws RuntimeFaultFaultMsg {
        XMLGregorianCalendar ct = vimPort.currentTime(this.getServiceInstanceReference());
        SimpleDateFormat sdf =
                new SimpleDateFormat("yyyy-MM-dd 'T' HH:mm:ss.SSSZ");
        System.out.println("Server current time: "
                + sdf.format(ct.toGregorianCalendar().getTime()));
    }
}

  The GetCurrentTime class extends the ConnectedVimServiceBase class and inherits its connection capability. When the GetCurrentTime sample executes, the sample framework performs the following:

  • Executes the ConnectedVimServiceBase @Before code to establish the connection. This code also retrieves the vimPort object for access to vSphere API methods.
  • Executes the GetCurrentTime @Action code to retrieve and display the current time.
  • Executes the ConnectedVimServiceBase @After code to close the connection.

Building the Sample Programs

To build the sample programs, you must define the JAVA_HOME environment variable and execute one of the build scripts to generate client stubs and compile the samples.

    .../SDK/vsphere-ws/java/JAXWS/samples.properties

You can specify the vCenter Server URL, username and password in the sample.properties file, or you can specify them on the command line when you execute a sample program. These properties are declared as input options, using the @Option declarations and implementation in the following files:

    /SDK/vsphere-ws/java/JAXWS/samples/com/vmware/connection/Connection.java
    /SDK/vsphere-ws/java/JAXWS/samples/com/vmware/connection/SsoConnection.java


When you execute a sample, the samples framework will resolve the input values from the appropriate source.

Samples Documentation

To print help about a sample, specify --help on the command line.

You can also find information about the samples in the JAX-WS Samples Reference Documentation. Each package has a class summary that describes one or more samples.