org.opennebula.client (OpenNebula Cloud API)
Description: declaration: package: org.opennebula.client

# Package org.opennebula.client

package org.opennebula.client

Provides the Java bindings for the OpenNebula Cloud API (OCA).

The included classes can be used as simple wrappers for the XML-RPC calls supported by the OpenNebula core, or as objects that store the information and provide useful helpers.

## Requirements

Apart from this jar file, you need to add to the project's build-path the Apache XML-RPC library.

You can download it from Apache's distribution directory. The jar files you need are xmlrpc-client-*.jar, ws-commons-util-*.jar and xmlrpc-common-*.jar.

## Related Documentation

Please visit the OpenNebula site for general information, and consult the documentation section to find up to date references, tutorials, and more.

You can learn about the OpenNebula XML-RPC API here.

- Class
  Description
  Client
  This class represents the connection with the core and handles the xml-rpc calls.
  ClientConfigurationException
  This exception is thrown when a a new Client is constructed with wrong authorization options.
  OneException
  The `OneException` class is a generic OpenNebula exception.
  OneResponse
  This class encapsulates OpenNebula's XML-RPC responses.
  OneSystem
  Pool
  Represents a generic OpenNebula Pool in XML format and provides the basic functionality to handle the Pool elements.
  PoolElement
  Represents a generic element of a Pool in XML format.