com.xensource.xenapi

Class Subject

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.Subject

public class Subject
extends XenAPIObject

A user or group that can log in xapi First published in XenServer 5.5.

Nested Class Summary

Nested Classes

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

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
void	addToRoles(Connection c, Role role) This call adds a new role to a subject First published in XenServer 5.6.
static Subject	create(Connection c, Subject.Record record) Create a new subject instance, and return its handle.
static Task	createAsync(Connection c, Subject.Record record) Create a new subject instance, and return its handle.
void	destroy(Connection c) Destroy the specified subject instance.
Task	destroyAsync(Connection c) Destroy the specified subject instance.
boolean	equals(java.lang.Object obj) If obj is a Subject, compares XenAPI references for equality.
static java.util.Set<Subject>	getAll(Connection c) Return a list of all the subjects known to the system.
static java.util.Map<Subject,Subject.Record>	getAllRecords(Connection c) Return a map of subject references to subject records for all subjects known to the system.
static Subject	getByUuid(Connection c, java.lang.String uuid) Get a reference to the subject instance with the specified UUID.
java.util.Map<java.lang.String,java.lang.String>	getOtherConfig(Connection c) Get the other_config field of the given subject.
java.util.Set<java.lang.String>	getPermissionsNameLabel(Connection c) This call returns a list of permission names given a subject First published in XenServer 5.6.
Subject.Record	getRecord(Connection c) Get a record containing the current state of the given subject.
java.util.Set<Role>	getRoles(Connection c) Get the roles field of the given subject.
java.lang.String	getSubjectIdentifier(Connection c) Get the subject_identifier field of the given subject.
java.lang.String	getUuid(Connection c) Get the uuid field of the given subject.
int	hashCode()
void	removeFromRoles(Connection c, Role role) This call removes a role from a subject First published in XenServer 5.6.
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 Subject, 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 Subject.Record getRecord(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given subject. First published in XenServer 5.5.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

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

Get a reference to the subject instance with the specified UUID. First published in XenServer 5.5.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               Subject.Record record)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Create a new subject instance, and return its handle. First published in XenServer 5.5.

Parameters:

record - All constructor arguments

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static Subject create(Connection c,
             Subject.Record record)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Create a new subject instance, and return its handle. First published in XenServer 5.5.

Parameters:

record - All constructor arguments

Returns:

reference to the newly created object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Destroy the specified subject instance. First published in XenServer 5.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroy

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

Destroy the specified subject instance. First published in XenServer 5.5.

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 subject. First published in XenServer 5.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSubjectIdentifier

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

Get the subject_identifier field of the given subject. First published in XenServer 5.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getOtherConfig

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

Get the other_config field of the given subject. First published in XenServer 5.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getRoles

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

Get the roles field of the given subject. First published in XenServer 5.6.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToRoles

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

This call adds a new role to a subject First published in XenServer 5.6.

Parameters:

role - The unique role reference

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromRoles

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

This call removes a role from a subject First published in XenServer 5.6.

Parameters:

role - The unique role reference in the subject's roles field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPermissionsNameLabel

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

This call returns a list of permission names given a subject First published in XenServer 5.6.

Returns:

a list of permission names

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

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

Return a list of all the subjects known to the system. First published in XenServer 5.5.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

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

Return a map of subject references to subject records for all subjects known to the system. First published in XenServer 5.5.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException