com.redhat.rhn.manager.user

Class UserManager

java.lang.Object

com.redhat.rhn.manager.BaseManager

com.redhat.rhn.manager.user.UserManager

public class UserManager
extends BaseManager

UserManager - the singleton class used to provide Business Operations on Users where those operations interact with other top tier Business Objects. Operations that require the User make changes to

Method Summary

Modifier and Type	Method and Description
static DataResult	activeInOrg(User user, PageControl pc) Retrieve the list of all active users in the specified user's org
static DataResult<UserOverview>	activeInOrg2(User user) Retrieve the list of all active users in the specified user's org
static void	addChannelPerm(User user, java.lang.Long cid, java.lang.String role) Adds channel permissions from a user.
static void	addRemoveUserRoles(User usr, java.util.List<java.lang.String> rolesToAdd, java.util.List<java.lang.String> rolesToRemove) Add and remove the specified roles from the user.
static boolean	canAdministerSystemGroup(User user, ManagedServerGroup group) can a system group be administered by user?
static DataResult	channelManagement(User user, PageControl pc) Retrieve the list of Channels the user can manage
static DataResult	channelSubscriptions(User user, PageControl pc) Retrieve the list of Channels the user can subscribe to
static User	createUser(User user, Org org, Address addr) Create brand new personal user using the information found in the User object.
static void	deleteUser(User loggedInUser, java.lang.Long targetUid) Deletes a User
static DataResult	disabledInOrg(User user, PageControl pc) Retrieve the list of all disabled users in the specified user's org
static void	disableUser(User disabledBy, User userToDisable) Disables userToDisable.
static void	enableUser(User enabledBy, User userToEnable) Enables a user.
static User	findResponsibleUser(Org org, Role r) Returns the responsible user (the first orgadmin in the org)
static java.util.Set	getDefaultSystemGroupIds(User usr) Get the set of default system groups for this user
static RhnTimeZone	getDefaultTimeZone() Gets the default timezone object
static DataResult	getSystemGroups(User user, PageControl pc) Returns the System Groups associated with the given User bounded by the values of the PageControl.
static RhnTimeZone	getTimeZone(int id) Gets a timezone object based on id
static RhnTimeZone	getTimeZone(java.lang.String olsonName) Gets a timezone object based on olson name
static void	grantServerGroupPermission(java.lang.Long uid, long sgid) Grants the given User permission to the ServerGroup whose id is sgid.
static void	grantServerGroupPermission(User usr, long sgid) Grants the given User permission to the ServerGroup whose id is sgid.
static boolean	hasRole(java.lang.Long uid, Role label) Check role for the specified user.
static java.util.Set<Role>	listRolesAssignableBy(User user) Returns a list of roles that are assignable by a given user i.e.
static User	loginReadOnlyUser(java.lang.String username, java.lang.String password) This method should be ONLY called when we need to authenticate read-only user e.g.
static User	loginUser(java.lang.String username, java.lang.String password) Login the user with the given username and password.
static java.util.List	lookupAllTimeZones() Gets all timezone objects in the appropriate order
static User	lookupUser(User user, java.lang.Long uid) Retrieve the specified user, assuming that the User making the request has the required permissions.
static User	lookupUser(User user, java.lang.String login) Retrieve the specified user, assuming that the User making the request has the required permissions.
static boolean	lookupUserServerPreferenceValue(User user, Server server, java.lang.String preferenceName) Looks up the value of a user's server preference.
static void	removeChannelPerm(User user, java.lang.Long cid, java.lang.String role) Removes channel permissions from a user or nothing if they already have no channel permissions.
static void	resetTemporaryRoles(User userIn, java.util.Set<Role> temporaryRolesIn) set temporary roles to the current set
static void	revokeServerGroupPermission(java.lang.Long uid, long sgid) Revokes permission from the given User to the ServerGroup whose id is sgid.
static void	revokeServerGroupPermission(User usr, long sgid) Revokes permission from the given User to the ServerGroup whose id is sgid.
static java.lang.String	roleNames(java.util.Set<Role> rolesIn) serialize role names
static boolean	satelliteHasUsers() Method to determine whether a satellite has any users.
static java.lang.String	serverGroupsName(java.util.Set<ServerGroup> serverGroupsIn) serialize role names
static void	setDefaultSystemGroupIds(User usr, java.util.Set groups) Set the defaultSystemGroups for the specified User.
static void	setUserServerPreferenceValue(User user, Server server, java.lang.String preferenceName, boolean value) Sets a UserServerPreference to true or false
static void	storeUser(User user) Updates the Users to the database
static java.util.List<User>	usersInOrg(User user) Retrieve the list of all users in the specified user's org.
static DataResult<UserOverview>	usersInOrg(User user, PageControl pc) Retrieve the list of all users in the specified user's org.
static DataResult	usersInOrg(User user, PageControl pc, java.lang.Class clazz) Retrieve the list of all users in the specified user's org.
static DataResult	usersInSet(User user, java.lang.String label, PageControl pc) Returns the users in the given set
static boolean	verifyChannelAdmin(java.lang.Long userId, Channel channel) Verifies that the passed in user id has admin over the passed in channel.
static boolean	verifyChannelAdmin(User user, Channel channel) Verifies that the passed in user has admin over the passed in channel.
static boolean	verifyChannelSubscribable(User user, Channel channel) Verifies that the passed in user has subscribe access to passed in channel.
static boolean	verifyPackageAccess(Org org, java.lang.Long packageId) Verifies that a given org has access to a given package.
static DataResult	visibleSystems(User user) Generic visibleSystems that returns all systems visible to a particular user.
static DataResult	visibleSystems(User user, PageControl pc) Retrieve the list of systems visible to a particular user
static DataResult<SystemSearchResult>	visibleSystemsAsDtoFromList(User user, java.util.List<java.lang.Long> ids) Returns visible Systems as a SystemSearchResult Object

Methods inherited from class com.redhat.rhn.manager.BaseManager

makeDataResult, makeDataResult, makeDataResult, makeDataResult, makeDataResultNoPagination, makeDataResultNoPagination, processListControl, processPageControl

Methods inherited from class java.lang.Object

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

Method Detail

listRolesAssignableBy

public static java.util.Set<Role> listRolesAssignableBy(User user)

Returns a list of roles that are assignable by a given user i.e. the list of roles that the passed in user can assign

Parameters:

user - the user for whom the check is being done

Returns:

the list of roles assignable by this user.

verifyPackageAccess

public static boolean verifyPackageAccess(Org org,
                                          java.lang.Long packageId)

Verifies that a given org has access to a given package.

Parameters:

org - The org in question

packageId - The id of the package in question

Returns:

Returns true if the org has access to the package, false otherwise.

verifyChannelAdmin

public static boolean verifyChannelAdmin(User user,
                                         Channel channel)

Verifies that the passed in user has admin over the passed in channel.

Parameters:

user - The user to check.

channel - The channel to check.

Returns:

Returns true if the user has admin access to this channel, false otherwise.

verifyChannelAdmin

public static boolean verifyChannelAdmin(java.lang.Long userId,
                                         Channel channel)

Verifies that the passed in user id has admin over the passed in channel.

Parameters:

userId - The user id to check.

channel - The channel to check.

Returns:

Returns true if the user id has admin access to this channel

verifyChannelSubscribable

public static boolean verifyChannelSubscribable(User user,
                                                Channel channel)

Verifies that the passed in user has subscribe access to passed in channel.

Parameters:

user - The user to check.

channel - The channel to check.

Returns:

Returns true if the user has subscribe access to this channel, false otherwise.

enableUser

public static void enableUser(User enabledBy,
                              User userToEnable)

Enables a user.

Parameters:

enabledBy - The user doing the enabling

userToEnable - The user to enable

disableUser

public static void disableUser(User disabledBy,
                               User userToDisable)

Disables userToDisable.

Parameters:

disabledBy - The user doing the disabling

userToDisable - The user to disable

revokeServerGroupPermission

public static void revokeServerGroupPermission(java.lang.Long uid,
                                               long sgid)

Revokes permission from the given User to the ServerGroup whose id is sgid.

Parameters:

uid - Id of user who no longer needs permission

sgid - ServerGroup ID

revokeServerGroupPermission

public static void revokeServerGroupPermission(User usr,
                                               long sgid)

Revokes permission from the given User to the ServerGroup whose id is sgid.

Parameters:

usr - User who no longer needs permission

sgid - ServerGroup ID

grantServerGroupPermission

public static void grantServerGroupPermission(java.lang.Long uid,
                                              long sgid)

Grants the given User permission to the ServerGroup whose id is sgid.

Parameters:

uid - Id of user who needs permission

sgid - ServerGroup ID

grantServerGroupPermission

public static void grantServerGroupPermission(User usr,
                                              long sgid)

Grants the given User permission to the ServerGroup whose id is sgid.

Parameters:

usr - User who needs permission

sgid - ServerGroup ID

addRemoveUserRoles

public static void addRemoveUserRoles(User usr,
                                      java.util.List<java.lang.String> rolesToAdd,
                                      java.util.List<java.lang.String> rolesToRemove)

Add and remove the specified roles from the user.

Parameters:

usr - The User who's Roles you want to update

rolesToAdd - List of role labels to add.

rolesToRemove - List of role labels to remove.

createUser

public static User createUser(User user,
                              Org org,
                              Address addr)

Create brand new personal user using the information found in the User object.

Parameters:

user - Filled out user to create.

org - Org to associate with the user.

addr - Address to associate with the user.

Returns:

User Freshly created user.

getDefaultSystemGroupIds

public static java.util.Set getDefaultSystemGroupIds(User usr)

Get the set of default system groups for this user

Parameters:

usr - User for which to get the default system groups.

Returns:

groupSet Set of default system groups IDs for the user.

setDefaultSystemGroupIds

public static void setDefaultSystemGroupIds(User usr,
                                            java.util.Set groups)

Set the defaultSystemGroups for the specified User. This method first deletes all current groups and then adds all of the specified groups. The assumption is that we never add a lot of default system groups at one time, so it is cheaper to just delete and re-add than to compute the difference and commit just the changes.

Parameters:

usr - User for which to set the default groups.

groups - Set of groups to associate with the user.

loginUser

public static User loginUser(java.lang.String username,
                             java.lang.String password)
                      throws javax.security.auth.login.LoginException

Login the user with the given username and password.

Parameters:

username - User's login name

password - User's unencrypted password.

Returns:

Returns the user if login is successful, or null othewise.

Throws:

javax.security.auth.login.LoginException - if login fails. The message is a string resource key.

loginReadOnlyUser

public static User loginReadOnlyUser(java.lang.String username,
                                     java.lang.String password)
                              throws javax.security.auth.login.LoginException

This method should be ONLY called when we need to authenticate read-only user e.g. for purpose of the API calls Login the user with the given username and password.

Parameters:

username - User's login name

password - User's unencrypted password.

Returns:

Returns the user if login is successful, or null othewise.

Throws:

javax.security.auth.login.LoginException - if login fails. The message is a string resource key.

storeUser

public static void storeUser(User user)

Updates the Users to the database

Parameters:

user - User to store.

deleteUser

public static void deleteUser(User loggedInUser,
                              java.lang.Long targetUid)

Deletes a User

Parameters:

loggedInUser - The user doing the deleting

targetUid - The id for the user we're deleting

lookupUser

public static User lookupUser(User user,
                              java.lang.Long uid)

Retrieve the specified user, assuming that the User making the request has the required permissions.

Parameters:

user - The user making the lookup request.

uid - The id of the user to lookup.

Returns:

the specified user.

Throws:

LookupException - if the User can't be looked up.

hasRole

public static boolean hasRole(java.lang.Long uid,
                              Role label)

Check role for the specified user.

Parameters:

uid - The id of the user to lookup.

label - Role to check.

Returns:

the specified user.

lookupUser

public static User lookupUser(User user,
                              java.lang.String login)

Retrieve the specified user, assuming that the User making the request has the required permissions.

Parameters:

user - The user making the lookup request

login - The login of the user to lookup.

Returns:

the specified user.

usersInOrg

public static java.util.List<User> usersInOrg(User user)

Retrieve the list of all users in the specified user's org.

Parameters:

user - The user who's org to search for users.

Returns:

A list of users.

usersInOrg

public static DataResult<UserOverview> usersInOrg(User user,
                                                  PageControl pc)

Retrieve the list of all users in the specified user's org. Returns DataResult containing the default objects specified in User_queries.xml

Parameters:

user - The user who's org to search for users.

pc - The details of which results to return.

Returns:

A DataResult containing the specified number of users.

usersInOrg

public static DataResult usersInOrg(User user,
                                    PageControl pc,
                                    java.lang.Class clazz)

Retrieve the list of all users in the specified user's org. Returns DataResult containing Map objects.

Parameters:

user - The user who's org to search for users.

pc - The details of which results to return.

clazz - The class you want the returned DataResult to contain.

Returns:

A DataResult containing the specified number of users.

activeInOrg

public static DataResult activeInOrg(User user,
                                     PageControl pc)

Retrieve the list of all active users in the specified user's org

Parameters:

user - The user who's org to search for users.

pc - The details of which results to return.

Returns:

A list containing the specified number of users.

activeInOrg2

public static DataResult<UserOverview> activeInOrg2(User user)

Retrieve the list of all active users in the specified user's org

Parameters:

user - The user who's org to search for users.

Returns:

A list containing the specified number of users.

disabledInOrg

public static DataResult disabledInOrg(User user,
                                       PageControl pc)

Retrieve the list of all disabled users in the specified user's org

Parameters:

user - The user who's org to search for users.

pc - The details of which results to return.

Returns:

A list containing the specified number of users.

channelSubscriptions

public static DataResult channelSubscriptions(User user,
                                              PageControl pc)

Retrieve the list of Channels the user can subscribe to

Parameters:

user - The user who's channels to search for.

pc - The details of which results to return.

Returns:

A list containing the specified number of channels.

channelManagement

public static DataResult channelManagement(User user,
                                           PageControl pc)

Retrieve the list of Channels the user can manage

Parameters:

user - The user who's channels to search for.

pc - The details of which results to return.

Returns:

A list containing the specified number of channels.

visibleSystems

public static DataResult visibleSystems(User user,
                                        PageControl pc)

Retrieve the list of systems visible to a particular user

Parameters:

user - The user in question

pc - The details of which results to return

Returns:

A list containing the visible systems for the user

visibleSystems

public static DataResult visibleSystems(User user)

Generic visibleSystems that returns all systems visible to a particular user.

Parameters:

user - The user in question

Returns:

A list containing the visible systems for the user

visibleSystemsAsDtoFromList

public static DataResult<SystemSearchResult> visibleSystemsAsDtoFromList(User user,
                                                                         java.util.List<java.lang.Long> ids)

Returns visible Systems as a SystemSearchResult Object

Parameters:

user - the user we want

ids - the list of desired system ids

Returns:

DataResult of systems

usersInSet

public static DataResult usersInSet(User user,
                                    java.lang.String label,
                                    PageControl pc)

Returns the users in the given set

Parameters:

user - The user

label - The name of the set

pc - Page Control

Returns:

completed DataResult

canAdministerSystemGroup

public static boolean canAdministerSystemGroup(User user,
                                               ManagedServerGroup group)

can a system group be administered by user?

Parameters:

user - User

group - SystemGroup

Returns:

true if user can administer system group

getSystemGroups

public static DataResult getSystemGroups(User user,
                                         PageControl pc)

Returns the System Groups associated with the given User bounded by the values of the PageControl.

Parameters:

user - User whose SystemGroups are sought.

pc - Bounding PageControl

Returns:

The DataResult of the SystemGroups.

getTimeZone

public static RhnTimeZone getTimeZone(int id)

Gets a timezone object based on id

Parameters:

id - timezone id number

Returns:

the timezone requested

getTimeZone

public static RhnTimeZone getTimeZone(java.lang.String olsonName)

Gets a timezone object based on olson name

Parameters:

olsonName - timezone olson name

Returns:

the timezone requested

getDefaultTimeZone

public static RhnTimeZone getDefaultTimeZone()

Gets the default timezone object

Returns:

the default timezone object

lookupAllTimeZones

public static java.util.List lookupAllTimeZones()

Gets all timezone objects in the appropriate order

Returns:

a list of ordered timezones

removeChannelPerm

public static void removeChannelPerm(User user,
                                     java.lang.Long cid,
                                     java.lang.String role)

Removes channel permissions from a user or nothing if they already have no channel permissions.

Parameters:

user - The user for which the perm is changing

cid - The channel identifier

role - The role the user is losing for this channel.

addChannelPerm

public static void addChannelPerm(User user,
                                  java.lang.Long cid,
                                  java.lang.String role)

Adds channel permissions from a user. Does nothing if the channel cannot be viewed by this user's org

Parameters:

user - The user for which the perm is changing

cid - The channel identifier

role - The role the user is gaining for this channel.

satelliteHasUsers

public static boolean satelliteHasUsers()

Method to determine whether a satellite has any users. Returns true if satellite has one or more users, false otherwise. Also returns false if this method is called on a hosted installation.

Returns:

true if satellite has one or more users, false otherwise.

findResponsibleUser

public static User findResponsibleUser(Org org,
                                       Role r)

Returns the responsible user (the first orgadmin in the org)

Parameters:

org - Org to search

r - Org_admin role

Returns:

User with the login and id populated.

See Also:

RoleFactory.ORG_ADMIN

lookupUserServerPreferenceValue

public static boolean lookupUserServerPreferenceValue(User user,
                                                      Server server,
                                                      java.lang.String preferenceName)

Looks up the value of a user's server preference.

Parameters:

user - user to lookup the preference

server - server that the preference corresponds to

preferenceName - the name of the preference

Returns:

true if no value is present, false if the value is present and equal to 0 otherwise

See Also:

UserServerPreferenceId

setUserServerPreferenceValue

public static void setUserServerPreferenceValue(User user,
                                                Server server,
                                                java.lang.String preferenceName,
                                                boolean value)

Sets a UserServerPreference to true or false

Parameters:

user - User whose preference will be set

server - Server we are setting the perference on

preferenceName - the name of the preference

value - true if the preference should be true, false otherwise

See Also:

UserServerPreferenceId

resetTemporaryRoles

public static void resetTemporaryRoles(User userIn,
                                       java.util.Set<Role> temporaryRolesIn)

set temporary roles to the current set

Parameters:

userIn - affected user

temporaryRolesIn - temporary roles set

roleNames

public static java.lang.String roleNames(java.util.Set<Role> rolesIn)

serialize role names

Parameters:

rolesIn - roles to put into string

Returns:

roles string

serverGroupsName

public static java.lang.String serverGroupsName(java.util.Set<ServerGroup> serverGroupsIn)

serialize role names

Parameters:

serverGroupsIn - roles to put into string

Returns:

roles string