com.redhat.rhn.frontend.xmlrpc.systemgroup

Class ServerGroupHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.systemgroup.ServerGroupHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class ServerGroupHandler
extends BaseHandler

ServerGroupHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
ServerGroupHandler()

Method Summary

Modifier and Type	Method and Description
int	addOrRemoveAdmins(User loggedInUser, java.lang.String systemGroupName, java.util.List<java.lang.String> loginNames, boolean add) Given a systemGroupName and a list of users this call adds or removes them as system administrators Note one needs to be an Org Admin to perform this operation..
int	addOrRemoveSystems(User loggedInUser, java.lang.String systemGroupName, java.util.List serverIds, java.lang.Boolean add) Associates a list of servers to a given group
ServerGroup	create(User loggedInUser, java.lang.String name, java.lang.String description) Creates a new system group..
int	delete(User loggedInUser, java.lang.String systemGroupName) Deletes a given system group - given the system group name
ServerGroup	getDetails(User loggedInUser, java.lang.Integer systemGroupId)
ServerGroup	getDetails(User loggedInUser, java.lang.String systemGroupName)
java.util.List<java.lang.Long>	listActiveSystemsInGroup(User loggedInUser, java.lang.String systemGroupName) Lists active systems in a server group using the default inactivity time (Currently 1 day)
java.util.List	listAdministrators(User loggedInUser, java.lang.String systemGroupName) Given a systemGroupName this call returns the list of users who can administer the group.
java.util.List<ManagedServerGroup>	listAllGroups(User loggedInUser) List all groups accessible by the logged in user
java.util.List	listGroupsWithNoAssociatedAdmins(User loggedInUser) Returns a list of system groups that do not have a NON-OrgAdmin administrator..
java.util.List<java.lang.Long>	listInactiveSystemsInGroup(User loggedInUser, java.lang.String systemGroupName) Lists inactive systems in a server group using the default inactivity time (Currently 1 day)
java.util.List<java.lang.Long>	listInactiveSystemsInGroup(User loggedInUser, java.lang.String systemGroupName, java.lang.Integer daysInactive) Lists inactive systems in a server group using the specified time
java.util.List	listSystems(User loggedInUser, java.lang.String systemGroupName) List the systems that are associated to the given system group.
java.util.List<SystemOverview>	listSystemsMinimal(User loggedInUser, java.lang.String systemGroupName) List the systems that are associated to the given system group.
java.util.List<java.lang.Long>	scheduleApplyErrataToActive(User loggedInUser, java.lang.String systemGroupName, java.util.List errataIds) Schedules an action to apply errata updates to active systems from a group.
java.util.List<java.lang.Long>	scheduleApplyErrataToActive(User loggedInUser, java.lang.String systemGroupName, java.util.List<java.lang.Integer> errataIds, java.util.Date earliestOccurrence) Schedules an action to apply errata updates to active systems from a group at a specified time.
ServerGroup	update(User loggedInUser, java.lang.String systemGroupName, java.lang.String description) Updates a system group.

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

ServerGroupHandler

public ServerGroupHandler()

Method Detail

listAdministrators

public java.util.List listAdministrators(User loggedInUser,
                                         java.lang.String systemGroupName)

Given a systemGroupName this call returns the list of users who can administer the group. One has to be a SystemGroupAdmin or an Org Admin to obtain this list..

Parameters:

loggedInUser - The current user

systemGroupName - the name of the system group

Returns:

a list of users who can administer this system group.

addOrRemoveAdmins

public int addOrRemoveAdmins(User loggedInUser,
                             java.lang.String systemGroupName,
                             java.util.List<java.lang.String> loginNames,
                             boolean add)

Given a systemGroupName and a list of users this call adds or removes them as system administrators Note one needs to be an Org Admin to perform this operation..

Parameters:

loggedInUser - The current user

systemGroupName - the name of the system group

loginNames - login names of users to be made admins..

add - a boolean to associate or dissociate admins from the group

Returns:

1 if the operation succeed 1 Exception other wise.

listSystems

public java.util.List listSystems(User loggedInUser,
                                  java.lang.String systemGroupName)

List the systems that are associated to the given system group.

Parameters:

loggedInUser - The current user

systemGroupName - the name of the system group

Returns:

a list of systems associated to a given system group.

listSystemsMinimal

public java.util.List<SystemOverview> listSystemsMinimal(User loggedInUser,
                                                         java.lang.String systemGroupName)

List the systems that are associated to the given system group.

Parameters:

loggedInUser - The current user

systemGroupName - the name of the system group

Returns:

a list of systems associated to a given system group.

addOrRemoveSystems

public int addOrRemoveSystems(User loggedInUser,
                              java.lang.String systemGroupName,
                              java.util.List serverIds,
                              java.lang.Boolean add)

Associates a list of servers to a given group

Parameters:

loggedInUser - The current user

systemGroupName - The name system group to whom you want to add servers

serverIds - a list of ids of the servers you wish to add to this group.

add - should this server be associated or dissociated to this group.

Returns:

Returns 1 if successful, exception otherwise

create

public ServerGroup create(User loggedInUser,
                          java.lang.String name,
                          java.lang.String description)

Creates a new system group.. User needs to be a System Group Admin or an OrgAdmin to be able to create new system groups.

Parameters:

loggedInUser - The current user

name - The name of the system group.. Note duplicates names cannot be created and will be responded to with an exception.

description - The description of a system group.

Returns:

the name of the system group created.

delete

public int delete(User loggedInUser,
                  java.lang.String systemGroupName)

Deletes a given system group - given the system group name

Parameters:

loggedInUser - The current user

systemGroupName - the name of the system group

Returns:

1 for success exception other wise.

update

public ServerGroup update(User loggedInUser,
                          java.lang.String systemGroupName,
                          java.lang.String description)

Updates a system group. User needs to be a System Group Admin or an OrgAdmin to be able to create new system groups.

Parameters:

loggedInUser - The current user

systemGroupName - The name of the system group that needs to updated..

description - The description of the system group.

Returns:

the updated system group.

listGroupsWithNoAssociatedAdmins

public java.util.List listGroupsWithNoAssociatedAdmins(User loggedInUser)

Returns a list of system groups that do not have a NON-OrgAdmin administrator.. Org admins implicitly have access to all system groups, so this call would not make sense for those cases.. Note the caller must be an orgadmin to get this information..

Parameters:

loggedInUser - The current user

Returns:

List of ServerGroups that do not have an associated admin.

listAllGroups

public java.util.List<ManagedServerGroup> listAllGroups(User loggedInUser)

List all groups accessible by the logged in user

Parameters:

loggedInUser - The current user

Returns:

a list of ServerGroup objects

getDetails

public ServerGroup getDetails(User loggedInUser,
                              java.lang.Integer systemGroupId)
                       throws FaultException

Parameters:

loggedInUser - The current user

systemGroupId - Integer id of system group to look up

Returns:

ServerGroup object

Throws:

FaultException - A FaultException is thrown if the server group corresponding to systemGroupId cannot be retrieved.

getDetails

public ServerGroup getDetails(User loggedInUser,
                              java.lang.String systemGroupName)
                       throws FaultException

Parameters:

loggedInUser - The current user

systemGroupName - Name of the system group to lookup

Returns:

ServerGroup object

Throws:

FaultException - A FaultException is thrown if the server group corresponding to systemGroupName cannot be retrieved.

listActiveSystemsInGroup

public java.util.List<java.lang.Long> listActiveSystemsInGroup(User loggedInUser,
                                                               java.lang.String systemGroupName)

Lists active systems in a server group using the default inactivity time (Currently 1 day)

Parameters:

loggedInUser - The current user

systemGroupName - the system group

Returns:

List of system ids that are active

listInactiveSystemsInGroup

public java.util.List<java.lang.Long> listInactiveSystemsInGroup(User loggedInUser,
                                                                 java.lang.String systemGroupName,
                                                                 java.lang.Integer daysInactive)

Lists inactive systems in a server group using the specified time

Parameters:

loggedInUser - The current user

systemGroupName - the system group

daysInactive - number of days a system has to not check in to be inactive

Returns:

List of system ids that are active

listInactiveSystemsInGroup

public java.util.List<java.lang.Long> listInactiveSystemsInGroup(User loggedInUser,
                                                                 java.lang.String systemGroupName)

Lists inactive systems in a server group using the default inactivity time (Currently 1 day)

Parameters:

loggedInUser - The current user

systemGroupName - the system group

Returns:

List of system ids that are active

scheduleApplyErrataToActive

public java.util.List<java.lang.Long> scheduleApplyErrataToActive(User loggedInUser,
                                                                  java.lang.String systemGroupName,
                                                                  java.util.List errataIds)

Schedules an action to apply errata updates to active systems from a group.

Parameters:

loggedInUser - The current user

systemGroupName - the system group

errataIds - List of errata IDs to apply (as Integers)

Returns:

list of action ids, exception thrown otherwise

Since:

13.0

scheduleApplyErrataToActive

public java.util.List<java.lang.Long> scheduleApplyErrataToActive(User loggedInUser,
                                                                  java.lang.String systemGroupName,
                                                                  java.util.List<java.lang.Integer> errataIds,
                                                                  java.util.Date earliestOccurrence)

Schedules an action to apply errata updates to active systems from a group at a specified time.

Parameters:

loggedInUser - The current user

systemGroupName - the system group

errataIds - List of errata IDs to apply (as Integers)

earliestOccurrence - Earliest occurrence of the errata update

Returns:

list of action ids, exception thrown otherwise

Since:

13.0