com.xensource.xenapi

Class VTPM

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.VTPM

public class VTPM
extends XenAPIObject

A virtual TPM device First published in XenServer 4.0.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VTPM.Record Represents all the fields in a VTPM

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	ref The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods

Modifier and Type	Method and Description
static VTPM	create(Connection c, VTPM.Record record) Create a new VTPM instance, and return its handle.
static Task	createAsync(Connection c, VTPM.Record record) Create a new VTPM instance, and return its handle.
void	destroy(Connection c) Destroy the specified VTPM instance.
Task	destroyAsync(Connection c) Destroy the specified VTPM instance.
boolean	equals(java.lang.Object obj) If obj is a VTPM, compares XenAPI references for equality.
VM	getBackend(Connection c) Get the backend field of the given VTPM.
static VTPM	getByUuid(Connection c, java.lang.String uuid) Get a reference to the VTPM instance with the specified UUID.
VTPM.Record	getRecord(Connection c) Get a record containing the current state of the given VTPM.
java.lang.String	getUuid(Connection c) Get the uuid field of the given VTPM.
VM	getVM(Connection c) Get the VM field of the given VTPM.
int	hashCode()
java.lang.String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

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

Field Detail

ref

protected final java.lang.String ref

The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)

If obj is a VTPM, compares XenAPI references for equality.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRecord

public VTPM.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given VTPM. First published in XenServer 4.0.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static VTPM getByUuid(Connection c,
             java.lang.String uuid)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get a reference to the VTPM instance with the specified UUID. First published in XenServer 4.0.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               VTPM.Record record)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Create a new VTPM instance, and return its handle. First published in XenServer 4.0.

Parameters:

record - All constructor arguments

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static VTPM create(Connection c,
          VTPM.Record record)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Create a new VTPM instance, and return its handle. First published in XenServer 4.0.

Parameters:

record - All constructor arguments

Returns:

reference to the newly created object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Destroy the specified VTPM instance. First published in XenServer 4.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Destroy the specified VTPM instance. First published in XenServer 4.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given VTPM. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVM

public VM getVM(Connection c)
         throws Types.BadServerResponse,
                Types.XenAPIException,
                org.apache.xmlrpc.XmlRpcException

Get the VM field of the given VTPM. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getBackend

public VM getBackend(Connection c)
              throws Types.BadServerResponse,
                     Types.XenAPIException,
                     org.apache.xmlrpc.XmlRpcException

Get the backend field of the given VTPM. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException