Package com.xensource.xenapi
Class User
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.User
A user of the system
First published in XenServer 4.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given user.static User
create
(Connection c, User.Record record) Deprecated.since XenServer 5.5static Task
createAsync
(Connection c, User.Record record) Deprecated.since XenServer 5.5void
Deprecated.since XenServer 5.5Deprecated.since XenServer 5.5boolean
If obj is a User, compares XenAPI references for equality.static User
getByUuid
(Connection c, String uuid) Deprecated.since XenServer 5.5Get the fullname field of the given user.Get the other_config field of the given user.Deprecated.since XenServer 5.5Get the short_name field of the given user.Get the uuid field of the given user.int
hashCode()
void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given user.void
setFullname
(Connection c, String fullname) Set the fullname field of the given user.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given user.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a User, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
@Deprecated(since="XenServer 5.5") public User.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.5Get a record containing the current state of the given user. 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
@Deprecated(since="XenServer 5.5") public static User getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.5Get a reference to the user instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onuuid
- 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
@Deprecated(since="XenServer 5.5") public static User create(Connection c, User.Record record) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.5Create a new user instance, and return its handle. Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onrecord
- 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
@Deprecated(since="XenServer 5.5") public static Task createAsync(Connection c, User.Record record) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.5Create a new user instance, and return its handle. Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onrecord
- 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
@Deprecated(since="XenServer 5.5") public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.5Destroy the specified user instance. Minimum allowed role: pool-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
@Deprecated(since="XenServer 5.5") public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.5Destroy the specified user instance. Minimum allowed role: pool-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 user. 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.
-
getShortName
public String getShortName(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the short_name field of the given user. 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.
-
getFullname
public String getFullname(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the fullname field of the given user. 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 user. Minimum allowed role: read-only First published in XenServer 5.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.
-
setFullname
public void setFullname(Connection c, String fullname) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the fullname field of the given user. Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onfullname
- 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.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the other_config field of the given user. Minimum allowed role: pool-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onotherConfig
- 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 user. Minimum allowed role: pool-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- 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 user. If the key is not in that Map, then do nothing. Minimum allowed role: pool-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onkey
- 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.
-