com.redhat.rhn.frontend.xmlrpc.kickstart

Class KickstartHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.kickstart.KickstartHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class KickstartHandler
extends BaseHandler

KickstartHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
KickstartHandler()

Method Summary

Modifier and Type	Method and Description
int	cloneProfile(User loggedInUser, java.lang.String ksLabelToClone, java.lang.String newKsLabel) Clones a kickstart profile.
int	createProfile(User loggedInUser, java.lang.String profileLabel, java.lang.String virtualizationType, java.lang.String kickstartableTreeLabel, java.lang.String kickstartHost, java.lang.String rootPassword) Create a new kickstart profile using the default download URL for the kickstartable tree and kickstart host specified.
int	createProfile(User loggedInUser, java.lang.String profileLabel, java.lang.String virtualizationType, java.lang.String kickstartableTreeLabel, java.lang.String kickstartHost, java.lang.String rootPassword, java.lang.String updateType) Create a new kickstart profile using the default download URL for the kickstartable tree and kickstart host specified.
int	createProfileWithCustomUrl(User loggedInUser, java.lang.String profileLabel, java.lang.String virtualizationType, java.lang.String kickstartableTreeLabel, java.lang.String downloadUrl, java.lang.String rootPassword) Create a new kickstart profile with a custom download URL.
int	createProfileWithCustomUrl(User loggedInUser, java.lang.String profileLabel, java.lang.String virtualizationType, java.lang.String kickstartableTreeLabel, java.lang.String downloadUrl, java.lang.String rootPassword, java.lang.String updateType) Create a new kickstart profile with a custom download URL.
int	deleteProfile(User loggedInUser, java.lang.String ksLabel) delete a kickstart profile
int	disableProfile(User loggedInUser, java.lang.String profileLabel, java.lang.Boolean disabled) En/Disable kickstart profile
java.lang.String	findKickstartForIp(User loggedInUser, java.lang.String ipAddress) find a kickstart profile by an ip
int	importFile(User loggedInUser, java.lang.String profileLabel, java.lang.String virtualizationType, java.lang.String kickstartableTreeLabel, java.lang.String kickstartFileContents) Import a kickstart profile.
int	importFile(User loggedInUser, java.lang.String profileLabel, java.lang.String virtualizationType, java.lang.String kickstartableTreeLabel, java.lang.String kickstartHost, java.lang.String kickstartFileContents) Import a kickstart profile, overriding the url/nfs/harddrive/cdrom command in the file and replacing it with the default URL for the kickstartable tree and kickstart host specified.
int	importFile(User loggedInUser, java.lang.String profileLabel, java.lang.String virtualizationType, java.lang.String kickstartableTreeLabel, java.lang.String kickstartHost, java.lang.String kickstartFileContents, java.lang.String updateType) Import a kickstart profile, overriding the url/nfs/harddrive/cdrom command in the file and replacing it with the default URL for the kickstartable tree and kickstart host specified.
int	importRawFile(User loggedInUser, java.lang.String profileLabel, java.lang.String virtualizationType, java.lang.String kickstartableTreeLabel, java.lang.String kickstartFileContents) Import a kickstart profile, overriding the url/nfs/harddrive/cdrom command in the file and replacing it with the default URL for the kickstartable tree and kickstart host specified.
int	importRawFile(User loggedInUser, java.lang.String profileLabel, java.lang.String virtualizationType, java.lang.String kickstartableTreeLabel, java.lang.String kickstartFileContents, java.lang.String updateType) Import a kickstart profile, overriding the url/nfs/harddrive/cdrom command in the file and replacing it with the default URL for the kickstartable tree and kickstart host specified.
boolean	isProfileDisabled(User loggedInUser, java.lang.String profileLabel) Returns whether a kickstart profile is disabled
java.util.List	listAllIpRanges(User loggedInUser) Lists all ip ranges for an org
java.util.List<Channel>	listKickstartableChannels(User loggedInUser) List kickstartable channels for the logged in user.
java.util.List<Channel>	listKickstartableTreeChannels(User loggedInUser) List kickstartable tree channels for the logged in user.
java.util.List	listKickstartableTrees(User loggedInUser, java.lang.String channelLabel) Deprecated. being replaced by kickstart.tree.list(string sessionKey, string channelLabel)
java.util.List	listKickstarts(User loggedInUser) List kickstarts for a user
int	renameProfile(User loggedInUser, java.lang.String originalLabel, java.lang.String newLabel) Rename a kickstart profile.

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

KickstartHandler

public KickstartHandler()

Method Detail

listKickstartableTrees

@Deprecated
public java.util.List listKickstartableTrees(User loggedInUser,
                                                         java.lang.String channelLabel)

Deprecated. being replaced by kickstart.tree.list(string sessionKey, string channelLabel)

List the available kickstartable trees for the given channel.

Parameters:

loggedInUser - The current user

channelLabel - Label of channel to search.

Returns:

Array of KickstartableTreeObjects

listKickstartableChannels

public java.util.List<Channel> listKickstartableChannels(User loggedInUser)

List kickstartable channels for the logged in user.

Parameters:

loggedInUser - The current user

Returns:

Array of Channel objects.

listKickstartableTreeChannels

public java.util.List<Channel> listKickstartableTreeChannels(User loggedInUser)

List kickstartable tree channels for the logged in user.

Parameters:

loggedInUser - The current user

Returns:

Array of Channel objects.

importFile

public int importFile(User loggedInUser,
                      java.lang.String profileLabel,
                      java.lang.String virtualizationType,
                      java.lang.String kickstartableTreeLabel,
                      java.lang.String kickstartFileContents)

Import a kickstart profile. This method will maintain the url/nfs/harddrive/cdrom command in the kickstart file rather than replace it with the kickstartable tree's default URL.

Parameters:

loggedInUser - The current user

profileLabel - Label for the new kickstart profile.

virtualizationType - Virtualization type, or none.

kickstartableTreeLabel - Label of a kickstartable tree.

kickstartFileContents - Contents of a kickstart file.

Returns:

1 if successful, exception otherwise.

importFile

public int importFile(User loggedInUser,
                      java.lang.String profileLabel,
                      java.lang.String virtualizationType,
                      java.lang.String kickstartableTreeLabel,
                      java.lang.String kickstartHost,
                      java.lang.String kickstartFileContents)

Import a kickstart profile, overriding the url/nfs/harddrive/cdrom command in the file and replacing it with the default URL for the kickstartable tree and kickstart host specified.

Parameters:

loggedInUser - The current user

profileLabel - Label for the new kickstart profile.

virtualizationType - Virtualization type, or none.

kickstartableTreeLabel - Label of a kickstartable tree.

kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile. Using this option signifies that this default URL will be used instead of any url/nfs/cdrom/harddrive commands in the kickstart file itself.

kickstartFileContents - Contents of a kickstart file.

Returns:

1 if successful, exception otherwise.

importFile

public int importFile(User loggedInUser,
                      java.lang.String profileLabel,
                      java.lang.String virtualizationType,
                      java.lang.String kickstartableTreeLabel,
                      java.lang.String kickstartHost,
                      java.lang.String kickstartFileContents,
                      java.lang.String updateType)

Import a kickstart profile, overriding the url/nfs/harddrive/cdrom command in the file and replacing it with the default URL for the kickstartable tree and kickstart host specified.

Parameters:

loggedInUser - The current user

profileLabel - Label for the new kickstart profile.

virtualizationType - Virtualization type, or none.

kickstartableTreeLabel - Label of a kickstartable tree.

kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile. Using this option signifies that this default URL will be used instead of any url/nfs/cdrom/harddrive commands in the kickstart file itself.

kickstartFileContents - Contents of a kickstart file.

updateType - Set the automatic ks tree update strategy for the profile. Valid choices are "red_hat", "none", "all".

Returns:

1 if successful, exception otherwise.

createProfile

public int createProfile(User loggedInUser,
                         java.lang.String profileLabel,
                         java.lang.String virtualizationType,
                         java.lang.String kickstartableTreeLabel,
                         java.lang.String kickstartHost,
                         java.lang.String rootPassword,
                         java.lang.String updateType)

Create a new kickstart profile using the default download URL for the kickstartable tree and kickstart host specified.

Parameters:

loggedInUser - The current user

profileLabel - Label for the new kickstart profile.

virtualizationType - Virtualization type, or none.

kickstartableTreeLabel - Label of a kickstartable tree.

kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile.

rootPassword - Root password.

updateType - Set the automatic ks tree update strategy for the profile. Valid choices are "red_hat", "none", "all".

Returns:

1 if successful, exception otherwise.

createProfile

public int createProfile(User loggedInUser,
                         java.lang.String profileLabel,
                         java.lang.String virtualizationType,
                         java.lang.String kickstartableTreeLabel,
                         java.lang.String kickstartHost,
                         java.lang.String rootPassword)

Create a new kickstart profile using the default download URL for the kickstartable tree and kickstart host specified.

Parameters:

loggedInUser - The current user

profileLabel - Label for the new kickstart profile.

virtualizationType - Virtualization type, or none.

kickstartableTreeLabel - Label of a kickstartable tree.

kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile.

rootPassword - Root password.

Returns:

1 if successful, exception otherwise.

createProfileWithCustomUrl

public int createProfileWithCustomUrl(User loggedInUser,
                                      java.lang.String profileLabel,
                                      java.lang.String virtualizationType,
                                      java.lang.String kickstartableTreeLabel,
                                      java.lang.String downloadUrl,
                                      java.lang.String rootPassword)

Create a new kickstart profile with a custom download URL.

Parameters:

loggedInUser - The current user

profileLabel - Label for the new kickstart profile.

virtualizationType - Virtualization type, or none.

kickstartableTreeLabel - Label of a kickstartable tree.

downloadUrl - Download URL, or 'default' to use the kickstart tree's default URL.

rootPassword - Root password.

Returns:

1 if successful, exception otherwise.

createProfileWithCustomUrl

public int createProfileWithCustomUrl(User loggedInUser,
                                      java.lang.String profileLabel,
                                      java.lang.String virtualizationType,
                                      java.lang.String kickstartableTreeLabel,
                                      java.lang.String downloadUrl,
                                      java.lang.String rootPassword,
                                      java.lang.String updateType)

Create a new kickstart profile with a custom download URL.

Parameters:

loggedInUser - The current user

profileLabel - Label for the new kickstart profile.

virtualizationType - Virtualization type, or none.

kickstartableTreeLabel - Label of a kickstartable tree.

downloadUrl - Download URL, or 'default' to use the kickstart tree's default URL.

rootPassword - Root password.

updateType - Set the automatic ks tree update strategy for the profile. Valid choices are "red_hat", "none", "all".

Returns:

1 if successful, exception otherwise.

listKickstarts

public java.util.List listKickstarts(User loggedInUser)

List kickstarts for a user

Parameters:

loggedInUser - The current user

Returns:

list of KickstartDto objects

listAllIpRanges

public java.util.List listAllIpRanges(User loggedInUser)

Lists all ip ranges for an org

Parameters:

loggedInUser - The current user

Returns:

List of KickstartIpRange objects

findKickstartForIp

public java.lang.String findKickstartForIp(User loggedInUser,
                                           java.lang.String ipAddress)

find a kickstart profile by an ip

Parameters:

loggedInUser - The current user

ipAddress - the ipaddress to search on

Returns:

label of the associated kickstart

deleteProfile

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

delete a kickstart profile

Parameters:

loggedInUser - The current user

ksLabel - the kickstart to remove an ip range from

Returns:

1 if successful, exception otherwise.

disableProfile

public int disableProfile(User loggedInUser,
                          java.lang.String profileLabel,
                          java.lang.Boolean disabled)

En/Disable kickstart profile

Parameters:

loggedInUser - The current user

profileLabel - Label for tree we want to en/disable

disabled - True to disable the profile

Returns:

1 if successful, exception otherwise.

isProfileDisabled

public boolean isProfileDisabled(User loggedInUser,
                                 java.lang.String profileLabel)

Returns whether a kickstart profile is disabled

Parameters:

loggedInUser - The current user

profileLabel - kickstart profile label

Returns:

true if profile is disabled

renameProfile

public int renameProfile(User loggedInUser,
                         java.lang.String originalLabel,
                         java.lang.String newLabel)

Rename a kickstart profile.

Parameters:

loggedInUser - The current user

originalLabel - Label for profile we want to edit

newLabel - to assign to profile

Returns:

1 if successful, exception otherwise.

cloneProfile

public int cloneProfile(User loggedInUser,
                        java.lang.String ksLabelToClone,
                        java.lang.String newKsLabel)

Clones a kickstart profile.

Parameters:

loggedInUser - The current user

ksLabelToClone - label of the kickstart profile to clone

newKsLabel - label of the cloned profile

Returns:

1 if successful, exception otherwise.

importRawFile

public int importRawFile(User loggedInUser,
                         java.lang.String profileLabel,
                         java.lang.String virtualizationType,
                         java.lang.String kickstartableTreeLabel,
                         java.lang.String kickstartFileContents)

Import a kickstart profile, overriding the url/nfs/harddrive/cdrom command in the file and replacing it with the default URL for the kickstartable tree and kickstart host specified.

Parameters:

loggedInUser - The current user

profileLabel - Label for the new kickstart profile.

virtualizationType - Virtualization type, or none.

kickstartableTreeLabel - Label of a kickstartable tree.

kickstartFileContents - Contents of a kickstart file.

Returns:

1 if successful, exception otherwise.

importRawFile

public int importRawFile(User loggedInUser,
                         java.lang.String profileLabel,
                         java.lang.String virtualizationType,
                         java.lang.String kickstartableTreeLabel,
                         java.lang.String kickstartFileContents,
                         java.lang.String updateType)

Import a kickstart profile, overriding the url/nfs/harddrive/cdrom command in the file and replacing it with the default URL for the kickstartable tree and kickstart host specified.

Parameters:

loggedInUser - The current user

profileLabel - Label for the new kickstart profile.

virtualizationType - Virtualization type, or none.

kickstartableTreeLabel - Label of a kickstartable tree.

kickstartFileContents - Contents of a kickstart file.

updateType - Set the automatic ks tree update strategy for the profile. Valid choices are "red_hat", "none", "all".

Returns:

1 if successful, exception otherwise.