com.redhat.rhn.frontend.xmlrpc.schedule

Class ScheduleHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.schedule.ScheduleHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class ScheduleHandler
extends BaseHandler

ScheduleHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
ScheduleHandler()

Method Summary

Modifier and Type	Method and Description
int	archiveActions(User loggedInUser, java.util.List<java.lang.Integer> actionIds) Archive all actions in the given list.
int	cancelActions(User loggedInUser, java.util.List<java.lang.Integer> actionIds) Cancel all actions in given list.
int	deleteActions(User loggedInUser, java.util.List<java.lang.Integer> actionIds) Delete all archived actions in the given list.
int	failSystemAction(User loggedInUser, java.lang.Integer serverId, java.lang.Integer actionId) Fail specific event on specified system
int	failSystemAction(User loggedInUser, java.lang.Integer serverId, java.lang.Integer actionId, java.lang.String message) Fail specific event on specified system and let the user provide some info for this fail.
java.lang.Object[]	listAllActions(User loggedInUser) List all scheduled actions regardless of status.
java.lang.Object[]	listArchivedActions(User loggedInUser) List the scheduled actions that have been archived.
java.lang.Object[]	listCompletedActions(User loggedInUser) List the scheduled actions that have succeeded.
java.lang.Object[]	listCompletedSystems(User loggedInUser, java.lang.Integer actionId) List the systems that have completed a specific action.
java.lang.Object[]	listFailedActions(User loggedInUser) List the scheduled actions that have failed.
java.lang.Object[]	listFailedSystems(User loggedInUser, java.lang.Integer actionId) List the systems that have failed a specific action.
java.lang.Object[]	listInProgressActions(User loggedInUser) List the scheduled actions that are in progress.
java.lang.Object[]	listInProgressSystems(User loggedInUser, java.lang.Integer actionId) List the systems that have a specific action in progress.
int	rescheduleActions(User loggedInUser, java.util.List<java.lang.Integer> actionIds, boolean onlyFailed) Reschedule all actions in the given list.

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

ScheduleHandler

public ScheduleHandler()

Method Detail

cancelActions

public int cancelActions(User loggedInUser,
                         java.util.List<java.lang.Integer> actionIds)
                  throws ActionIsChildException,
                         LookupException

Cancel all actions in given list. If an invalid action is provided, none of the actions given will canceled.

Parameters:

loggedInUser - The current user

actionIds - The list of ids for actions to cancel.

Returns:

Returns a list of actions with details

Throws:

ActionIsChildException - Thrown when attempting to cancel action with prerequisites

LookupException - Invalid Action ID provided

failSystemAction

public int failSystemAction(User loggedInUser,
                            java.lang.Integer serverId,
                            java.lang.Integer actionId)

Fail specific event on specified system

Parameters:

loggedInUser - The current user

serverId - server id

actionId - action id

Returns:

int 1 if successfull

failSystemAction

public int failSystemAction(User loggedInUser,
                            java.lang.Integer serverId,
                            java.lang.Integer actionId,
                            java.lang.String message)

Fail specific event on specified system and let the user provide some info for this fail.

Parameters:

loggedInUser - The current user

serverId - server id

actionId - action id

message - some info about this fail

Returns:

int 1 if successfull

listAllActions

public java.lang.Object[] listAllActions(User loggedInUser)

List all scheduled actions regardless of status. This includes pending, completed, failed and archived.

Parameters:

loggedInUser - The current user

Returns:

Returns a list of actions with details

listCompletedActions

public java.lang.Object[] listCompletedActions(User loggedInUser)

List the scheduled actions that have succeeded.

Parameters:

loggedInUser - The current user

Returns:

Returns a list of actions with details

listInProgressActions

public java.lang.Object[] listInProgressActions(User loggedInUser)

List the scheduled actions that are in progress.

Parameters:

loggedInUser - The current user

Returns:

Returns a list of actions with details

listFailedActions

public java.lang.Object[] listFailedActions(User loggedInUser)

List the scheduled actions that have failed.

Parameters:

loggedInUser - The current user

Returns:

Returns a list of actions with details

listArchivedActions

public java.lang.Object[] listArchivedActions(User loggedInUser)

List the scheduled actions that have been archived.

Parameters:

loggedInUser - The current user

Returns:

Returns a list of actions with details

listCompletedSystems

public java.lang.Object[] listCompletedSystems(User loggedInUser,
                                               java.lang.Integer actionId)

List the systems that have completed a specific action.

Parameters:

loggedInUser - The current user

actionId - The id of the action.

Returns:

Returns a list of systems along with details

listInProgressSystems

public java.lang.Object[] listInProgressSystems(User loggedInUser,
                                                java.lang.Integer actionId)

List the systems that have a specific action in progress.

Parameters:

loggedInUser - The current user

actionId - The id of the action.

Returns:

Returns a list of systems along with details

listFailedSystems

public java.lang.Object[] listFailedSystems(User loggedInUser,
                                            java.lang.Integer actionId)

List the systems that have failed a specific action.

Parameters:

loggedInUser - The current user

actionId - The id of the action.

Returns:

Returns a list of systems along with details

rescheduleActions

public int rescheduleActions(User loggedInUser,
                             java.util.List<java.lang.Integer> actionIds,
                             boolean onlyFailed)
                      throws FaultException

Reschedule all actions in the given list.

Parameters:

loggedInUser - The current user

actionIds - The list of ids for actions to reschedule.

onlyFailed - only reschedule failed actions

Returns:

Returns a list of actions with details

Throws:

FaultException - A FaultException is thrown if one of the actions provided is invalid.

archiveActions

public int archiveActions(User loggedInUser,
                          java.util.List<java.lang.Integer> actionIds)
                   throws FaultException

Archive all actions in the given list.

Parameters:

loggedInUser - The current user

actionIds - The list of ids for actions to archive.

Returns:

Returns a integer 1 on success

Throws:

FaultException - A FaultException is thrown if one of the actions provided is invalid.

deleteActions

public int deleteActions(User loggedInUser,
                         java.util.List<java.lang.Integer> actionIds)

Delete all archived actions in the given list.

Parameters:

loggedInUser - The current user

actionIds - The list of ids for actions to delete.

Returns:

Returns a integer 1 on success

Throws:

FaultException - In case of an error