com.redhat.rhn.frontend.xmlrpc.kickstart.profile

Class ProfileHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.kickstart.profile.ProfileHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class ProfileHandler
extends BaseHandler

ProfileHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
ProfileHandler()

Method Summary

Modifier and Type	Method and Description
int	addIpRange(User loggedInUser, java.lang.String ksLabel, java.lang.String min, java.lang.String max) Add an ip range to a kickstart.
int	addScript(User loggedInUser, java.lang.String ksLabel, java.lang.String name, java.lang.String contents, java.lang.String interpreter, java.lang.String type, boolean chroot) Add a script to a kickstart profile
int	addScript(User loggedInUser, java.lang.String ksLabel, java.lang.String name, java.lang.String contents, java.lang.String interpreter, java.lang.String type, boolean chroot, boolean template) Add a script to a kickstart profile
int	addScript(User loggedInUser, java.lang.String ksLabel, java.lang.String name, java.lang.String contents, java.lang.String interpreter, java.lang.String type, boolean chroot, boolean template, boolean erroronfail) Add a script to a kickstart profile
java.util.Map<java.lang.String,java.util.List<ActivationKey>>	compareActivationKeys(User loggedInUser, java.lang.String kickstartLabel1, java.lang.String kickstartLabel2) Returns a list for each kickstart profile of activation keys that are present in that profile but not the other.
java.util.Map<java.lang.String,java.util.List<KickstartOptionValue>>	compareAdvancedOptions(User loggedInUser, java.lang.String kickstartLabel1, java.lang.String kickstartLabel2) Returns a list for each kickstart profile of properties that are different between the profiles.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	comparePackages(User loggedInUser, java.lang.String kickstartLabel1, java.lang.String kickstartLabel2) Returns a list for each kickstart profile of package names that are present in that profile but not the other.
java.lang.String	downloadKickstart(User loggedInUser, java.lang.String ksLabel, java.lang.String host) returns the fully formatted kickstart file
java.lang.String	downloadRenderedKickstart(User loggedInUser, java.lang.String ksLabel) returns the Cobbler-rendered kickstart file
java.lang.Object[]	getAdvancedOptions(User loggedInUser, java.lang.String ksLabel) Get advanced options for existing kickstart profile.
java.lang.String[]	getAvailableRepositories(User loggedInUser, java.lang.String ksLabel)
java.lang.Boolean	getCfgPreservation(User loggedInUser, java.lang.String kslabel) Get the option to perserve ks.cfg.
java.util.List<java.lang.String>	getChildChannels(User loggedInUser, java.lang.String kslabel) Get the child channels for a kickstart profile.
java.lang.Object[]	getCustomOptions(User loggedInUser, java.lang.String ksLabel) Get custom options for a kickstart profile.
java.lang.String	getKickstartTree(User loggedInUser, java.lang.String kslabel) Get the kickstart tree for a kickstart profile.
java.lang.String[]	getRepositories(User loggedInUser, java.lang.String ksLabel)
java.lang.String	getUpdateType(User loggedInUser, java.lang.String kslabel) Get the update type for a kickstart profile.
java.util.Map<java.lang.String,java.lang.Object>	getVariables(User loggedInUser, java.lang.String ksLabel) Returns a list of kickstart variables associated with the specified kickstart profile
java.lang.String	getVirtualizationType(User loggedInUser, java.lang.String ksLabel)
java.util.Set	listIpRanges(User loggedInUser, java.lang.String ksLabel) Lists all ip ranges for a kickstart profile.
java.util.List<KickstartScript>	listScripts(User loggedInUser, java.lang.String label) List the pre and post scripts for a kickstart profile in the order they will run during the kickstart.
int	orderScripts(User loggedInUser, java.lang.String ksLabel, java.util.List<java.lang.Integer> preScripts, java.util.List<java.lang.Integer> postScriptsBeforeRegistration, java.util.List<java.lang.Integer> postScriptsAfterRegistration) Change the order that kickstart scripts will run for this kickstart profile.
int	removeIpRange(User loggedInUser, java.lang.String ksLabel, java.lang.String ipAddress) Remove an ip range from a kickstart profile.
int	removeScript(User loggedInUser, java.lang.String ksLabel, java.lang.Integer id) Remove a script from a kickstart profile.
int	setAdvancedOptions(User loggedInUser, java.lang.String ksLabel, java.util.List<java.util.Map> options) Set advanced options in a kickstart profile
int	setCfgPreservation(User loggedInUser, java.lang.String kslabel, boolean preserve) Set the option to perserve ks.cfg.
int	setChildChannels(User loggedInUser, java.lang.String kslabel, java.util.List<java.lang.String> channelLabels) Set the child channels for a kickstart profile.
int	setCustomOptions(User loggedInUser, java.lang.String ksLabel, java.util.List<java.lang.String> options) Set custom options for a kickstart profile.
int	setKickstartTree(User loggedInUser, java.lang.String kslabel, java.lang.String kstreeLabel) Set the kickstart tree for a kickstart profile.
int	setLogging(User loggedInUser, java.lang.String kslabel, boolean pre, boolean post) Set the logging (Pre and post) for a kickstart file
int	setRepositories(User loggedInUser, java.lang.String ksLabel, java.util.List<java.lang.String> reposIn)
int	setUpdateType(User loggedInUser, java.lang.String kslabel, java.lang.String updateType) Set the update type for a kickstart profile.
int	setVariables(User loggedInUser, java.lang.String ksLabel, java.util.Map<java.lang.String,java.lang.Object> variables) Associates list of kickstart variables with the specified kickstart profile
int	setVirtualizationType(User loggedInUser, java.lang.String ksLabel, java.lang.String typeLabel)

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

ProfileHandler

public ProfileHandler()

Method Detail

getKickstartTree

public java.lang.String getKickstartTree(User loggedInUser,
                                         java.lang.String kslabel)

Get the kickstart tree for a kickstart profile.

Parameters:

loggedInUser - The current user

kslabel - label of the kickstart profile to be changed.

Returns:

kickstart tree label

getUpdateType

public java.lang.String getUpdateType(User loggedInUser,
                                      java.lang.String kslabel)

Get the update type for a kickstart profile.

Parameters:

loggedInUser - The current user

kslabel - label of the kickstart profile to be changed.

Returns:

kickstart tree label

getCfgPreservation

public java.lang.Boolean getCfgPreservation(User loggedInUser,
                                            java.lang.String kslabel)

Get the option to perserve ks.cfg.

Parameters:

loggedInUser - The current user

kslabel - the kickstart label

Returns:

Boolean value of the option

setCfgPreservation

public int setCfgPreservation(User loggedInUser,
                              java.lang.String kslabel,
                              boolean preserve)

Set the option to perserve ks.cfg.

Parameters:

loggedInUser - The current user

kslabel - the kickstart label

preserve - whether to perserve ks.cfg or not

Returns:

int 1 for success

setLogging

public int setLogging(User loggedInUser,
                      java.lang.String kslabel,
                      boolean pre,
                      boolean post)

Set the logging (Pre and post) for a kickstart file

Parameters:

loggedInUser - The current user

kslabel - the kickstart label

pre - whether to log pre scripts or not

post - whether to log post scripts or not

Returns:

int 1 for success

setKickstartTree

public int setKickstartTree(User loggedInUser,
                            java.lang.String kslabel,
                            java.lang.String kstreeLabel)

Set the kickstart tree for a kickstart profile.

Parameters:

loggedInUser - The current user

kslabel - label of the kickstart profile to be changed.

kstreeLabel - label of the new kickstart tree.

Returns:

1 if successful, exception otherwise.

setUpdateType

public int setUpdateType(User loggedInUser,
                         java.lang.String kslabel,
                         java.lang.String updateType)

Set the update type for a kickstart profile.

Parameters:

loggedInUser - The current user

kslabel - label of the kickstart profile to be changed.

updateType - the new update type.

Returns:

1 if successful, exception otherwise.

getChildChannels

public java.util.List<java.lang.String> getChildChannels(User loggedInUser,
                                                         java.lang.String kslabel)

Get the child channels for a kickstart profile.

Parameters:

loggedInUser - The current user

kslabel - label of the kickstart profile to be updated.

Returns:

list of child channels associated with the profile.

setChildChannels

public int setChildChannels(User loggedInUser,
                            java.lang.String kslabel,
                            java.util.List<java.lang.String> channelLabels)

Set the child channels for a kickstart profile.

Parameters:

loggedInUser - The current user

kslabel - label of the kickstart profile to be updated.

channelLabels - labels of the child channels to be set in the kickstart profile.

Returns:

1 if successful, exception otherwise.

listScripts

public java.util.List<KickstartScript> listScripts(User loggedInUser,
                                                   java.lang.String label)

List the pre and post scripts for a kickstart profile in the order they will run during the kickstart.

Parameters:

loggedInUser - The current user

label - the kickstart label

Returns:

list of kickstartScript objects

orderScripts

public int orderScripts(User loggedInUser,
                        java.lang.String ksLabel,
                        java.util.List<java.lang.Integer> preScripts,
                        java.util.List<java.lang.Integer> postScriptsBeforeRegistration,
                        java.util.List<java.lang.Integer> postScriptsAfterRegistration)

Change the order that kickstart scripts will run for this kickstart profile. Scripts will run in the order they appear in the array. There are three arrays, one for all pre scripts, one for the post scripts that run before registration and server actions happen, and one for post scripts that run after registration and server actinos. All scripts must be included in one of these lists, as appropriate.

Parameters:

loggedInUser - The current user

ksLabel - the kickstart label

preScripts - the ordered list of pre scripts

postScriptsBeforeRegistration - the ordered list of post scripts that run before registration

postScriptsAfterRegistration - the ordered list of post scripts that run after registration

Returns:

1 on success

addScript

public int addScript(User loggedInUser,
                     java.lang.String ksLabel,
                     java.lang.String name,
                     java.lang.String contents,
                     java.lang.String interpreter,
                     java.lang.String type,
                     boolean chroot)

Add a script to a kickstart profile

Parameters:

loggedInUser - The current user

ksLabel - the kickstart label

name - name of the script

contents - the contents

interpreter - the script interpreter to use

type - "pre" or "post"

chroot - true if you want it to be chrooted

Returns:

the id of the created script

addScript

public int addScript(User loggedInUser,
                     java.lang.String ksLabel,
                     java.lang.String name,
                     java.lang.String contents,
                     java.lang.String interpreter,
                     java.lang.String type,
                     boolean chroot,
                     boolean template)

Add a script to a kickstart profile

Parameters:

loggedInUser - The current user

ksLabel - the kickstart label

name - name of the script

contents - the contents

interpreter - the script interpreter to use

type - "pre" or "post"

chroot - true if you want it to be chrooted

template - enable templating using cobbler

Returns:

the id of the created script

addScript

public int addScript(User loggedInUser,
                     java.lang.String ksLabel,
                     java.lang.String name,
                     java.lang.String contents,
                     java.lang.String interpreter,
                     java.lang.String type,
                     boolean chroot,
                     boolean template,
                     boolean erroronfail)

Add a script to a kickstart profile

Parameters:

loggedInUser - The current user

ksLabel - the kickstart label

name - name of the script

contents - the contents

interpreter - the script interpreter to use

type - "pre" or "post"

chroot - true if you want it to be chrooted

template - enable templating using cobbler

erroronfail - Whether to throw an error if the script fails or not

Returns:

the id of the created script

removeScript

public int removeScript(User loggedInUser,
                        java.lang.String ksLabel,
                        java.lang.Integer id)

Remove a script from a kickstart profile.

Parameters:

loggedInUser - The current user

ksLabel - the kickstart to remove a script from

id - the id of the kickstart

Returns:

1 on success

downloadKickstart

public java.lang.String downloadKickstart(User loggedInUser,
                                          java.lang.String ksLabel,
                                          java.lang.String host)

returns the fully formatted kickstart file

Parameters:

loggedInUser - The current user

ksLabel - the label to download

host - The host/ip to use when referring to the server itself

Returns:

the kickstart file

downloadRenderedKickstart

public java.lang.String downloadRenderedKickstart(User loggedInUser,
                                                  java.lang.String ksLabel)

returns the Cobbler-rendered kickstart file

Parameters:

loggedInUser - The current user

ksLabel - the label to download

Returns:

the kickstart file

getAdvancedOptions

public java.lang.Object[] getAdvancedOptions(User loggedInUser,
                                             java.lang.String ksLabel)
                                      throws FaultException

Get advanced options for existing kickstart profile.

Parameters:

loggedInUser - The current user

ksLabel - label of the kickstart profile to be updated.

Returns:

An array of advanced options

Throws:

FaultException - A FaultException is thrown if the profile associated with ksLabel cannot be found

setAdvancedOptions

public int setAdvancedOptions(User loggedInUser,
                              java.lang.String ksLabel,
                              java.util.List<java.util.Map> options)
                       throws FaultException

Set advanced options in a kickstart profile

Parameters:

loggedInUser - The current user

ksLabel - the kickstart label

options - the advanced options to set

Returns:

1 if success, exception otherwise

Throws:

FaultException - A FaultException is thrown if the profile associated with ksLabel cannot be found or invalid advanced option is provided

getCustomOptions

public java.lang.Object[] getCustomOptions(User loggedInUser,
                                           java.lang.String ksLabel)
                                    throws FaultException

Get custom options for a kickstart profile.

Parameters:

loggedInUser - The current user

ksLabel - the kickstart label

Returns:

a list of hashes holding this info.

Throws:

FaultException - A FaultException is thrown if the profile associated with ksLabel cannot be found

setCustomOptions

public int setCustomOptions(User loggedInUser,
                            java.lang.String ksLabel,
                            java.util.List<java.lang.String> options)
                     throws FaultException

Set custom options for a kickstart profile.

Parameters:

loggedInUser - The current user

ksLabel - the kickstart label

options - the custom options to set

Returns:

a int being the number of options set

Throws:

FaultException - A FaultException is thrown if the profile associated with ksLabel cannot be found

listIpRanges

public java.util.Set listIpRanges(User loggedInUser,
                                  java.lang.String ksLabel)

Lists all ip ranges for a kickstart profile.

Parameters:

loggedInUser - The current user

ksLabel - the label of the kickstart

Returns:

List of KickstartIpRange objects

addIpRange

public int addIpRange(User loggedInUser,
                      java.lang.String ksLabel,
                      java.lang.String min,
                      java.lang.String max)

Add an ip range to a kickstart.

Parameters:

loggedInUser - The current user

ksLabel - the kickstart label

min - the min ip address of the range

max - the max ip address of the range

Returns:

1 on success

removeIpRange

public int removeIpRange(User loggedInUser,
                         java.lang.String ksLabel,
                         java.lang.String ipAddress)

Remove an ip range from a kickstart profile.

Parameters:

loggedInUser - The current user

ksLabel - the kickstart to remove an ip range from

ipAddress - an ip address in the range that you want to remove

Returns:

1 on removal, 0 if not found, exception otherwise

compareActivationKeys

public java.util.Map<java.lang.String,java.util.List<ActivationKey>> compareActivationKeys(User loggedInUser,
                                                                                           java.lang.String kickstartLabel1,
                                                                                           java.lang.String kickstartLabel2)

Returns a list for each kickstart profile of activation keys that are present in that profile but not the other.

Parameters:

loggedInUser - The current user

kickstartLabel1 - identifies a profile to be compared; cannot be null

kickstartLabel2 - identifies a profile to be compared; cannot be null

Returns:

map of kickstart label to a list of keys in that profile but not in the other; if no keys match the criteria the list will be empty

comparePackages

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> comparePackages(User loggedInUser,
                                                                                       java.lang.String kickstartLabel1,
                                                                                       java.lang.String kickstartLabel2)

Returns a list for each kickstart profile of package names that are present in that profile but not the other.

Parameters:

loggedInUser - The current user cannot be null

kickstartLabel1 - identifies a profile to be compared; cannot be null

kickstartLabel2 - identifies a profile to be compared; cannot be null

Returns:

map of kickstart label to a list of package names in that profile but not in the other; if no keys match the criteria the list will be empty

compareAdvancedOptions

public java.util.Map<java.lang.String,java.util.List<KickstartOptionValue>> compareAdvancedOptions(User loggedInUser,
                                                                                                   java.lang.String kickstartLabel1,
                                                                                                   java.lang.String kickstartLabel2)

Returns a list for each kickstart profile of properties that are different between the profiles. Each property that is not equal between the two profiles will be present in both lists with the current values for its respective profile.

Parameters:

loggedInUser - The current user cannot be null

kickstartLabel1 - identifies a profile to be compared; cannot be null

kickstartLabel2 - identifies a profile to be compared; cannot be null

Returns:

map of kickstart label to a list of properties and their values whose values are different for each profile

getVariables

public java.util.Map<java.lang.String,java.lang.Object> getVariables(User loggedInUser,
                                                                     java.lang.String ksLabel)

Returns a list of kickstart variables associated with the specified kickstart profile

Parameters:

loggedInUser - The current user cannot be null

ksLabel - identifies the kickstart profile cannot be null

Returns:

map of kickstart variables associated with the specified kickstart

setVariables

public int setVariables(User loggedInUser,
                        java.lang.String ksLabel,
                        java.util.Map<java.lang.String,java.lang.Object> variables)

Associates list of kickstart variables with the specified kickstart profile

Parameters:

loggedInUser - The current user cannot be null

ksLabel - identifies the kickstart profile cannot be null

variables - list of variables to set

Returns:

int - 1 on success, exception thrown otherwise

getAvailableRepositories

public java.lang.String[] getAvailableRepositories(User loggedInUser,
                                                   java.lang.String ksLabel)

Parameters:

loggedInUser - The current user

ksLabel - identifies the kickstart profile

Returns:

Array of available OS repositories for provided kickstart profile

getRepositories

public java.lang.String[] getRepositories(User loggedInUser,
                                          java.lang.String ksLabel)

Parameters:

loggedInUser - The current user

ksLabel - identifies the kickstart profile

Returns:

Array of available OS repositories

setRepositories

public int setRepositories(User loggedInUser,
                           java.lang.String ksLabel,
                           java.util.List<java.lang.String> reposIn)

Parameters:

loggedInUser - The current user

ksLabel - ksLabel identifies the kickstart profile

reposIn - OS repositories to set

Returns:

int - 1 on success, exception thrown otherwise

getVirtualizationType

public java.lang.String getVirtualizationType(User loggedInUser,
                                              java.lang.String ksLabel)

Parameters:

loggedInUser - The Current user

ksLabel - Kickstart profile label

Returns:

Label of virtualization type for given profile

setVirtualizationType

public int setVirtualizationType(User loggedInUser,
                                 java.lang.String ksLabel,
                                 java.lang.String typeLabel)

Parameters:

loggedInUser - The Current user

ksLabel - Kickstart profile label

typeLabel - virtualization type label

Returns:

int - 1 on success, exception thrown otherwise