Package com.xensource.xenapi

Class Console

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.Console

public class Console
extends XenAPIObject

A console First published in XenServer 4.0.

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
void	addToOtherConfig(Connection c, String key, String value)	Add the given key-value pair to the other_config field of the given console.
static Console	create(Connection c, Console.Record record)	Create a new console instance, and return its handle.
static Task	createAsync(Connection c, Console.Record record)	Create a new console instance, and return its handle.
void	destroy(Connection c)	Destroy the specified console instance.
Task	destroyAsync(Connection c)	Destroy the specified console instance.
boolean	equals(Object obj)	If obj is a Console, compares XenAPI references for equality.
static Set<Console>	getAll(Connection c)	Return a list of all the consoles known to the system.
static Map<Console,Console.Record>	getAllRecords(Connection c)	Return a map of console references to console records for all consoles known to the system.
static Console	getByUuid(Connection c, String uuid)	Get a reference to the console instance with the specified UUID.
String	getLocation(Connection c)	Get the location field of the given console.
Map<String,String>	getOtherConfig(Connection c)	Get the other_config field of the given console.
Types.ConsoleProtocol	getProtocol(Connection c)	Get the protocol field of the given console.
Console.Record	getRecord(Connection c)	Get a record containing the current state of the given console.
String	getUuid(Connection c)	Get the uuid field of the given console.
VM	getVM(Connection c)	Get the VM field of the given console.
int	hashCode()
void	removeFromOtherConfig(Connection c, String key)	Remove the given key and its corresponding value from the other_config field of the given console.
void	setOtherConfig(Connection c, Map<String,String> otherConfig)	Set the other_config field of the given console.
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.

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 Console, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

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

Get a record containing the current state of the given console. Minimum allowed role: read-only First published in XenServer 4.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 Console getByUuid(Connection c,
 String uuid)
                         throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a reference to the console instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.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.

create

public static Console create(Connection c,
 Console.Record record)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a new console instance, and return its handle. Minimum allowed role: vm-admin First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

record - All constructor arguments

Returns:

reference to the newly created 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.

createAsync

public static Task createAsync(Connection c,
 Console.Record record)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a new console instance, and return its handle. Minimum allowed role: vm-admin First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

record - All constructor arguments

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.

destroy

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

Destroy the specified console instance. Minimum allowed role: vm-admin First published in XenServer 4.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.

destroyAsync

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

Destroy the specified console instance. Minimum allowed role: vm-admin First published in XenServer 4.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.

getUuid

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

Get the uuid field of the given console. Minimum allowed role: read-only First published in XenServer 4.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.

getProtocol

public Types.ConsoleProtocol getProtocol(Connection c)
                                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the protocol field of the given console. Minimum allowed role: read-only First published in XenServer 4.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.

getLocation

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

Get the location field of the given console. Minimum allowed role: read-only First published in XenServer 4.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.

getVM

public VM getVM(Connection c)
         throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the VM field of the given console. Minimum allowed role: read-only First published in XenServer 4.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.

getOtherConfig

public Map<String,String> getOtherConfig(Connection c)
                                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the other_config field of the given console. Minimum allowed role: read-only First published in XenServer 4.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.

setOtherConfig

public void setOtherConfig(Connection c,
 Map<String,String> otherConfig)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the other_config field of the given console. Minimum allowed role: vm-admin First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

otherConfig - 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.

addToOtherConfig

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

Add the given key-value pair to the other_config field of the given console. Minimum allowed role: vm-admin First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

key - Key to add

value - Value to add

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.

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
 String key)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Remove the given key and its corresponding value from the other_config field of the given console. If the key is not in that Map, then do nothing. Minimum allowed role: vm-admin First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

key - Key to remove

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<Console> getAll(Connection c)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a list of all the consoles known to the system. Minimum allowed role: read-only First published in XenServer 4.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<Console,Console.Record> getAllRecords(Connection c)
                                                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a map of console references to console records for all consoles known to the system. Minimum allowed role: read-only First published in XenServer 4.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.