Package com.xensource.xenapi

Class Repository

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.Repository

public class Repository
extends XenAPIObject

Repository for updates First published in 1.301.0.

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Repository(String ref)	Creates an object from a given XenAPI reference (OpaqueRef)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	If obj is a Repository, compares XenAPI references for equality.
void	forget(Connection c)	Remove the repository record from the database Minimum allowed role: pool-operator First published in 1.301.0.
Task	forgetAsync(Connection c)	Remove the repository record from the database Minimum allowed role: pool-operator First published in 1.301.0.
static Set<Repository>	getAll(Connection c)	Return a list of all the Repositorys known to the system.
static Map<Repository,Repository.Record>	getAllRecords(Connection c)	Return a map of Repository references to Repository records for all Repositorys known to the system.
String	getBinaryUrl(Connection c)	Get the binary_url field of the given Repository.
static Set<Repository>	getByNameLabel(Connection c, String label)	Get all the Repository instances with the given label.
static Repository	getByUuid(Connection c, String uuid)	Get a reference to the Repository instance with the specified UUID.
String	getCertificate(Connection c)	Get the certificate field of the given Repository.
String	getGpgkeyPath(Connection c)	Get the gpgkey_path field of the given Repository.
String	getHash(Connection c)	Get the hash field of the given Repository.
String	getNameDescription(Connection c)	Get the name/description field of the given Repository.
String	getNameLabel(Connection c)	Get the name/label field of the given Repository.
Types.Origin	getOrigin(Connection c)	Get the origin field of the given Repository.
Repository.Record	getRecord(Connection c)	Get a record containing the current state of the given Repository.
String	getSourceUrl(Connection c)	Get the source_url field of the given Repository.
Boolean	getUpdate(Connection c)	Get the update field of the given Repository.
Boolean	getUpToDate(Connection c)	Deprecated. since 23.18.0
String	getUuid(Connection c)	Get the uuid field of the given Repository.
int	hashCode()
static Repository	introduce(Connection c, String nameLabel, String nameDescription, String binaryUrl, String sourceUrl, Boolean update, String gpgkeyPath)	Add the configuration for a new remote repository Minimum allowed role: pool-operator First published in 1.301.0.
static Task	introduceAsync(Connection c, String nameLabel, String nameDescription, String binaryUrl, String sourceUrl, Boolean update, String gpgkeyPath)	Add the configuration for a new remote repository Minimum allowed role: pool-operator First published in 1.301.0.
static Repository	introduceBundle(Connection c, String nameLabel, String nameDescription)	Add the configuration for a new bundle repository Minimum allowed role: pool-operator Experimental.
static Task	introduceBundleAsync(Connection c, String nameLabel, String nameDescription)	Add the configuration for a new bundle repository Minimum allowed role: pool-operator Experimental.
static Repository	introduceRemotePool(Connection c, String nameLabel, String nameDescription, String binaryUrl, String certificate)	Add the configuration for a new remote pool repository Minimum allowed role: pool-operator Experimental.
static Task	introduceRemotePoolAsync(Connection c, String nameLabel, String nameDescription, String binaryUrl, String certificate)	Add the configuration for a new remote pool repository Minimum allowed role: pool-operator Experimental.
void	setGpgkeyPath(Connection c, String value)	Set the file name of the GPG public key of the repository Minimum allowed role: pool-operator Experimental.
Task	setGpgkeyPathAsync(Connection c, String value)	Set the file name of the GPG public key of the repository Minimum allowed role: pool-operator Experimental.
void	setNameDescription(Connection c, String description)	Set the name/description field of the given Repository.
void	setNameLabel(Connection c, String label)	Set the name/label field of the given Repository.
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 Details

ref

protected final String ref

The XenAPI reference (OpaqueRef) to this object.

Constructor Details

Repository

public Repository(String ref)

Creates an object from a given XenAPI reference (OpaqueRef)

Parameters:

ref - The OpaqueRef from which to create the object.

Method Details

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(Object obj)

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

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

public Repository.Record getRecord(Connection c)
                            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a record containing the current state of the given Repository. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

all fields from the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByUuid

public static Repository getByUuid(Connection c,
 String uuid)
                            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a reference to the Repository instance with the specified UUID. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByNameLabel

public static Set<Repository> getByNameLabel(Connection c,
 String label)
                                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get all the Repository instances with the given label. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

label - label of object to return

Returns:

references to objects with matching names

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUuid

public String getUuid(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the uuid field of the given Repository. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getNameLabel

public String getNameLabel(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the name/label field of the given Repository. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getNameDescription

public String getNameDescription(Connection c)
                          throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the name/description field of the given Repository. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getBinaryUrl

public String getBinaryUrl(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the binary_url field of the given Repository. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getSourceUrl

public String getSourceUrl(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the source_url field of the given Repository. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUpdate

public Boolean getUpdate(Connection c)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the update field of the given Repository. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getHash

public String getHash(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the hash field of the given Repository. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUpToDate

@Deprecated(since="23.18.0")
public Boolean getUpToDate(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since 23.18.0

Get the up_to_date field of the given Repository. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getGpgkeyPath

public String getGpgkeyPath(Connection c)
                     throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the gpgkey_path field of the given Repository. Minimum allowed role: read-only Experimental. First published in 22.12.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getOrigin

public Types.Origin getOrigin(Connection c)
                       throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the origin field of the given Repository. Minimum allowed role: read-only Experimental. First published in 24.23.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getCertificate

public String getCertificate(Connection c)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the certificate field of the given Repository. Minimum allowed role: read-only Experimental. First published in 25.7.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setNameLabel

public void setNameLabel(Connection c,
 String label)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the name/label field of the given Repository. Minimum allowed role: pool-operator First published in 1.301.0.

Parameters:

c - The connection the call is made on

label - New value to set

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setNameDescription

public void setNameDescription(Connection c,
 String description)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the name/description field of the given Repository. Minimum allowed role: pool-operator First published in 1.301.0.

Parameters:

c - The connection the call is made on

description - New value to set

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

introduce

public static Repository introduce(Connection c,
 String nameLabel,
 String nameDescription,
 String binaryUrl,
 String sourceUrl,
 Boolean update,
 String gpgkeyPath)
                            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add the configuration for a new remote repository Minimum allowed role: pool-operator First published in 1.301.0.

Parameters:

c - The connection the call is made on

nameLabel - The name of the repository

nameDescription - The description of the repository

binaryUrl - Base URL of binary packages in this repository

sourceUrl - Base URL of source packages in this repository

update - True if the repository is an update repository. This means that updateinfo.xml will be parsed

gpgkeyPath - The GPG public key file name

Returns:

The ref of the created repository record.

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

introduceAsync

public static Task introduceAsync(Connection c,
 String nameLabel,
 String nameDescription,
 String binaryUrl,
 String sourceUrl,
 Boolean update,
 String gpgkeyPath)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add the configuration for a new remote repository Minimum allowed role: pool-operator First published in 1.301.0.

Parameters:

c - The connection the call is made on

nameLabel - The name of the repository

nameDescription - The description of the repository

binaryUrl - Base URL of binary packages in this repository

sourceUrl - Base URL of source packages in this repository

update - True if the repository is an update repository. This means that updateinfo.xml will be parsed

gpgkeyPath - The GPG public key file name

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

introduceBundle

public static Repository introduceBundle(Connection c,
 String nameLabel,
 String nameDescription)
                                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add the configuration for a new bundle repository Minimum allowed role: pool-operator Experimental. First published in 24.23.0.

Parameters:

c - The connection the call is made on

nameLabel - The name of the repository

nameDescription - The description of the repository

Returns:

The ref of the created repository record.

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

introduceBundleAsync

public static Task introduceBundleAsync(Connection c,
 String nameLabel,
 String nameDescription)
                                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add the configuration for a new bundle repository Minimum allowed role: pool-operator Experimental. First published in 24.23.0.

Parameters:

c - The connection the call is made on

nameLabel - The name of the repository

nameDescription - The description of the repository

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

introduceRemotePool

public static Repository introduceRemotePool(Connection c,
 String nameLabel,
 String nameDescription,
 String binaryUrl,
 String certificate)
                                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add the configuration for a new remote pool repository Minimum allowed role: pool-operator Experimental. First published in 25.7.0.

Parameters:

c - The connection the call is made on

nameLabel - The name of the repository

nameDescription - The description of the repository

binaryUrl - Base URL of binary packages in the local repository of this remote pool in https://<coordinator-ip>/repository/enabled format

certificate - The host certificate of the coordinator of the remote pool

Returns:

The ref of the created repository record.

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

introduceRemotePoolAsync

public static Task introduceRemotePoolAsync(Connection c,
 String nameLabel,
 String nameDescription,
 String binaryUrl,
 String certificate)
                                     throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add the configuration for a new remote pool repository Minimum allowed role: pool-operator Experimental. First published in 25.7.0.

Parameters:

c - The connection the call is made on

nameLabel - The name of the repository

nameDescription - The description of the repository

binaryUrl - Base URL of binary packages in the local repository of this remote pool in https://<coordinator-ip>/repository/enabled format

certificate - The host certificate of the coordinator of the remote pool

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

forget

public void forget(Connection c)
            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Remove the repository record from the database Minimum allowed role: pool-operator First published in 1.301.0.

Parameters:

c - The connection the call is made on

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

forgetAsync

public Task forgetAsync(Connection c)
                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Remove the repository record from the database Minimum allowed role: pool-operator First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setGpgkeyPath

public void setGpgkeyPath(Connection c,
 String value)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the file name of the GPG public key of the repository Minimum allowed role: pool-operator Experimental. First published in 22.12.0.

Parameters:

c - The connection the call is made on

value - The file name of the GPG public key of the repository

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setGpgkeyPathAsync

public Task setGpgkeyPathAsync(Connection c,
 String value)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the file name of the GPG public key of the repository Minimum allowed role: pool-operator Experimental. First published in 22.12.0.

Parameters:

c - The connection the call is made on

value - The file name of the GPG public key of the repository

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAll

public static Set<Repository> getAll(Connection c)
                              throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a list of all the Repositorys known to the system. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

references to all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAllRecords

public static Map<Repository,Repository.Record> getAllRecords(Connection c)
                                                       throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a map of Repository references to Repository records for all Repositorys known to the system. Minimum allowed role: read-only First published in 1.301.0.

Parameters:

c - The connection the call is made on

Returns:

records of all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.