com.xensource.xenapi
Class VTPM

java.lang.Object
  com.xensource.xenapi.VTPM

public class VTPM
extends Object

A virtual TPM device

Nested Class Summary

static class

VTPM.Record Represents all the fields in a VTPM

Field Summary

protected String

ref The XenAPI reference to this object.

Method Summary

static VTPM	create(VTPM.Record record) Create a new VTPM instance, and return its handle.
void	destroy() Destroy the specified VTPM instance.
static Map<VTPM,VTPM.Record>	getAllRecords() Get all the VTPM Records at once, in a single XML RPC call
VM	getBackend() Get the backend field of the given VTPM.
static VTPM	getByUuid(String uuid) Get a reference to the VTPM instance with the specified UUID.
protected static VTPM	getInstFromRef(String ref)
VTPM.Record	getRecord() Get a record containing the current state of the given VTPM.
String	getUuid() Get the uuid field of the given VTPM.
VM	getVM() Get the VM field of the given VTPM.

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 VTPM getInstFromRef(String ref)

getRecord

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

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

Returns:

all fields from the object

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getByUuid

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

Get a reference to the VTPM 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 VTPM create(VTPM.Record record)
                   throws Types.BadServerResponse,
                          ConnectionHelper.NoConnectionOnThisThreadException,
                          XmlRpcException

Create a new VTPM 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 VTPM instance.

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getUuid

public String getUuid()
               throws Types.BadServerResponse,
                      ConnectionHelper.NoConnectionOnThisThreadException,
                      XmlRpcException

Get the uuid field of the given VTPM.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getVM

public VM getVM()
         throws Types.BadServerResponse,
                ConnectionHelper.NoConnectionOnThisThreadException,
                XmlRpcException

Get the VM field of the given VTPM.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getBackend

public VM getBackend()
              throws Types.BadServerResponse,
                     ConnectionHelper.NoConnectionOnThisThreadException,
                     XmlRpcException

Get the backend field of the given VTPM.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getAllRecords

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

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

Returns:

A map from VTPM to VTPM.Record

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException