com.xensource.xenapi
Class Debug

java.lang.Object
  com.xensource.xenapi.Debug

public class Debug
extends Object

A basic class for testing

Nested Class Summary

static class

Debug.Record Represents all the fields in a Debug

Field Summary

protected String

ref The XenAPI reference to this object.

Method Summary

static Debug	create(Debug.Record record) Create a new debug instance, and return its handle.
void	destroy() Destroy the specified debug instance.
static Set<Debug>	getAll() Return a list of all the debugs known to the system.
static Map<Debug,Debug.Record>	getAllRecords() Get all the Debug Records at once, in a single XML RPC call
static Debug	getByUuid(String uuid) Get a reference to the debug instance with the specified UUID.
protected static Debug	getInstFromRef(String ref)
Debug.Record	getRecord() Get a record containing the current state of the given debug.
static void	returnFailure() Return an API 'successful' failure

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ref

protected final String ref

The XenAPI reference to this object.

Method Detail

getInstFromRef

protected static Debug getInstFromRef(String ref)

getRecord

public Debug.Record getRecord()
                       throws Types.BadServerResponse,
                              ConnectionHelper.NoConnectionOnThisThreadException,
                              XmlRpcException

Get a record containing the current state of the given debug.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getByUuid

public static Debug getByUuid(String uuid)
                       throws Types.BadServerResponse,
                              ConnectionHelper.NoConnectionOnThisThreadException,
                              XmlRpcException

Get a reference to the debug instance with the specified UUID.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

create

public static Debug create(Debug.Record record)
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Create a new debug instance, and return its handle.

Parameters:

record - All constructor arguments

Returns:

reference to the newly created object

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

destroy

public void destroy()
             throws Types.BadServerResponse,
                    ConnectionHelper.NoConnectionOnThisThreadException,
                    XmlRpcException

Destroy the specified debug instance.

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

returnFailure

public static void returnFailure()
                          throws Types.BadServerResponse,
                                 ConnectionHelper.NoConnectionOnThisThreadException,
                                 XmlRpcException

Return an API 'successful' failure

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getAll

public static Set<Debug> getAll()
                         throws Types.BadServerResponse,
                                ConnectionHelper.NoConnectionOnThisThreadException,
                                XmlRpcException

Return a list of all the debugs known to the system.

Returns:

references to all objects

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getAllRecords

public static Map<Debug,Debug.Record> getAllRecords()
                                             throws Types.BadServerResponse,
                                                    ConnectionHelper.NoConnectionOnThisThreadException,
                                                    XmlRpcException

Get all the Debug Records at once, in a single XML RPC call

Returns:

A map from Debug to Debug.Record

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException