com.redhat.rhn.domain.user

Class UserFactory

java.lang.Object

com.redhat.rhn.common.hibernate.HibernateFactory

com.redhat.rhn.domain.user.UserFactory

public class UserFactory
extends HibernateFactory

UserFactory - the singleton class used to fetch and store com.redhat.rhn.domain.user.User objects from the database.

Field Summary

Fields

Modifier and Type	Field and Description
static State	DISABLED
static State	ENABLED
static java.util.List<Role>	IMPLIEDROLES List of Role objects that are applied if you are an Org_admin
protected static org.apache.log4j.Logger	LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserFactory()

Method Summary

Modifier and Type	Method and Description
protected User	addNewUser(User usr, Address addr, java.lang.Long orgId) Insert a new user.
static Address	createAddress() Create a new address instance.
static User	createUser() Create a new user from scratch
static void	deleteUser(java.lang.Long userId)
void	disable(User userToDisable, User disabledBy) Disable a user
void	enable(User userToEnable, User enabledBy) Enable a user
java.util.List<User>	findAllOrgAdmins(Org inOrg) Return a list of all User's who are org admins in the given org.
java.util.List<User>	findAllUsers(Org inOrg) Return a list of all User's who are in the given org.
static User	findRandomOrgAdmin(Org orgIn) Returns user (first org admin) of the org.
static User	findResponsibleUser(java.lang.Long orgId, Role r) Returns the responsible user (first org admin) of the org.
static RhnTimeZone	getDefaultTimeZone() Gets the default time zone
static UserFactory	getInstance()
protected org.apache.log4j.Logger	getLogger() Get the Logger for the derived class so log messages show up on the correct class
static RhnTimeZone	getTimeZone(int id) Get the timezone by ID
static RhnTimeZone	getTimeZone(java.lang.String olsonName) Get the timezone by olson name
static boolean	isDisabled(User user) Convenience method to determine whether a user is disabled or not
static java.util.List	lookupAllTimeZones() Get all timezones in apropriate order
static java.util.List<User>	lookupByEmail(java.lang.String email) Return a list of all Users who has the given email.
static User	lookupById(java.lang.Long id) Lookup a user by their id
static User	lookupById(User user, java.lang.Long id) Lookup a user by their id, assuming that they are in the same Org as the user doing the search.
static java.util.List<User>	lookupByIds(java.util.Collection<java.lang.Long> ids) Get users by their ids.
static User	lookupByLogin(java.lang.String login) Lookup a user by their login
static User	lookupByLogin(User user, java.lang.String login) Lookup a user by their login
UserServerPreference	lookupServerPreferenceByUserServerAndName(User user, Server server, java.lang.String name) Looks up the UserServerPreference corresponding to the given user, server, and preference label
static boolean	satelliteHasUsers() Method to determine whether a satellite has any users.
static void	save(User user) Insert or Update a user
static void	saveAddress(Address addr) Save this instance of address
static User	saveNewUser(User usr, Address addr, java.lang.Long orgId) Insert a new user.
protected void	saveUser(User user) Insert or Update a user
void	setUserServerPreferenceValue(User user, Server server, java.lang.String preferenceName, boolean value) Sets a UserServerPreference to true or false
void	syncServerGroupPerms(User usr) Syncs the user permissions with server group info..
protected void	syncUserPerms(User usr) Syncs the user permissions with server group info..

Methods inherited from class com.redhat.rhn.common.hibernate.HibernateFactory

addConfigurator, blobToByteArray, byteArrayToBlob, closeSession, closeSessionFactory, commitTransaction, createSessionFactory, createSessionFactory, executeCallableMode, executeSelectMode, getBlobContents, getByteArrayContents, getObject, getSession, initialize, inTransaction, isClosed, isInitialized, listObjectsByNamedQuery, listObjectsByNamedQuery, listObjectsByNamedQuery, lockObject, lookupObjectByNamedQuery, lookupObjectByNamedQuery, reload, removeObject, rollbackTransaction, saveObject, saveObject, stringToByteArray

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.log4j.Logger LOG

IMPLIEDROLES

public static final java.util.List<Role> IMPLIEDROLES

List of Role objects that are applied if you are an Org_admin

ENABLED

public static final State ENABLED

DISABLED

public static final State DISABLED

Constructor Detail

UserFactory

protected UserFactory()

Method Detail

findResponsibleUser

public static User findResponsibleUser(java.lang.Long orgId,
                                       Role r)

Returns the responsible user (first org admin) of the org.

Parameters:

orgId - Org id

r - Role to search for (ORG_ADMIN)

Returns:

the responsible user (first org admin) of the org.

findRandomOrgAdmin

public static User findRandomOrgAdmin(Org orgIn)

Returns user (first org admin) of the org.

Parameters:

orgIn - Org id

Returns:

the user (first org admin) of the org.

getLogger

protected org.apache.log4j.Logger getLogger()

Get the Logger for the derived class so log messages show up on the correct class

Specified by:

getLogger in class HibernateFactory

Returns:

Logger for this class.

createUser

public static User createUser()

Create a new user from scratch

Returns:

the user created

createAddress

public static Address createAddress()

Create a new address instance.

Returns:

Address the address created

saveAddress

public static void saveAddress(Address addr)

Save this instance of address

Parameters:

addr - the address to save.

lookupById

public static User lookupById(java.lang.Long id)

Lookup a user by their id

Parameters:

id - the id to search for

Returns:

the user found

lookupByIds

public static java.util.List<User> lookupByIds(java.util.Collection<java.lang.Long> ids)

Get users by their ids. If the incoming list has more than 1000 entries, we'll chop it up and run several queries, re-assembling the results in application code. This is to accommodate Oracle's ORA-01795 error "maximum number of expressions in a list is 1000".

Parameters:

ids - the ids to lookup for

Returns:

the list of com.redhat.rhn.domain.User objects found

lookupById

public static User lookupById(User user,
                              java.lang.Long id)

Lookup a user by their id, assuming that they are in the same Org as the user doing the search.

Parameters:

user - the user doing the search

id - the id to search for

Returns:

the user found

lookupByLogin

public static User lookupByLogin(java.lang.String login)

Lookup a user by their login

Parameters:

login - the login to search by

Returns:

the User found

lookupByLogin

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

Lookup a user by their login

Parameters:

user - the user doing the search

login - the login to search by

Returns:

the User found

saveNewUser

public static User saveNewUser(User usr,
                               Address addr,
                               java.lang.Long orgId)

Insert a new user. Invalid to call this when updating a user TODO: mmccune fill out the other fields in the user object.

Parameters:

usr - The object we are commiting.

addr - The address to add to the User

orgId - Org this new user is a member of

Returns:

User The freshly commited user.

isDisabled

public static boolean isDisabled(User user)

Convenience method to determine whether a user is disabled or not

Parameters:

user - to check on...

Returns:

Returns true if the user is disabled

addNewUser

protected User addNewUser(User usr,
                          Address addr,
                          java.lang.Long orgId)

Insert a new user. Invalid to call this when updating a user TODO: mmccune fill out the other fields in the user object.

Parameters:

usr - The object we are commiting.

addr - The address to add to the User

orgId - Org this new user is a member of

Returns:

User The freshly commited user.

save

public static void save(User user)

Insert or Update a user

Parameters:

user - The object we are committing.

saveUser

protected void saveUser(User user)

Insert or Update a user

Parameters:

user - The object we are committing.

syncUserPerms

protected void syncUserPerms(User usr)

Syncs the user permissions with server group info..

Parameters:

usr - the user to sync

syncServerGroupPerms

public void syncServerGroupPerms(User usr)

Syncs the user permissions with server group info..

Parameters:

usr - User to be synchronized.

getTimeZone

public static RhnTimeZone getTimeZone(int id)

Get the timezone by ID

Parameters:

id - ID number for timezone

Returns:

TimeZone the requested time zone

getTimeZone

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

Get the timezone by olson name

Parameters:

olsonName - olson name for timezone

Returns:

TimeZone the requested time zone

getDefaultTimeZone

public static RhnTimeZone getDefaultTimeZone()

Gets the default time zone

Returns:

US Eastern Time Zone

lookupAllTimeZones

public static java.util.List lookupAllTimeZones()

Get all timezones in apropriate order

Returns:

List a list of timezones

disable

public void disable(User userToDisable,
                    User disabledBy)

Disable a user

Parameters:

userToDisable - The user to disable

disabledBy - The user committing the act

enable

public void enable(User userToEnable,
                   User enabledBy)

Enable a user

Parameters:

userToEnable - The user to enable

enabledBy - The user committing the act

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.

getInstance

public static UserFactory getInstance()

Returns:

an instance of user Factory

lookupServerPreferenceByUserServerAndName

public UserServerPreference lookupServerPreferenceByUserServerAndName(User user,
                                                                      Server server,
                                                                      java.lang.String name)

Looks up the UserServerPreference corresponding to the given user, server, and preference label

Parameters:

user - user who the preference corresponds to

server - server that preference corresponds to

name - preference label we are looking for

Returns:

UserServerPreference that corresponds to the parameters

setUserServerPreferenceValue

public 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

lookupByEmail

public static java.util.List<User> lookupByEmail(java.lang.String email)

Return a list of all Users who has the given email.

Parameters:

email - String to find users for.

Returns:

list of users.

findAllUsers

public java.util.List<User> findAllUsers(Org inOrg)

Return a list of all User's who are in the given org.

Parameters:

inOrg - Org to find users for.

Returns:

list of users.

findAllOrgAdmins

public java.util.List<User> findAllOrgAdmins(Org inOrg)

Return a list of all User's who are org admins in the given org.

Parameters:

inOrg - Org to find administrators for.

Returns:

list of users.

deleteUser

public static void deleteUser(java.lang.Long userId)

Parameters:

userId - the user id