com.redhat.rhn.manager.system

Class ServerGroupManager

java.lang.Object

com.redhat.rhn.manager.system.ServerGroupManager

public class ServerGroupManager
extends java.lang.Object

ServerGroupManager

Method Summary

Modifier and Type	Method and Description
void	addServers(ServerGroup sg, java.util.Collection<Server> servers, User loggedInUser) Associates a bunch of servers to a server group
void	associateAdmins(ManagedServerGroup sg, java.util.Collection admins, User loggedInUser) Associates a bunch of administrators to a server group
void	associateOrDissociateAdminsByLoginName(ManagedServerGroup group, java.util.Collection adminLogins, boolean associate, User loggedInUser) Associates/Disocciates a list of admins to a server group by using User's login name..
boolean	canAccess(User user, ServerGroup group) Returns true if the the given user can administer server groups..
ManagedServerGroup	create(User user, java.lang.String name, java.lang.String description) Create a new Server group
void	dissociateAdmins(ManagedServerGroup sg, java.util.Collection admins, User loggedInUser) Disssociates a bunch of administrators from a server group
java.util.Map	errataCounts(User user, ServerGroup group) Returns counts of applicable errata to given server group.
static ServerGroupManager	getInstance() Singleton Instance to get manager object
java.util.List<java.lang.Long>	listActiveServers(ServerGroup sg, java.lang.Long threshold) List all servers that have checked in within a X days
java.util.List	listAdministrators(ManagedServerGroup sg, User loggedInUser) Returns the admins of a given servergroup.
java.util.List<java.lang.Long>	listInactiveServers(ServerGroup sg, java.lang.Long threshold) List all servers that have not checked in in X days
java.util.List	listNoAdminGroups(User user) Returns a list of servergroups that have NO administrators associated to it.
java.util.List<Server>	listServers(ServerGroup sg) Returns the servers of a given servergroup
ManagedServerGroup	lookup(java.lang.Long id, User user) Lookup a ServerGroup by ID and organization.
ManagedServerGroup	lookup(java.lang.String name, User user) Lookup a ServerGroup by ID and organization.
EntitlementServerGroup	lookupEntitled(Entitlement ent, User user) Returns an EntitlementServerGroup for a given entitlement type
void	remove(User user, ManagedServerGroup group) Removes an ServerGroup.
void	removeServers(ServerGroup sg, java.util.Collection<Server> servers) Dissociates a bunch of servers from a server group.
void	removeServers(ServerGroup sg, java.util.Collection<Server> servers, User loggedInUser) Dissociates a bunch of servers from a server group
void	validateAccessCredentials(User user, ServerGroup group, java.lang.String groupIdentifier) validates that the given user can access the given ServerGroup object.
void	validateAdminCredentials(User user) validates that the given user can administer a server group.
void	validateOrgAdminCredentials(User user) validates that the given user can administer or lookup an entitled server group.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ServerGroupManager getInstance()

Singleton Instance to get manager object

Returns:

an instance of the manager

lookup

public ManagedServerGroup lookup(java.lang.Long id,
                                 User user)

Lookup a ServerGroup by ID and organization.

Parameters:

id - Server group id

user - logged in user needed for authentication

Returns:

Server group requested

lookup

public ManagedServerGroup lookup(java.lang.String name,
                                 User user)

Lookup a ServerGroup by ID and organization.

Parameters:

name - Server group name

user - logged in user needed for authentication

Returns:

Server group requested

lookupEntitled

public EntitlementServerGroup lookupEntitled(Entitlement ent,
                                             User user)

Returns an EntitlementServerGroup for a given entitlement type

Parameters:

ent - the entitlement type desired

user - logged in user needed for authentication - needs to be ORG Admin

Returns:

the Server group requested.

canAccess

public boolean canAccess(User user,
                         ServerGroup group)

Returns true if the the given user can administer server groups.. This should be the baseline for us to load activation keys.

Parameters:

user - the user to check on

group - the server group object to authenticate.

Returns:

true if a key can be administered. False otherwise.

validateAccessCredentials

public void validateAccessCredentials(User user,
                                      ServerGroup group,
                                      java.lang.String groupIdentifier)

validates that the given user can access the given ServerGroup object. Raises a permission exception if the combination is invalid..

Parameters:

user - the user to authenticate

group - the servergroup to authenticate

groupIdentifier - id or group name to use when reporting exception (group could be null)

validateAdminCredentials

public void validateAdminCredentials(User user)

validates that the given user can administer a server group. Raises a permission exception if administering is Not possible

Parameters:

user - the user to authenticate

validateOrgAdminCredentials

public void validateOrgAdminCredentials(User user)

validates that the given user can administer or lookup an entitled server group. Raises a permission exception if administering is Not possible

Parameters:

user - the user to authenticate

remove

public void remove(User user,
                   ManagedServerGroup group)

Removes an ServerGroup.

Parameters:

user - user object needed for authentication

group - the group to remove

create

public ManagedServerGroup create(User user,
                                 java.lang.String name,
                                 java.lang.String description)

Create a new Server group

Parameters:

user - user needed for authentication

name - the name of the server group

description - the description of the server group

Returns:

the created server group.

associateOrDissociateAdminsByLoginName

public void associateOrDissociateAdminsByLoginName(ManagedServerGroup group,
                                                   java.util.Collection adminLogins,
                                                   boolean associate,
                                                   User loggedInUser)

Associates/Disocciates a list of admins to a server group by using User's login name.. This method had to be added to give access to a list of users to a server group admin. By default one needs Org Admin role to access/acquire user objects other than the loggedInUser. However according to the UI, Server Group Admin needs to be able to assign Users to Groups. (even if he cannot access the User's details) However our ServerGroup instances need full blown user objects to get mapped correctly.. Due to which this method was added.

Parameters:

group - the Servergroup to associate/dissociate users

adminLogins - the login names of the users to associate/dissociate

associate - true if we want to associate false otherwise.

loggedInUser - the logged in user.

associateAdmins

public void associateAdmins(ManagedServerGroup sg,
                            java.util.Collection admins,
                            User loggedInUser)

Associates a bunch of administrators to a server group

Parameters:

sg - the server group to process

admins - a collection of users to add as administrators

loggedInUser - the loggedInUser needed for credentials

dissociateAdmins

public void dissociateAdmins(ManagedServerGroup sg,
                             java.util.Collection admins,
                             User loggedInUser)

Disssociates a bunch of administrators from a server group

Parameters:

sg - the server group to process

admins - a collection of administrators to deassociate

loggedInUser - the loggedInUser needed for credentials

addServers

public void addServers(ServerGroup sg,
                       java.util.Collection<Server> servers,
                       User loggedInUser)

Associates a bunch of servers to a server group

Parameters:

sg - the server group to process

servers - a collection of servers to add.

loggedInUser - the loggedInUser needed for credentials

removeServers

public void removeServers(ServerGroup sg,
                          java.util.Collection<Server> servers,
                          User loggedInUser)

Dissociates a bunch of servers from a server group

Parameters:

sg - the server group to process

servers - a collection of servers to dissociate

loggedInUser - the loggedInUser needed for credentials

removeServers

public void removeServers(ServerGroup sg,
                          java.util.Collection<Server> servers)

Dissociates a bunch of servers from a server group. **WARNING** This method does not validate the user's access or admin credentials; therefore, it should be used with caution.

Parameters:

sg - the server group to process

servers - a collection of servers to dissociate

listAdministrators

public java.util.List listAdministrators(ManagedServerGroup sg,
                                         User loggedInUser)

Returns the admins of a given servergroup. This list includes ORG ADMINS + Associated Admins.. so this is different from sg.getAssociatedAdmins()

Parameters:

sg - the server group that you want the admin list for.

loggedInUser - the loggedInUser needed for credentials

Returns:

list of User objects that can administer the server group

listNoAdminGroups

public java.util.List listNoAdminGroups(User user)

Returns a list of servergroups that have NO administrators associated to it. Note this requires ORG_ADMIN access so that the administrator can access ALL servergroups.

Parameters:

user - ORG_ADMIN user.

Returns:

a list of server groups

listServers

public java.util.List<Server> listServers(ServerGroup sg)

Returns the servers of a given servergroup

Parameters:

sg - the server group to find the servers of

Returns:

list of Server objects that are a part of the given server group.

listActiveServers

public java.util.List<java.lang.Long> listActiveServers(ServerGroup sg,
                                                        java.lang.Long threshold)

List all servers that have checked in within a X days

Parameters:

sg - the sever group

threshold - the number of days a system needs to have checked in by

Returns:

list of system ids

listInactiveServers

public java.util.List<java.lang.Long> listInactiveServers(ServerGroup sg,
                                                          java.lang.Long threshold)

List all servers that have not checked in in X days

Parameters:

sg - the sever group

threshold - the number of days a system needs to have not checked in by

Returns:

list of system ids

errataCounts

public java.util.Map errataCounts(User user,
                                  ServerGroup group)

Returns counts of applicable errata to given server group.

Parameters:

user - the user to get org from

group - the server group object to get counts

Returns:

map with counts of security, bugfix and enhancement errata