com.redhat.rhn.frontend.xmlrpc.chain

Class ActionChainHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.chain.ActionChainHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class ActionChainHandler
extends BaseHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
ActionChainHandler() Parameters collector.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	addConfigurationDeployment(User loggedInUser, java.lang.String chainLabel, java.lang.Integer serverId, java.util.List<java.lang.Integer> revisions) Deploy configuration.
java.lang.Integer	addErrataUpdate(User loggedInUser, java.lang.Integer serverId, java.util.List<java.lang.Integer> errataIds, java.lang.String chainLabel) Schedule Errata update.
java.lang.Integer	addPackageInstall(User loggedInUser, java.lang.Integer serverId, java.util.List<java.lang.Integer> packages, java.lang.String chainLabel) Schedule package installation to an Action Chain.
java.lang.Integer	addPackageRemoval(User loggedInUser, java.lang.Integer serverId, java.util.List<java.lang.Integer> packages, java.lang.String chainLabel) Adds an action to remove installed packages on the system.
int	addPackageUpgrade(User loggedInUser, java.lang.Integer serverId, java.util.List<java.lang.Integer> packages, java.lang.String chainLabel) Adds an action to upgrade installed packages on the system.
java.lang.Integer	addPackageVerify(User loggedInUser, java.lang.Integer serverId, java.util.List<java.lang.Integer> packages, java.lang.String chainLabel) Adds an action to verify installed packages on the system.
java.lang.Integer	addScriptRun(User loggedInUser, java.lang.Integer serverId, java.lang.String chainLabel, java.lang.String uid, java.lang.String gid, java.lang.Integer timeout, java.lang.String scriptBody) Add a remote command as a script.
java.lang.Integer	addSystemReboot(User loggedInUser, java.lang.Integer serverId, java.lang.String chainLabel) Schedule system reboot.
java.lang.Integer	createChain(User loggedInUser, java.lang.String chainLabel) Create an Action Chain.
java.lang.Integer	deleteChain(User loggedInUser, java.lang.String chainLabel) Remove Action Chains by label.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listChainActions(User loggedInUser, java.lang.String chainLabel) List all actions in the particular Action Chain.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listChains(User loggedInUser) List currently available action chains.
java.lang.Integer	removeAction(User loggedInUser, java.lang.String chainLabel, java.lang.Integer actionId) Remove an action from the Action Chain.
java.lang.Integer	renameChain(User loggedInUser, java.lang.String previousLabel, java.lang.String newLabel) Rename Action Chain.
java.lang.Integer	scheduleChain(User loggedInUser, java.lang.String chainLabel, java.util.Date date) Schedule action chain.

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

ActionChainHandler

public ActionChainHandler()

Parameters collector.

Method Detail

listChains

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> listChains(User loggedInUser)

List currently available action chains.

Parameters:

loggedInUser - The current user

Returns:

list of action chains.

listChainActions

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> listChainActions(User loggedInUser,
                                                                                         java.lang.String chainLabel)

List all actions in the particular Action Chain.

Parameters:

loggedInUser - The current user

chainLabel - The label of the Action Chain.

Returns:

List of entries in the particular action chain, if any.

removeAction

public java.lang.Integer removeAction(User loggedInUser,
                                      java.lang.String chainLabel,
                                      java.lang.Integer actionId)

Remove an action from the Action Chain.

Parameters:

loggedInUser - The current user

chainLabel - The label of the Action Chain.

actionId - Action ID.

Returns:

1 if successful, exception otherwise

deleteChain

public java.lang.Integer deleteChain(User loggedInUser,
                                     java.lang.String chainLabel)

Remove Action Chains by label.

Parameters:

loggedInUser - The current user

chainLabel - Action Chain label.

Returns:

1 if successful, exception otherwise

createChain

public java.lang.Integer createChain(User loggedInUser,
                                     java.lang.String chainLabel)

Create an Action Chain.

Parameters:

loggedInUser - The current user

chainLabel - Label of the action chain

Returns:

id of the created action chain

addSystemReboot

public java.lang.Integer addSystemReboot(User loggedInUser,
                                         java.lang.Integer serverId,
                                         java.lang.String chainLabel)

Schedule system reboot.

Parameters:

loggedInUser - The current user

serverId - Server ID.

chainLabel - Label of the action chain

Returns:

list of action ids, exception thrown otherwise

addErrataUpdate

public java.lang.Integer addErrataUpdate(User loggedInUser,
                                         java.lang.Integer serverId,
                                         java.util.List<java.lang.Integer> errataIds,
                                         java.lang.String chainLabel)

Schedule Errata update.

Parameters:

loggedInUser - The current user

serverId - Server ID.

errataIds - a list of erratas IDs

chainLabel - Label of the action chain

Returns:

action id if successful, exception otherwise

addPackageRemoval

public java.lang.Integer addPackageRemoval(User loggedInUser,
                                           java.lang.Integer serverId,
                                           java.util.List<java.lang.Integer> packages,
                                           java.lang.String chainLabel)

Adds an action to remove installed packages on the system.

Parameters:

loggedInUser - The current user

serverId - System ID

packages - List of packages

chainLabel - Label of the action chain

Returns:

list of action ids, exception thrown otherwise

addPackageInstall

public java.lang.Integer addPackageInstall(User loggedInUser,
                                           java.lang.Integer serverId,
                                           java.util.List<java.lang.Integer> packages,
                                           java.lang.String chainLabel)

Schedule package installation to an Action Chain.

Parameters:

loggedInUser - The current user

serverId - System ID.

packages - List of packages.

chainLabel - Label of the Action Chain.

Returns:

True or false in XML-RPC representation: 1 or 0 respectively.

addPackageVerify

public java.lang.Integer addPackageVerify(User loggedInUser,
                                          java.lang.Integer serverId,
                                          java.util.List<java.lang.Integer> packages,
                                          java.lang.String chainLabel)

Adds an action to verify installed packages on the system.

Parameters:

loggedInUser - The current user

serverId - System ID

packages - List of packages

chainLabel - Label of the action chain

Returns:

True or false in XML-RPC representation (1 or 0 respectively)

addPackageUpgrade

public int addPackageUpgrade(User loggedInUser,
                             java.lang.Integer serverId,
                             java.util.List<java.lang.Integer> packages,
                             java.lang.String chainLabel)

Adds an action to upgrade installed packages on the system.

Parameters:

loggedInUser - The current user

serverId - System ID

packages - List of packages

chainLabel - Label of the action chain

Returns:

True or false in XML-RPC representation (1 or 0 respectively)

addScriptRun

public java.lang.Integer addScriptRun(User loggedInUser,
                                      java.lang.Integer serverId,
                                      java.lang.String chainLabel,
                                      java.lang.String uid,
                                      java.lang.String gid,
                                      java.lang.Integer timeout,
                                      java.lang.String scriptBody)

Add a remote command as a script.

Parameters:

loggedInUser - The current user

serverId - System ID

chainLabel - Label of the action chain.

uid - User ID on the remote system.

scriptBody - Base64 encoded script.

gid - Group ID on the remote system.

timeout - Timeout

Returns:

True or false in XML-RPC representation (1 or 0 respectively)

scheduleChain

public java.lang.Integer scheduleChain(User loggedInUser,
                                       java.lang.String chainLabel,
                                       java.util.Date date)

Schedule action chain.

Parameters:

loggedInUser - The current user

chainLabel - Label of the action chain

date - Earliest date

Returns:

1 if successful, exception otherwise

addConfigurationDeployment

public java.lang.Integer addConfigurationDeployment(User loggedInUser,
                                                    java.lang.String chainLabel,
                                                    java.lang.Integer serverId,
                                                    java.util.List<java.lang.Integer> revisions)

Deploy configuration.

Parameters:

loggedInUser - The current user

chainLabel - Label of the action chain

serverId - System ID

revisions - List of configuration revisions.

Returns:

1 if successful, exception otherwise

renameChain

public java.lang.Integer renameChain(User loggedInUser,
                                     java.lang.String previousLabel,
                                     java.lang.String newLabel)

Rename Action Chain.

Parameters:

loggedInUser - The current user

previousLabel - Previous (existing) label of the Action Chain

newLabel - New (desired) label of the Action Chain

Returns:

1 if successful, exception otherwise