com.redhat.rhn.frontend.xmlrpc.user

Class UserHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.user.UserHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class UserHandler
extends BaseHandler

UserHandler Corresponds to User.pm in old perl code.

Field Summary

Fields inherited from class com.redhat.rhn.frontend.xmlrpc.BaseHandler

VALID

Constructor Summary

Constructors

Constructor and Description
UserHandler()

Method Summary

Modifier and Type	Method and Description
int	addAssignedSystemGroup(User loggedInUser, java.lang.String login, java.lang.String sgName, java.lang.Boolean setDefault) Add to the user's list of assigned system groups.
int	addAssignedSystemGroups(User loggedInUser, java.lang.String login, java.util.List sgNames, java.lang.Boolean setDefault) Add to the user's list of assigned system groups.
int	addDefaultSystemGroup(User loggedInUser, java.lang.String login, java.lang.String name) Add ServerGroup to the list of Default System groups.
int	addDefaultSystemGroups(User loggedInUser, java.lang.String login, java.util.List sgNames) Add ServerGroups to the list of Default System groups.
int	addRole(User loggedInUser, java.lang.String login, java.lang.String role) Adds a role to the given user
int	create(User loggedInUser, java.lang.String desiredLogin, java.lang.String desiredPassword, java.lang.String firstName, java.lang.String lastName, java.lang.String email) Creates a new user
int	create(User loggedInUser, java.lang.String desiredLogin, java.lang.String desiredPassword, java.lang.String firstName, java.lang.String lastName, java.lang.String email, java.lang.Integer usePamAuth) Creates a new user
int	delete(User loggedInUser, java.lang.String login) Deletes a user
int	disable(User loggedInUser, java.lang.String login) Disable a user
int	enable(User loggedInUser, java.lang.String login) Enable a user
boolean	getCreateDefaultSystemGroup(User loggedInUser) Return the current value of the createDefaultSystemGroup settnig
java.util.Map	getDetails(User loggedInUser, java.lang.String login) Gets details for a given user.
java.util.Date	getLoggedInTime(User loggedInUser, java.lang.String login) Deprecated. Never returned usable value.
java.util.Set<java.lang.String>	listAssignableRoles(User loggedInUser) Lists all the roles that can be assign by this user.
java.lang.Object[]	listAssignedSystemGroups(User loggedInUser, java.lang.String login) Returns the ServerGroups that the user can administer.
java.lang.Object[]	listDefaultSystemGroups(User loggedInUser, java.lang.String login) Returns default system groups for the given login.
java.lang.Object[]	listRoles(User loggedInUser, java.lang.String login) Lists the roles for a user
java.util.List	listUsers(User loggedInUser) Lists the users in the org.
int	removeAssignedSystemGroup(User loggedInUser, java.lang.String login, java.lang.String systemGroupName, java.lang.Boolean setDefault) remove system group association from a user
int	removeAssignedSystemGroups(User loggedInUser, java.lang.String login, java.util.List<java.lang.String> systemGroupNames, java.lang.Boolean setDefault) remove system group association from a user
int	removeDefaultSystemGroup(User loggedInUser, java.lang.String login, java.lang.String sgName) Remove ServerGroup from the list of Default System groups.
int	removeDefaultSystemGroups(User loggedInUser, java.lang.String login, java.util.List sgNames) Remove ServerGroups from the list of Default System groups.
int	removeRole(User loggedInUser, java.lang.String login, java.lang.String role) Removes a role from the given user
int	setCreateDefaultSystemGroup(User loggedInUser, java.lang.Boolean createDefaultSystemGroup) Return the current value of the createDefaultSystemGroup settnig
int	setDetails(User loggedInUser, java.lang.String login, java.util.Map details) Sets the details for a given user.
int	setErrataNotifications(User loggedInUser, java.lang.String login, java.lang.Boolean value)
int	setReadOnly(User loggedInUser, java.lang.String login, java.lang.Boolean readOnly)
int	usePamAuthentication(User loggedInUser, java.lang.String login, java.lang.Integer val) Toggles whether or not a user users pamAuthentication or the basic Satellite db auth.

Methods inherited from class com.redhat.rhn.frontend.xmlrpc.BaseHandler

ensureConfigAdmin, ensureOrgAdmin, ensureOrgOrConfigAdmin, ensureSatAdmin, ensureSystemGroupAdmin, ensureUserRole, getLoggedInUser, invoke, providesAuthentication, setEntityAttribute, validateClientCertificate, validateEntitlements, validateMap, verifyOrgExists

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserHandler

public UserHandler()

Method Detail

listUsers

public java.util.List listUsers(User loggedInUser)
                         throws FaultException

Lists the users in the org.

Parameters:

loggedInUser - The current user

Returns:

Returns a list of userids and logins

Throws:

FaultException - A FaultException is thrown if the loggedInUser doesn't have permissions to list the users in their org.

listRoles

public java.lang.Object[] listRoles(User loggedInUser,
                                    java.lang.String login)
                             throws FaultException

Lists the roles for a user

Parameters:

loggedInUser - The current user

login - The login for the user you want to get the roles for

Returns:

Returns a list of roles for the user specified by login

Throws:

FaultException - A FaultException is thrown if the user doesn't have access to lookup the user corresponding to login or if the user does not exist.

listAssignableRoles

public java.util.Set<java.lang.String> listAssignableRoles(User loggedInUser)

Lists all the roles that can be assign by this user.

Parameters:

loggedInUser - The current user

Returns:

Returns a list of assignable roles for user

Throws:

FaultException - A FaultException is thrown if the logged doesn't have access.

getDetails

public java.util.Map getDetails(User loggedInUser,
                                java.lang.String login)
                         throws FaultException

Gets details for a given user. These details include first names, last name, email, prefix, last login date, and created on date.

Parameters:

loggedInUser - The current user

login - The login for the user you want the details for

Returns:

Returns a Map containing the details for the given user.

Throws:

FaultException - A FaultException is thrown if the user doesn't have access to lookup the user corresponding to login or if the user does not exist.

setDetails

public int setDetails(User loggedInUser,
                      java.lang.String login,
                      java.util.Map details)
               throws FaultException

Sets the details for a given user. Settable details include: first names, last name, email, prefix, and password.

Parameters:

loggedInUser - The current user user.

login - The login for the user you want to edit

details - A map containing the new details values

Returns:

Returns 1 if edit was successful, an error is thrown otherwise

Throws:

FaultException - A FaultException is thrown if the user doesn't have access to lookup the user corresponding to login or if the user does not exist.

addRole

public int addRole(User loggedInUser,
                   java.lang.String login,
                   java.lang.String role)
            throws FaultException

Adds a role to the given user

Parameters:

loggedInUser - The current user

login - The login for the user you would like to add the role to

role - The role you would like to give the user

Returns:

Returns 1 if successful (exception otherwise)

Throws:

FaultException - A FaultException is thrown if the user doesn't have access to lookup the user corresponding to login or if the user does not exist.

removeRole

public int removeRole(User loggedInUser,
                      java.lang.String login,
                      java.lang.String role)
               throws FaultException

Removes a role from the given user

Parameters:

loggedInUser - The current user

login - The login for the user you would like to remove the role from

role - The role you would like to remove from the user

Returns:

Returns 1 if successful (exception otherwise)

Throws:

FaultException - A FaultException is thrown if the user doesn't have access to lookup the user corresponding to login or if the user does not exist.

create

public int create(User loggedInUser,
                  java.lang.String desiredLogin,
                  java.lang.String desiredPassword,
                  java.lang.String firstName,
                  java.lang.String lastName,
                  java.lang.String email)
           throws FaultException

Creates a new user

Parameters:

loggedInUser - The current user

desiredLogin - The login for the new user

desiredPassword - The password for the new user

firstName - The first name of the new user

lastName - The last name of the new user

email - The email address for the new user

Returns:

Returns 1 if successful (exception otherwise)

Throws:

FaultException - A FaultException is thrown if the loggedInUser doesn't have permissions to create new users in thier org.

create

public int create(User loggedInUser,
                  java.lang.String desiredLogin,
                  java.lang.String desiredPassword,
                  java.lang.String firstName,
                  java.lang.String lastName,
                  java.lang.String email,
                  java.lang.Integer usePamAuth)
           throws FaultException

Creates a new user

Parameters:

loggedInUser - The current user

desiredLogin - The login for the new user

desiredPassword - The password for the new user

firstName - The first name of the new user

lastName - The last name of the new user

email - The email address for the new user

usePamAuth - Should this user authenticate via PAM?

Returns:

Returns 1 if successful (exception otherwise)

Throws:

FaultException - A FaultException is thrown if the loggedInUser doesn't have permissions to create new users in thier org.

delete

public int delete(User loggedInUser,
                  java.lang.String login)
           throws FaultException

Deletes a user

Parameters:

loggedInUser - The current user

login - The login for the user you would like to delete

Returns:

Returns 1 if successful (exception otherwise)

Throws:

FaultException - A FaultException is thrown if the user doesn't have access to lookup the user corresponding to login or if the user does not exist.

disable

public int disable(User loggedInUser,
                   java.lang.String login)
            throws FaultException

Disable a user

Parameters:

loggedInUser - The current user

login - The login for the user you would like to disable

Returns:

Returns 1 if successful (exception otherwise)

Throws:

FaultException - A FaultException is thrown if the user doesn't have access to lookup the user corresponding to login or if the user does not exist.

enable

public int enable(User loggedInUser,
                  java.lang.String login)
           throws FaultException

Enable a user

Parameters:

loggedInUser - The current user

login - The login for the user you would like to enable

Returns:

Returns 1 if successful (exception otherwise)

Throws:

FaultException - A FaultException is thrown if the user doesn't have access to lookup the user corresponding to login or if the user does not exist.

usePamAuthentication

public int usePamAuthentication(User loggedInUser,
                                java.lang.String login,
                                java.lang.Integer val)
                         throws FaultException

Toggles whether or not a user users pamAuthentication or the basic Satellite db auth.

Parameters:

loggedInUser - The current user

login - The login for the user you would like to change

val - The value you would like to set this to (1 = true, 0 = false)

Returns:

Returns 1 if successful (exception otherwise)

Throws:

FaultException - A FaultException is thrown if the user doesn't have access to lookup the user corresponding to login or if the user does not exist.

addDefaultSystemGroup

public int addDefaultSystemGroup(User loggedInUser,
                                 java.lang.String login,
                                 java.lang.String name)

Add ServerGroup to the list of Default System groups. The ServerGroup MUST exist otherwise a IllegalArgumentException is thrown.

Parameters:

loggedInUser - The current user in user.

login - The login for the user whose Default ServerGroup list will be affected.

name - name of ServerGroup.

Returns:

Returns 1 if successful (exception otherwise)

addDefaultSystemGroups

public int addDefaultSystemGroups(User loggedInUser,
                                  java.lang.String login,
                                  java.util.List sgNames)

Add ServerGroups to the list of Default System groups. The ServerGroups MUST exist otherwise a IllegalArgumentException is thrown.

Parameters:

loggedInUser - The current user in user.

login - The login for the user whose Default ServerGroup list will be affected.

sgNames - names of ServerGroups.

Returns:

Returns 1 if successful (exception otherwise)

removeDefaultSystemGroup

public int removeDefaultSystemGroup(User loggedInUser,
                                    java.lang.String login,
                                    java.lang.String sgName)

Remove ServerGroup from the list of Default System groups. The ServerGroup MUST exist otherwise a IllegalArgumentException is thrown.

Parameters:

loggedInUser - The current user in user.

login - The login for the user whose Default ServerGroup list will be affected.

sgName - Name of ServerGroup.

Returns:

Returns 1 if successful (exception otherwise)

removeDefaultSystemGroups

public int removeDefaultSystemGroups(User loggedInUser,
                                     java.lang.String login,
                                     java.util.List sgNames)

Remove ServerGroups from the list of Default System groups. The ServerGroups MUST exist otherwise a IllegalArgumentException is thrown.

Parameters:

loggedInUser - The current user in user.

login - The login for the user whose Default ServerGroup list will be affected.

sgNames - Names of ServerGroups.

Returns:

Returns 1 if successful (exception otherwise)

listDefaultSystemGroups

public java.lang.Object[] listDefaultSystemGroups(User loggedInUser,
                                                  java.lang.String login)

Returns default system groups for the given login.

Parameters:

loggedInUser - The current user in user.

login - The login for the user whose Default ServerGroup list is sought.

Returns:

default system groups for the given login

listAssignedSystemGroups

public java.lang.Object[] listAssignedSystemGroups(User loggedInUser,
                                                   java.lang.String login)
                                            throws FaultException

Returns the ServerGroups that the user can administer.

Parameters:

loggedInUser - The current user in user.

login - The login for the user whose ServerGroups are sought.

Returns:

the ServerGroups that the user can administer.

Throws:

FaultException - A FaultException is thrown if the user doesn't have access to lookup the user corresponding to login or if the user does not exist.

getLoggedInTime

@Deprecated
public java.util.Date getLoggedInTime(User loggedInUser,
                                                  java.lang.String login)
                                           throws UserNeverLoggedInException

Deprecated. Never returned usable value.

Returns the last logged in time of the given user.

Parameters:

loggedInUser - The current user in user.

login - The login of the user.

Returns:

last logged in time

Throws:

UserNeverLoggedInException - if the given user has never logged in.

removeAssignedSystemGroups

public int removeAssignedSystemGroups(User loggedInUser,
                                      java.lang.String login,
                                      java.util.List<java.lang.String> systemGroupNames,
                                      java.lang.Boolean setDefault)

remove system group association from a user

Parameters:

loggedInUser - The current user

login - the user's login that we want to remove the association from

systemGroupNames - list of system group names to remove

setDefault - if true the default group will be removed from the users's group defaults

Returns:

1 on success

removeAssignedSystemGroup

public int removeAssignedSystemGroup(User loggedInUser,
                                     java.lang.String login,
                                     java.lang.String systemGroupName,
                                     java.lang.Boolean setDefault)

remove system group association from a user

Parameters:

loggedInUser - The current user

login - the user's login that we want to remove the association from

systemGroupName - system group name to remove

setDefault - if true the default group will be removed from the users's group defaults

Returns:

1 on success

addAssignedSystemGroup

public int addAssignedSystemGroup(User loggedInUser,
                                  java.lang.String login,
                                  java.lang.String sgName,
                                  java.lang.Boolean setDefault)

Add to the user's list of assigned system groups.

Parameters:

loggedInUser - The current user

login - User to modify.

sgName - Server group Name.

setDefault - True to also add group to the user's default system groups.

Returns:

Returns 1 if successful (exception thrown otherwise)

addAssignedSystemGroups

public int addAssignedSystemGroups(User loggedInUser,
                                   java.lang.String login,
                                   java.util.List sgNames,
                                   java.lang.Boolean setDefault)

Add to the user's list of assigned system groups.

Parameters:

loggedInUser - The current user

login - User to modify.

sgNames - List of server group Names.

setDefault - True to also add groups to the user's default system groups.

Returns:

Returns 1 if successful (exception thrown otherwise)

getCreateDefaultSystemGroup

public boolean getCreateDefaultSystemGroup(User loggedInUser)

Return the current value of the createDefaultSystemGroup settnig

Parameters:

loggedInUser - The current user Must be org_admin.

Returns:

Returns 1 if successful (exception otherwise)

setCreateDefaultSystemGroup

public int setCreateDefaultSystemGroup(User loggedInUser,
                                       java.lang.Boolean createDefaultSystemGroup)

Return the current value of the createDefaultSystemGroup settnig

Parameters:

loggedInUser - The current user Must be org_admin.

createDefaultSystemGroup - The value to set

Returns:

Returns 1 if successful (exception otherwise)

setReadOnly

public int setReadOnly(User loggedInUser,
                       java.lang.String login,
                       java.lang.Boolean readOnly)

Parameters:

loggedInUser - The current user

login - User to modify.

readOnly - readOnly flag to set

Returns:

1 (should always succeed)

setErrataNotifications

public int setErrataNotifications(User loggedInUser,
                                  java.lang.String login,
                                  java.lang.Boolean value)

Parameters:

loggedInUser - The current user

login - User to modify

value - value to enable/disable errata mail notifications

Returns:

Returns 1 if successful (exception thrown otherwise)