User manual VMWARE VCLOUD SDK FOR JAVA 1.0 DEVELOPER S GUIDE

[. . . ] vCloud SDK for Java Developer's Guide vCloud SDK for Java 1. 0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document, see http://www. vmware. com/support/pubs. EN-000362-00 vCloud SDK for Java Developer's Guide You can find the most up-to-date technical documentation on the VMware Web site at: http://www. vmware. com/support/ The VMware Web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to: docfeedback@vmware. com Copyright © 2010 VMware, Inc. and international copyright and intellectual property laws. [. . . ] A vApp contains one or more individual virtual machines (Vm elements), along with parameters that define operational details such as: How the contained virtual machines are connected to each other and to external networks. The order in which individual virtual machines are powered on or off. Enduser license agreement terms for each virtual machine. Deployment lease terms (typically inherited from the containing organization) that constrain the vApp's consumption of vDC resources Access control information specifying which users and groups can perform operations such as deploy, power on, modify, and suspend on the vApp and the virtual machines it contains. VMware, Inc. 9 vCloud SDK for Java Developer's Guide 10 VMware, Inc. 2 Setting Up for Java Development 2 This chapter includes these topics: "Prerequisites" on page 11 "Download the vCloud SDK for Java Package" on page 11 Prerequisites The vCloud SDK for Java requires JDK 6 or later (the SDK and samples were developed using JDK 1. 6. 0_14b08). This document and the SDK reference documentation assume that you are familiar with the Java programming language and have access to an installation of VMware Cloud Director. In addition, you should consider the following: Although the vCloud SDK for Java javadoc provides information about the vCloud API XML schemas, which define the objects and operations that the SDK supports, familiarity with the details of the underlying objects and operations, as described in the vCloud API Programming Guide, can help you understand the structure of vCloud API objects, and how the methods in this SDK operate on those objects. Before you can run the samples, you must use the Cloud Director web console or the vCloud API to create an organization, catalog, and vDC that the samples can use. Import the contents of the vcloud-java-sdk-all folder into your Java IDE. About SSL Access In the default configuration, VMware Cloud Director requires vCloud API clients to use SSL. To simplify access to Cloud Director, all SDK samples use a FakeSSLSocketFactory class that allows the sample programs to accept all SSL certificates. Because clients that use the FakeSSLSocketFactory class are inherently insecure, you should restrict use of this method to sample applications, and only in trusted environments. All of the sample applications use the FakeSSLSocketFactory class. Client applications built with this SDK can enable the use of SSL certificates by either importing certificates into a keystore or implementing a custom socket factory that accepts certificates from the server. Client applications should not use the FakeSSLSocketFactory class. 12 VMware, Inc. 3 Hello vCloud: A Structured Java Workflow Example 3 This chapter presents an example of using the vCloud SDK for Java to implement a structured workflow through the lifecycle of a vApp. It contains the following topics. "Running the HellovCloud Sample" on page 13 "Logging In and Getting an Organization List" on page 14 "Getting References to the vDC and Catalog" on page 14 "Upload an OVF Package to Create a vApp Template" on page 15 "Add the vApp Template to a Catalog" on page 16 "Instantiate the vApp Template" on page 16 "Operate the vApp" on page 17 Running the HellovCloud Sample The HellovCloud. java sample, included in the samples folder of vcloud-java-sdk-samples-1. 0-sources. jar, demonstrates a number of the operations supported by the vCloud SDK for Java: Logging in to the vCloud Uploading an OVF package to create a vApp template Adding the vApp template to a catalog Instantiating the vApp template to create a vApp Operating the vApp The file HellovCloud. txt in that folder includes sample input and output. The examples shown in this section are extracted from the HellovCloud. java sample. To run the HellovCloud. java sample, use the following command line. java HellovCloud vCloudApiVersionsURL versionId user@vcloud-organization password orgName vdcName ovfFileLocation vmdkFileLocation vmdkFileName catalogName where: vCloudApiVersionsURL is the base API URL of the vCloud. versionId is the version of the API to use (always 1. 0 for this release). username is the name of a Cloud Director user, in the form user@vcloudorganization, who has rights to upload OVF, create vApp templates, create vApps, and operate vApps. password is the user's password. VMware, Inc. 13 vCloud SDK for Java Developer's Guide orgName is the name of the organization to which the user is authenticating. vdcName is the name of a vDC in that organization where the user can upload the OVF and deploy the vApp. ovfFileLocation is the full pathname to the OVF descriptor on the local disk. [. . . ] The majority of these operations return a Task object that tracks the progress of the operation. HellovCloud. java uses a number of these methods to cycle the vApp through the following states: 1 2 3 4 5 6 deploy: deploy() power on: powerOn() suspend: suspend() power off: powerOff() undeploy: undeploy() delete: delete() VMware, Inc. 17 vCloud SDK for Java Developer's Guide 18 VMware, Inc. 4 Overview of Packages and Samples 4 The vCloud SDK for Java includes sample application code and complete reference documentation on all packages, classes, and methods in the SDK. This chapter is an introductory tour of those items. Packages The SDK includes four packages that support the JAXB bindings to the vCloud API XML schemas and three packages that implement create, retrieve, update, and delete (CRUD) operations on the objects represented by those schemas. Packages in the vCloud SDK for Java Package Name com. vmware. vcloud. sdk Description Defines the classes that implement the user API. [. . . ]