Package com.xensource.xenapi

Class Caller

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.Caller

public class Caller
extends XenAPIObject

XAPI caller description and rate limiting First published in .

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addGroup(Connection c, String group)	Add a caller to a group Minimum allowed role: pool-operator Experimental.
Task	addGroupAsync(Connection c, String group)	Add a caller to a group Minimum allowed role: pool-operator Experimental.
static Caller	create(Connection c, Caller.Record record)	Create a new Caller instance, and return its handle.
static Task	createAsync(Connection c, Caller.Record record)	Create a new Caller instance, and return its handle.
void	destroy(Connection c)	Destroy the specified Caller instance.
Task	destroyAsync(Connection c)	Destroy the specified Caller instance.
boolean	equals(Object obj)	If obj is a Caller, compares XenAPI references for equality.
static Set<Caller>	getAll(Connection c)	Return a list of all the Callers known to the system.
static Map<Caller,Caller.Record>	getAllRecords(Connection c)	Return a map of Caller references to Caller records for all Callers known to the system.
Boolean	getAutoRegistered(Connection c)	Get the auto_registered field of the given Caller.
static Set<Caller>	getByNameLabel(Connection c, String label)	Get all the Caller instances with the given label.
static Caller	getByUuid(Connection c, String uuid)	Get a reference to the Caller instance with the specified UUID.
String	getClientIp(Connection c)	Get the client_ip field of the given Caller.
Set<String>	getGroups(Connection c)	Get the groups field of the given Caller.
Date	getLastAccess(Connection c)	Get the last_access field of the given Caller.
String	getNameDescription(Connection c)	Get the name/description field of the given Caller.
String	getNameLabel(Connection c)	Get the name/label field of the given Caller.
RateLimit	getRateLimit(Connection c)	Get the rate_limit field of the given Caller.
Caller.Record	getRecord(Connection c)	Get a record containing the current state of the given Caller.
String	getUserAgent(Connection c)	Get the user_agent field of the given Caller.
String	getUuid(Connection c)	Get the uuid field of the given Caller.
int	hashCode()
static Set<Set<String>>	queryAllUsage(Connection c)	Return per-caller usage for every known caller, sorted by token use descending.
static Task	queryAllUsageAsync(Connection c)	Return per-caller usage for every known caller, sorted by token use descending.
Long	queryCallCount(Connection c)	Return number of calls made by this caller since Xapi startup Minimum allowed role: pool-operator Experimental.
Task	queryCallCountAsync(Connection c)	Return number of calls made by this caller since Xapi startup Minimum allowed role: pool-operator Experimental.
static Long	queryGroupCallCount(Connection c, String group)	Return number of calls made since Xapi startup by the callers in the named group.
static Task	queryGroupCallCountAsync(Connection c, String group)	Return number of calls made since Xapi startup by the callers in the named group.
static Double	queryGroupTokenUsage(Connection c, String group)	Return tokens used since Xapi startup by the callers in the named group.
static Task	queryGroupTokenUsageAsync(Connection c, String group)	Return tokens used since Xapi startup by the callers in the named group.
Double	queryTokenUsage(Connection c)	Return tokens used by this caller since Xapi startup Minimum allowed role: pool-operator Experimental.
Task	queryTokenUsageAsync(Connection c)	Return tokens used by this caller since Xapi startup Minimum allowed role: pool-operator Experimental.
void	removeGroup(Connection c, String group)	Remove a caller from a group Minimum allowed role: pool-operator Experimental.
Task	removeGroupAsync(Connection c, String group)	Remove a caller from a group Minimum allowed role: pool-operator Experimental.
void	setNameDescription(Connection c, String description)	Set the name/description field of the given Caller.
void	setNameLabel(Connection c, String label)	Set the name/label field of the given Caller.
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

Caller

public Caller(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 Caller, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

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

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

Get a reference to the Caller instance with the specified UUID. Minimum allowed role: read-only Experimental. First published in 26.17.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 Caller create(Connection c,
 Caller.Record record)
                     throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a new Caller instance, and return its handle. Minimum allowed role: pool-admin Experimental. First published in 26.17.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,
 Caller.Record record)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a new Caller instance, and return its handle. Minimum allowed role: pool-admin Experimental. First published in 26.17.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 Caller instance. Minimum allowed role: pool-admin Experimental. First published in 26.17.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 Caller instance. Minimum allowed role: pool-admin Experimental. First published in 26.17.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.

getByNameLabel

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

Get all the Caller instances with the given label. Minimum allowed role: read-only Experimental. First published in 26.17.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 Caller. Minimum allowed role: read-only Experimental. First published in 26.17.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 Caller. Minimum allowed role: read-only Experimental. First published in 26.17.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 Caller. Minimum allowed role: read-only Experimental. First published in 26.17.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.

getUserAgent

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

Get the user_agent field of the given Caller. Minimum allowed role: read-only Experimental. First published in 26.17.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.

getClientIp

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

Get the client_ip field of the given Caller. Minimum allowed role: read-only Experimental. First published in 26.17.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.

getLastAccess

public Date getLastAccess(Connection c)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the last_access field of the given Caller. Minimum allowed role: read-only Experimental. First published in 26.17.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.

getGroups

public Set<String> getGroups(Connection c)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the groups field of the given Caller. Minimum allowed role: read-only Experimental. First published in 26.17.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.

getRateLimit

public RateLimit getRateLimit(Connection c)
                       throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the rate_limit field of the given Caller. Minimum allowed role: read-only Experimental. First published in 26.17.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.

getAutoRegistered

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

Get the auto_registered field of the given Caller. Minimum allowed role: read-only Experimental. First published in 26.17.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 Caller. Minimum allowed role: pool-admin Experimental. First published in 26.17.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 Caller. Minimum allowed role: pool-admin Experimental. First published in 26.17.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.

addGroup

public void addGroup(Connection c,
 String group)
              throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add a caller to a group Minimum allowed role: pool-operator Experimental. First published in 26.17.0.

Parameters:

c - The connection the call is made on

group - Group the caller is being added to

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.

addGroupAsync

public Task addGroupAsync(Connection c,
 String group)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add a caller to a group Minimum allowed role: pool-operator Experimental. First published in 26.17.0.

Parameters:

c - The connection the call is made on

group - Group the caller is being added to

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.

removeGroup

public void removeGroup(Connection c,
 String group)
                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Remove a caller from a group Minimum allowed role: pool-operator Experimental. First published in 26.17.0.

Parameters:

c - The connection the call is made on

group - Group the caller is removed from

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.

removeGroupAsync

public Task removeGroupAsync(Connection c,
 String group)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Remove a caller from a group Minimum allowed role: pool-operator Experimental. First published in 26.17.0.

Parameters:

c - The connection the call is made on

group - Group the caller is removed from

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.

queryTokenUsage

public Double queryTokenUsage(Connection c)
                       throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return tokens used by this caller since Xapi startup Minimum allowed role: pool-operator Experimental. First published in 26.15.0.

Parameters:

c - The connection the call is made on

Returns:

Tokens used by the caller since Xapi startup

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.

queryTokenUsageAsync

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

Return tokens used by this caller since Xapi startup Minimum allowed role: pool-operator Experimental. First published in 26.15.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.

queryCallCount

public Long queryCallCount(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return number of calls made by this caller since Xapi startup Minimum allowed role: pool-operator Experimental. First published in 26.15.0.

Parameters:

c - The connection the call is made on

Returns:

Calls made by the caller since Xapi startup

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.

queryCallCountAsync

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

Return number of calls made by this caller since Xapi startup Minimum allowed role: pool-operator Experimental. First published in 26.15.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.

queryGroupTokenUsage

public static Double queryGroupTokenUsage(Connection c,
 String group)
                                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return tokens used since Xapi startup by the callers in the named group. Minimum allowed role: pool-operator Experimental. First published in 26.15.0.

Parameters:

c - The connection the call is made on

group - Caller group to aggregate over

Returns:

Tokens used by the group since Xapi startup

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.

queryGroupTokenUsageAsync

public static Task queryGroupTokenUsageAsync(Connection c,
 String group)
                                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return tokens used since Xapi startup by the callers in the named group. Minimum allowed role: pool-operator Experimental. First published in 26.15.0.

Parameters:

c - The connection the call is made on

group - Caller group to aggregate over

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.

queryGroupCallCount

public static Long queryGroupCallCount(Connection c,
 String group)
                                throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return number of calls made since Xapi startup by the callers in the named group. Minimum allowed role: pool-operator Experimental. First published in 26.15.0.

Parameters:

c - The connection the call is made on

group - Caller group to aggregate over

Returns:

Number of calls made by the callers in the group

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.

queryGroupCallCountAsync

public static Task queryGroupCallCountAsync(Connection c,
 String group)
                                     throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return number of calls made since Xapi startup by the callers in the named group. Minimum allowed role: pool-operator Experimental. First published in 26.15.0.

Parameters:

c - The connection the call is made on

group - Caller group to aggregate over

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.

queryAllUsage

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

Return per-caller usage for every known caller, sorted by token use descending. Minimum allowed role: pool-operator Experimental. First published in 26.17.0.

Parameters:

c - The connection the call is made on

Returns:

Rows of [uuid; name_label; tokens; calls], highest tokens first

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.

queryAllUsageAsync

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

Return per-caller usage for every known caller, sorted by token use descending. Minimum allowed role: pool-operator Experimental. First published in 26.17.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.

getAll

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

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

Return a map of Caller references to Caller records for all Callers known to the system. Minimum allowed role: read-only Experimental. First published in 26.17.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.