Getting Started with Java

September 6, 2024

Contributed by:

X X

The XenServer-SDK directory contains the following folders that are relevant to Java programmers:

XenServerJava: The XenServer SDK for Java
- xen-api-x.y.z.jar: Java archive file containing the compiled library.
- xen-api-x.y.z-javadoc.jar: Java archive file containing the documentation.
- xen-api-x.y.z-sources.jar: Java archive file containing the source code as a Maven project. Every API object is associated with one Java file. For example the functions implementing the VM operations are contained within the file VM.java.

RPC protocol

The Java SDK supports the JSON-RPC v2.0 protocol.

Platform supported

Linux
Windows

Library

The library is a Java archive file xenserver.jar that is linked by Java programs.

Note:

This library is generally, but not fully, backwards compatible. To interact with hosts running older versions of XenServer or Citrix Hypervisor, it is advisable to use the library of the same version as the host.

Dependencies

XenServerJava is dependent upon the JSON library by the Jackson project and the Apache HttpClient by the Apache Software Foundation.

Examples

Examples on the usage of the Java SDK can be found at XenServerJava usage examples on GitHub.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Getting Started with Java

September 6, 2024

Contributed by:

X X

September 6, 2024

Contributed by:

X X

Getting Started with Java

RPC protocol

Platform supported

Library

Dependencies

Examples

In this article