public class Role extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
Role.Record
Represents all the fields in a Role
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
ref
The XenAPI reference to this object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
If obj is a Role, compares XenAPI references for equality.
|
static java.util.Set<Role> |
getAll(Connection c)
Return a list of all the roles known to the system.
|
static java.util.Map<Role,Role.Record> |
getAllRecords(Connection c)
Return a map of role references to role records for all roles known to the system.
|
static java.util.Set<Role> |
getByNameLabel(Connection c,
java.lang.String label)
Get all the role instances with the given label.
|
java.util.Set<Role> |
getByPermission(Connection c)
This call returns a list of roles given a permission
|
static java.util.Set<Role> |
getByPermissionNameLabel(Connection c,
java.lang.String label)
This call returns a list of roles given a permission name
|
static Role |
getByUuid(Connection c,
java.lang.String uuid)
Get a reference to the role instance with the specified UUID.
|
java.lang.String |
getNameDescription(Connection c)
Get the name/description field of the given role.
|
java.lang.String |
getNameLabel(Connection c)
Get the name/label field of the given role.
|
java.util.Set<Role> |
getPermissions(Connection c)
This call returns a list of permissions given a role
|
java.util.Set<java.lang.String> |
getPermissionsNameLabel(Connection c)
This call returns a list of permission names given a role
|
Role.Record |
getRecord(Connection c)
Get a record containing the current state of the given role.
|
java.util.Set<Role> |
getSubroles(Connection c)
Get the subroles field of the given role.
|
java.lang.String |
getUuid(Connection c)
Get the uuid field of the given role.
|
int |
hashCode() |
java.lang.String |
toWireString() |
public java.lang.String toWireString()
toWireString
in class XenAPIObject
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public Role.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Role getByUuid(Connection c, java.lang.String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
uuid
- UUID of object to returnTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Set<Role> getByNameLabel(Connection c, java.lang.String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
label
- label of object to returnTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Set<Role> getSubroles(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Set<Role> getPermissions(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Set<java.lang.String> getPermissionsNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Set<Role> getByPermission(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Set<Role> getByPermissionNameLabel(Connection c, java.lang.String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
label
- The short friendly name of the roleTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Set<Role> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Map<Role,Role.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException