com.xensource.xenapi

Class Blob

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.Blob

public class Blob
extends XenAPIObject

A placeholder for a binary blob First published in XenServer 5.0.

Nested Class Summary

Nested Classes

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

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 Blob	create(Connection c, java.lang.String mimeType) Create a placeholder for a binary blob First published in XenServer 5.0.
static Blob	create(Connection c, java.lang.String mimeType, java.lang.Boolean _public) Create a placeholder for a binary blob First published in XenServer 5.0.
void	destroy(Connection c) First published in XenServer 5.0.
boolean	equals(java.lang.Object obj) If obj is a Blob, compares XenAPI references for equality.
static java.util.Set<Blob>	getAll(Connection c) Return a list of all the blobs known to the system.
static java.util.Map<Blob,Blob.Record>	getAllRecords(Connection c) Return a map of blob references to blob records for all blobs known to the system.
static java.util.Set<Blob>	getByNameLabel(Connection c, java.lang.String label) Get all the blob instances with the given label.
static Blob	getByUuid(Connection c, java.lang.String uuid) Get a reference to the blob instance with the specified UUID.
java.util.Date	getLastUpdated(Connection c) Get the last_updated field of the given blob.
java.lang.String	getMimeType(Connection c) Get the mime_type field of the given blob.
java.lang.String	getNameDescription(Connection c) Get the name/description field of the given blob.
java.lang.String	getNameLabel(Connection c) Get the name/label field of the given blob.
java.lang.Boolean	getPublic(Connection c) Get the public field of the given blob.
Blob.Record	getRecord(Connection c) Get a record containing the current state of the given blob.
java.lang.Long	getSize(Connection c) Get the size field of the given blob.
java.lang.String	getUuid(Connection c) Get the uuid field of the given blob.
int	hashCode()
void	setNameDescription(Connection c, java.lang.String description) Set the name/description field of the given blob.
void	setNameLabel(Connection c, java.lang.String label) Set the name/label field of the given blob.
void	setPublic(Connection c, java.lang.Boolean _public) Set the public field of the given blob.
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 Blob, 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 Blob.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given blob. First published in XenServer 5.0.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

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

Get a reference to the blob instance with the specified UUID. First published in XenServer 5.0.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByNameLabel

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

Get all the blob instances with the given label. First published in XenServer 5.0.

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 java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given blob. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameLabel

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

Get the name/label field of the given blob. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameDescription

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

Get the name/description field of the given blob. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSize

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

Get the size field of the given blob. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPublic

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

Get the public field of the given blob. First published in XenServer 6.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getLastUpdated

public java.util.Date getLastUpdated(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the last_updated field of the given blob. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getMimeType

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

Get the mime_type field of the given blob. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameLabel

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

Set the name/label field of the given blob. First published in XenServer 5.0.

Parameters:

label - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameDescription

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

Set the name/description field of the given blob. First published in XenServer 5.0.

Parameters:

description - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setPublic

public void setPublic(Connection c,
             java.lang.Boolean _public)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException

Set the public field of the given blob. First published in XenServer 6.1.

Parameters:

_public - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static Blob create(Connection c,
          java.lang.String mimeType)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Create a placeholder for a binary blob First published in XenServer 5.0.

Parameters:

mimeType - The mime-type of the blob. Defaults to 'application/octet-stream' if the empty string is supplied

Returns:

The reference to the created blob

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static Blob create(Connection c,
          java.lang.String mimeType,
          java.lang.Boolean _public)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Create a placeholder for a binary blob First published in XenServer 5.0.

Parameters:

mimeType - The mime-type of the blob. Defaults to 'application/octet-stream' if the empty string is supplied

_public - True if the blob should be publicly available First published in XenServer 6.1.

Returns:

The reference to the created blob

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroy

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

First published in XenServer 5.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

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

Return a list of all the blobs known to the system. First published in XenServer 5.0.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

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

Return a map of blob references to blob records for all blobs known to the system. First published in XenServer 5.0.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException