com.xensource.xenapi

Class SM

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.SM

public class SM
extends XenAPIObject

A storage manager plugin

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	ref The XenAPI reference to this object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToOtherConfig(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given SM.
boolean	equals(Object obj) If obj is a SM, compares XenAPI references for equality.
static Set<SM>	getAll(Connection c) Return a list of all the SMs known to the system.
static Map<SM,SM.Record>	getAllRecords(Connection c) Return a map of SM references to SM records for all SMs known to the system.
static Set<SM>	getByNameLabel(Connection c, String label) Get all the SM instances with the given label.
static SM	getByUuid(Connection c, String uuid) Get a reference to the SM instance with the specified UUID.
Set<String>	getCapabilities(Connection c) Get the capabilities field of the given SM.
Map<String,String>	getConfiguration(Connection c) Get the configuration field of the given SM.
String	getCopyright(Connection c) Get the copyright field of the given SM.
String	getDriverFilename(Connection c) Get the driver_filename field of the given SM.
String	getNameDescription(Connection c) Get the name/description field of the given SM.
String	getNameLabel(Connection c) Get the name/label field of the given SM.
Map<String,String>	getOtherConfig(Connection c) Get the other_config field of the given SM.
SM.Record	getRecord(Connection c) Get a record containing the current state of the given SM.
String	getRequiredApiVersion(Connection c) Get the required_api_version field of the given SM.
String	getType(Connection c) Get the type field of the given SM.
String	getUuid(Connection c) Get the uuid field of the given SM.
String	getVendor(Connection c) Get the vendor field of the given SM.
String	getVersion(Connection c) Get the version field of the given SM.
int	hashCode()
void	removeFromOtherConfig(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given SM.
void	setOtherConfig(Connection c, Map<String,String> otherConfig) Set the other_config field of the given SM.
String	toWireString()

Methods inherited from class java.lang.Object

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

Field Detail

ref

protected final String ref

The XenAPI reference to this object.

Method Detail

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

equals

public boolean equals(Object obj)

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

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

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

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

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

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

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

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByNameLabel

public static Set<SM> getByNameLabel(Connection c,
                     String label)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get all the SM instances with the given label.

Parameters:

label - label of object to return

Returns:

references to objects with matching names

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUuid

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

Get the uuid field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameLabel

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

Get the name/label field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameDescription

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

Get the name/description field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getType

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

Get the type field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVendor

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

Get the vendor field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCopyright

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

Get the copyright field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVersion

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

Get the version field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getRequiredApiVersion

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

Get the required_api_version field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getConfiguration

public Map<String,String> getConfiguration(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException

Get the configuration field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCapabilities

public Set<String> getCapabilities(Connection c)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Get the capabilities field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getOtherConfig

public Map<String,String> getOtherConfig(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException

Get the other_config field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getDriverFilename

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

Get the driver_filename field of the given SM.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setOtherConfig

public void setOtherConfig(Connection c,
                  Map<String,String> otherConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Set the other_config field of the given SM.

Parameters:

otherConfig - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToOtherConfig

public void addToOtherConfig(Connection c,
                    String key,
                    String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Add the given key-value pair to the other_config field of the given SM.

Parameters:

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

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

Remove the given key and its corresponding value from the other_config field of the given SM. If the key is not in that Map, then do nothing.

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static Set<SM> getAll(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

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

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static Map<SM,SM.Record> getAllRecords(Connection c)
                                       throws Types.BadServerResponse,
                                              Types.XenAPIException,
                                              org.apache.xmlrpc.XmlRpcException

Return a map of SM references to SM records for all SMs known to the system.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException