Package org.opennebula.client.user
Class User
- java.lang.Object
-
- org.opennebula.client.PoolElement
-
- org.opennebula.client.user.User
-
public class User extends PoolElement
This class represents an OpenNebula User. It also offers static XML-RPC call wrappers.
-
-
Field Summary
-
Fields inherited from class org.opennebula.client.PoolElement
client, id, xml, xpath
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description OneResponse
addgroup(int gid)
Adds the User to a secondary groupstatic OneResponse
addgroup(Client client, int id, int gid)
Adds the User to a secondary groupstatic OneResponse
allocate(Client client, java.lang.String username, java.lang.String password)
Allocates a new user in OpenNebula.static OneResponse
allocate(Client client, java.lang.String username, java.lang.String password, java.lang.String auth, java.lang.Integer[] gids)
Allocates a new user in OpenNebula.OneResponse
chauth(java.lang.String auth)
Changes the auth driver of the given userOneResponse
chauth(java.lang.String auth, java.lang.String password)
Changes the auth driver and the password of the given userstatic OneResponse
chauth(Client client, int id, java.lang.String auth, java.lang.String password)
Changes the auth driver and the password of the given userOneResponse
chgrp(int gid)
Changes the main group of the given userstatic OneResponse
chgrp(Client client, int id, int gid)
Changes the main group of the given userOneResponse
delete()
Deletes the user from OpenNebula.static OneResponse
delete(Client client, int id)
Deletes a user from OpenNebula.OneResponse
delgroup(int gid)
Removes the User from a secondary group.static OneResponse
delgroup(Client client, int id, int gid)
Removes the User from a secondary group.OneResponse
enable(boolean enable)
Enables or disables a Userstatic OneResponse
enable(Client client, int id, boolean enable)
Enables or disables a UserOneResponse
info()
Loads the xml representation of the user.static OneResponse
info(Client client, int id)
Retrieves the information of the given user.static OneResponse
info(Client client, int id, boolean decrypt)
Retrieves the information of the given User.boolean
isEnabled()
Returns true if the user is enabled.OneResponse
login(java.lang.String token, int expire)
Sets the LOGIN_TOKEN for the user.OneResponse
login(java.lang.String token, int expire, int egid)
Sets the LOGIN_TOKEN for the user.static OneResponse
login(Client client, java.lang.String username, java.lang.String token, int expire)
Sets the LOGIN_TOKEN for the userstatic OneResponse
login(Client client, java.lang.String username, java.lang.String token, int expire, int egid)
Sets the LOGIN_TOKEN for the userOneResponse
passwd(java.lang.String password)
Changes the password for the user.static OneResponse
passwd(Client client, int id, java.lang.String password)
Changes the password for the given user.OneResponse
setQuota(java.lang.String quota_template)
Replaces the user quota template contents.static OneResponse
setQuota(Client client, int id, java.lang.String quota_template)
Replaces the user quota template contents.OneResponse
update(java.lang.String new_template)
Replaces the user template contents.OneResponse
update(java.lang.String new_template, boolean append)
Replaces the user template contents.static OneResponse
update(Client client, int id, java.lang.String new_template, boolean append)
Replaces the user template contents.
-
-
-
Constructor Detail
-
User
public User(int id, Client client)
Creates a new User representation.- Parameters:
id
- The user id (uid).client
- XML-RPC Client.
-
User
protected User(org.w3c.dom.Node xmlElement, Client client)
- See Also:
PoolElement
-
-
Method Detail
-
allocate
public static OneResponse allocate(Client client, java.lang.String username, java.lang.String password)
Allocates a new user in OpenNebula.- Parameters:
client
- XML-RPC Client.username
- Username for the new user.password
- Password for the new user- Returns:
- If successful the message contains the associated id (int uid) generated for this user.
-
allocate
public static OneResponse allocate(Client client, java.lang.String username, java.lang.String password, java.lang.String auth, java.lang.Integer[] gids)
Allocates a new user in OpenNebula.- Parameters:
client
- XML-RPC Client.username
- Username for the new user.password
- Password for the new userauth
- Auth driver for the new user.gids
- Group IDs. The first ID will be used as the main group. This array can be empty, in which case the default group will be used.- Returns:
- If successful the message contains the associated id (int uid) generated for this user.
-
info
public static OneResponse info(Client client, int id)
Retrieves the information of the given user.- Parameters:
client
- XML-RPC Client.id
- The user id (uid) for the user to retrieve the information from.- Returns:
- if successful the message contains the string with the information about the user returned by OpenNebula.
-
info
public static OneResponse info(Client client, int id, boolean decrypt)
Retrieves the information of the given User.- Parameters:
client
- XML-RPC Client.id
- The User id for the User to retrieve the information fromdecrypt
- If true decrypt sensitive attributes- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
delete
public static OneResponse delete(Client client, int id)
Deletes a user from OpenNebula.- Parameters:
client
- XML-RPC Client.id
- The user id (uid) of the target user we want to delete.- Returns:
- If an error occurs the error message contains the reason.
-
passwd
public static OneResponse passwd(Client client, int id, java.lang.String password)
Changes the password for the given user.- Parameters:
client
- XML-RPC Client.id
- The user id (uid) of the target user we want to modify.password
- The new password.- Returns:
- If an error occurs the error message contains the reason.
-
chgrp
public static OneResponse chgrp(Client client, int id, int gid)
Changes the main group of the given user- Parameters:
client
- XML-RPC Client.id
- The user id (uid) of the target user we want to modify.gid
- The new group ID.- Returns:
- If an error occurs the error message contains the reason.
-
addgroup
public static OneResponse addgroup(Client client, int id, int gid)
Adds the User to a secondary group- Parameters:
client
- XML-RPC Client.id
- The user id (uid) of the target user we want to modify.gid
- The new group ID.- Returns:
- If an error occurs the error message contains the reason.
-
delgroup
public static OneResponse delgroup(Client client, int id, int gid)
Removes the User from a secondary group. Fails if the group is the main one- Parameters:
client
- XML-RPC Client.id
- The user id (uid) of the target user we want to modify.gid
- The group ID.- Returns:
- If an error occurs the error message contains the reason.
-
chauth
public static OneResponse chauth(Client client, int id, java.lang.String auth, java.lang.String password)
Changes the auth driver and the password of the given user- Parameters:
client
- XML-RPC Client.id
- The user id (uid) of the target user we want to modify.auth
- The new auth driver.password
- The new password. If it is an empty string, the user password is not changed- Returns:
- If an error occurs the error message contains the reason.
-
update
public static OneResponse update(Client client, int id, java.lang.String new_template, boolean append)
Replaces the user template contents.- Parameters:
client
- XML-RPC Client.id
- The user id of the target user we want to modify.new_template
- New template contents.append
- True to append new attributes instead of replace the whole template- Returns:
- If successful the message contains the user id.
-
setQuota
public static OneResponse setQuota(Client client, int id, java.lang.String quota_template)
Replaces the user quota template contents.- Parameters:
client
- XML-RPC Client.id
- The user id of the target user we want to modify.quota_template
- New quota template contents.- Returns:
- If successful the message contains the user id.
-
login
public static OneResponse login(Client client, java.lang.String username, java.lang.String token, int expire)
Sets the LOGIN_TOKEN for the user- Parameters:
client
- XML-RPC Client.username
- of the usertoken
- the login token, if empty OpenNebula will generate oneexpire
- valid period of the token in secs. If <= 0 the token will be reset- Returns:
- token in case of success, Error otherwise
-
login
public static OneResponse login(Client client, java.lang.String username, java.lang.String token, int expire, int egid)
Sets the LOGIN_TOKEN for the user- Parameters:
client
- XML-RPC Client.username
- of the usertoken
- the login token, if empty OpenNebula will generate oneexpire
- valid period of the token in secs. If <= 0 the token will be resetegid
- effective GID to use with this token. To use the current GID and user groups set it to -1- Returns:
- token in case of success, Error otherwise
-
enable
public static OneResponse enable(Client client, int id, boolean enable)
Enables or disables a User- Parameters:
client
- XML-RPC Client.id
- The user id of the target user we want to modify.enable
- True for enabling, false for disabling.- Returns:
- If successful the message contains the User id.
-
info
public OneResponse info()
Loads the xml representation of the user. The info is also stored internally.- See Also:
info(Client, int)
-
delete
public OneResponse delete()
Deletes the user from OpenNebula.- See Also:
delete(Client, int)
-
passwd
public OneResponse passwd(java.lang.String password)
Changes the password for the user.- Parameters:
password
- The new password.- Returns:
- If an error occurs the error message contains the reason.
-
chgrp
public OneResponse chgrp(int gid)
Changes the main group of the given user- Parameters:
gid
- The new group ID.- Returns:
- If an error occurs the error message contains the reason.
-
addgroup
public OneResponse addgroup(int gid)
Adds the User to a secondary group- Parameters:
gid
- The new group ID.- Returns:
- If an error occurs the error message contains the reason.
-
delgroup
public OneResponse delgroup(int gid)
Removes the User from a secondary group. Fails if the group is the main one- Parameters:
gid
- The group ID.- Returns:
- If an error occurs the error message contains the reason.
-
chauth
public OneResponse chauth(java.lang.String auth, java.lang.String password)
Changes the auth driver and the password of the given user- Parameters:
auth
- The new auth driver.password
- The new password. If it is an empty string, the user password is not changed- Returns:
- If an error occurs the error message contains the reason.
-
chauth
public OneResponse chauth(java.lang.String auth)
Changes the auth driver of the given user- Parameters:
auth
- The new auth driver.- Returns:
- If an error occurs the error message contains the reason.
-
update
public OneResponse update(java.lang.String new_template)
Replaces the user template contents.- Parameters:
new_template
- New template contents.- Returns:
- If successful the message contains the user id.
-
update
public OneResponse update(java.lang.String new_template, boolean append)
Replaces the user template contents.- Parameters:
new_template
- New template contents.append
- True to append new attributes instead of replace the whole template- Returns:
- If successful the message contains the user id.
-
setQuota
public OneResponse setQuota(java.lang.String quota_template)
Replaces the user quota template contents.- Parameters:
quota_template
- New quota template contents.- Returns:
- If successful the message contains the user id.
-
login
public OneResponse login(java.lang.String token, int expire)
Sets the LOGIN_TOKEN for the user. The method info() must be called before.- Parameters:
token
- the login token, if empty OpenNebula will generate oneexpire
- valid period of the token in secs. If <= 0 the token will be reset- Returns:
- token in case of success, Error otherwise
-
login
public OneResponse login(java.lang.String token, int expire, int egid)
Sets the LOGIN_TOKEN for the user. The method info() must be called before.- Parameters:
token
- the login token, if empty OpenNebula will generate oneexpire
- valid period of the token in secs. If <= 0 the token will be resetegid
- effective GID to use with this token. To use the current GID and user groups set it to -1- Returns:
- token in case of success, Error otherwise
-
enable
public OneResponse enable(boolean enable)
Enables or disables a User- Parameters:
enable
- True for enabling, false for disabling.- Returns:
- If successful the message contains the User id.
-
isEnabled
public boolean isEnabled()
Returns true if the user is enabled.- Returns:
- True if the user is enabled.
-
-