com.redhat.rhn.manager.kickstart

Class KickstartScheduleCommand

java.lang.Object

com.redhat.rhn.manager.BasePersistOperation

com.redhat.rhn.manager.system.BaseSystemOperation

com.redhat.rhn.manager.kickstart.KickstartScheduleCommand

All Implemented Interfaces:

PersistOperation

Direct Known Subclasses:

ProvisionVirtualInstanceCommand

public class KickstartScheduleCommand
extends BaseSystemOperation

Provides frequently used data for scheduling a kickstart Throughout this class you'll find references to two different servers: the host server and the target server. The target server is always the system being kickstarted. The host server is the system through which the kickstart is being performed; it can be thought of as a type of liason. The host server receives the kickstart actions, performs the actions on the target server, and represents the target server in the UI. For most kickstarts, the host server is the same as the target server; that is, the system being kickstarted is performing the kickstart on itself. For other types of kickstarts, such as in the case of virtual guests, the system being kickstarted is different from the system hosting the kickstart. The virtual host system performs the kickstart on the guest. When this happens, one of two situations is relevant: (1) There is no previously-existing target system; the host system must create it from scratch. In this scenario, null is passed in as the target system's ID (simply because it is not known yet). (2) There is a previously-existing target system and the host must kickstart it. In this scenario, the target system's ID is not null, but is also not the same as the host system's ID. Because of the distinction between host and target servers, constructors in this class which accept a single server ID will automatically assume that the system being kickstarted is both the host and the target system.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cobblerOnly
protected java.lang.String	cobblerProfileLabel
static java.lang.String	DHCP_NETWORK_TYPE
static java.lang.String	LINK_NETWORK_TYPE
static java.lang.String	PACKAGE_TO_REMOVE
static java.lang.String	TARGET_PROFILE_TYPE_EXISTING
static java.lang.String	TARGET_PROFILE_TYPE_NONE
static java.lang.String	TARGET_PROFILE_TYPE_PACKAGE
static java.lang.String	TARGET_PROFILE_TYPE_SYSTEM
static java.lang.String	UP2DATE_VERSION

Fields inherited from class com.redhat.rhn.manager.system.BaseSystemOperation

server

Fields inherited from class com.redhat.rhn.manager.BasePersistOperation

user

Constructor Summary

Constructors

Constructor and Description
KickstartScheduleCommand(java.lang.Long selectedServer, KickstartData data, User userIn, java.util.Date scheduleDateIn, java.lang.String kickstartServerNameIn) Constructor for a kickstart where the host and the target are the same system.
KickstartScheduleCommand(java.lang.Long selectedHostServer, java.lang.Long selectedTargetServer, KickstartData data, User userIn, java.util.Date scheduleDateIn, java.lang.String kickstartServerNameIn) Constructor for a kickstart where the host and the target may or may *not* be the same system.
KickstartScheduleCommand(java.lang.Long selectedHostServer, java.lang.Long selectedTargetServer, java.lang.Long ksid, User userIn, java.util.Date scheduleDateIn, java.lang.String kickstartServerNameIn) Constructor for a kickstart where the host and the target may or may *not* be the same system.
KickstartScheduleCommand(java.lang.Long selectedHostServer, java.lang.Long selectedTargetServer, java.lang.String ksLabel, User userIn, java.util.Date scheduleDateIn, java.lang.String kickstartServerNameIn) Constructor for a kickstart where the host and the target may or may *not* be the same system.
KickstartScheduleCommand(java.lang.Long selectedServer, java.lang.Long ksid, User userIn) Constructor for a kickstart where the host and the target are the same system.
KickstartScheduleCommand(java.lang.Long selectedServer, java.lang.Long ksid, User userIn, java.util.Date scheduleDateIn, java.lang.String kickstartServerNameIn) Constructor for a kickstart where the host and the target are the same system.
KickstartScheduleCommand(java.lang.Long selectedServer, User userIn) Constructor for a kickstart where the host and the target are the same system.

Method Summary

Modifier and Type	Method and Description
boolean	createBond()
static KickstartScheduleCommand	createCobblerScheduleCommand(java.lang.Long selectedHostServer, java.lang.String label, User userIn, java.util.Date scheduleDateIn, java.lang.String kickstartServerNameIn) Creates the Kickstart Sechdule command that works with a cobbler only kickstart where the host and the target are the same system To be used when you want to call the store() method.
static ActivationKey	createKickstartActivationKey(User creator, KickstartData ksdata, Server server, KickstartSession session, java.lang.Long usageLimit, java.lang.String note) Create a one time activation key for use with a kickstart
ValidatorError	doValidation() Do the validation needed for this command.
java.util.Map<java.lang.String,java.lang.Long>	findKickstartPackageToInstall(Server server, java.util.Collection<java.lang.Long> channelIds) Looks for the package name among the specified channels and, if it is found, it returns the highest available version in Map form.
java.lang.String	getBondAddress()
java.lang.String	getBondGateway()
java.lang.String	getBondInterface()
java.lang.String	getBondNetmask()
java.lang.String	getBondOptions()
java.util.List<java.lang.String>	getBondSlaveInterfaces()
protected CobblerSystemCreateCommand	getCobblerSystemCreateCommand(User userIn, Server serverIn, KickstartData ksdataIn, java.lang.String mediaPath, java.lang.String tokenList) This method is extracted out so we can override them in the subclass
protected CobblerSystemCreateCommand	getCobblerSystemCreateCommand(User userIn, Server serverIn, java.lang.String cobblerProfileLabelIn) This method is extracted out so we can override them in the subclass
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getCompatibleSystems() Get the list of compatible systems you could sync to
Profile	getCreatedProfile()
java.lang.String	getExtraOptions() Create ExtraOptions string
Server	getHostServer()
java.lang.String	getKickstartPackageName() Return the kickstart package name for this kickstart action.
DataResult<KickstartDto>	getKickstartProfiles() Looks up a list of applicable kickstart profiles.
java.lang.String	getKickstartServerName()
KickstartSession	getKickstartSession()
KickstartData	getKsdata()
protected SelectMode	getMode()
java.util.List	getPackagesToInstall()
java.lang.Long	getProfileId()
java.util.List<ProfileDto>	getProfiles() Get the DataResult list of com.redhat.rhn.frontend.dto.ProfileDto that are compatible with the BaseChannel for the selected KickstartData object.
java.lang.String	getProfileType()
java.lang.String	getProxyHost()
Action	getScheduledAction()
java.util.Date	getScheduleDate()
java.lang.Long	getServerProfileId()
Server	getTargetServer()
User	getUser() All PersistOperations must have a User object who is performing the Operation.
boolean	isBondDhcp()
boolean	isCobblerOnly()
Action	scheduleKickstartAction(Action prereqAction)
Action	scheduleRebootAction(Action prereqAction)
void	setBondAddress(java.lang.String bondAddressIn)
void	setBondDhcp(boolean isBondDhcpIn)
void	setBondGateway(java.lang.String bondGatewayIn)
void	setBondInterface(java.lang.String bondInterfaceIn)
void	setBondNetmask(java.lang.String bondNetmaskIn)
void	setBondOptions(java.lang.String bondOptionsIn)
void	setBondSlaveInterfaces(java.util.List<java.lang.String> bondSlaveInterfacesIn)
void	setCreateBond(boolean createBondIn)
void	setHostServer(Server serverIn)
void	setIpv6Gateway() Sets to use IPv6 gateway.
void	setKernelOptions(java.lang.String kernelOptionsIn)
void	setKickstartServerName(java.lang.String kickstartServerNameIn)
void	setKickstartSession(KickstartSession kickstartSessionIn)
void	setKsdata(KickstartData ksdataIn)
void	setNetworkDevice(java.lang.String networkType, java.lang.String networkInterfaceIn)
void	setPackagesToInstall(java.util.List packagesToInstallIn)
void	setPostKernelOptions(java.lang.String postKernelOptionsIn)
void	setProfileId(java.lang.Long profileIdIn)
void	setProfileType(java.lang.String profileTypeIn)
void	setProxy(Server serverIn)
void	setProxyHost(java.lang.String proxyHostIn)
void	setScheduleDate(java.util.Date scheduleDateIn)
void	setServerProfileId(java.lang.Long serverProfileIdIn)
void	setTargetServer(Server serverIn)
protected KickstartSession	setupKickstartSession(Action firstAction)
void	setUser(User userIn)
ValidatorError	store() Perform the storage Operation to the Persistence Layer.
boolean	useIpv6Gateway() Indicate whether an IPv6 gateway is to be used for re-provisioning.
ValidatorError	validateKickstartPackage() Get the id of the Package installed for this KS.
protected ValidatorError	validateUp2dateVersion()

Methods inherited from class com.redhat.rhn.manager.system.BaseSystemOperation

getServer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DHCP_NETWORK_TYPE

public static final java.lang.String DHCP_NETWORK_TYPE

See Also:

Constant Field Values

LINK_NETWORK_TYPE

public static final java.lang.String LINK_NETWORK_TYPE

See Also:

Constant Field Values

UP2DATE_VERSION

public static final java.lang.String UP2DATE_VERSION

See Also:

Constant Field Values

TARGET_PROFILE_TYPE_EXISTING

public static final java.lang.String TARGET_PROFILE_TYPE_EXISTING

See Also:

Constant Field Values

TARGET_PROFILE_TYPE_PACKAGE

public static final java.lang.String TARGET_PROFILE_TYPE_PACKAGE

See Also:

Constant Field Values

TARGET_PROFILE_TYPE_SYSTEM

public static final java.lang.String TARGET_PROFILE_TYPE_SYSTEM

See Also:

Constant Field Values

TARGET_PROFILE_TYPE_NONE

public static final java.lang.String TARGET_PROFILE_TYPE_NONE

See Also:

Constant Field Values

PACKAGE_TO_REMOVE

public static final java.lang.String PACKAGE_TO_REMOVE

See Also:

Constant Field Values

cobblerProfileLabel

protected java.lang.String cobblerProfileLabel

cobblerOnly

protected boolean cobblerOnly

Constructor Detail

KickstartScheduleCommand

public KickstartScheduleCommand(java.lang.Long selectedServer,
                                User userIn)

Constructor for a kickstart where the host and the target are the same system.

Parameters:

selectedServer - server to kickstart

userIn - user performing the kickstart

KickstartScheduleCommand

public KickstartScheduleCommand(java.lang.Long selectedServer,
                                java.lang.Long ksid,
                                User userIn)

Constructor for a kickstart where the host and the target are the same system.

Parameters:

selectedServer - server to kickstart

ksid - id of the KickstartData we are using

userIn - user performing the kickstart

KickstartScheduleCommand

public KickstartScheduleCommand(java.lang.Long selectedServer,
                                java.lang.Long ksid,
                                User userIn,
                                java.util.Date scheduleDateIn,
                                java.lang.String kickstartServerNameIn)

Constructor for a kickstart where the host and the target are the same system. To be used when you want to call the store() method.

Parameters:

selectedServer - server to kickstart

ksid - id of the KickstartData we are using

userIn - user performing the kickstart

scheduleDateIn - Date to schedule the KS.

kickstartServerNameIn - the name of the server who is serving the kickstart

KickstartScheduleCommand

public KickstartScheduleCommand(java.lang.Long selectedServer,
                                KickstartData data,
                                User userIn,
                                java.util.Date scheduleDateIn,
                                java.lang.String kickstartServerNameIn)

Constructor for a kickstart where the host and the target are the same system. To be used when you want to call the store() method.

Parameters:

selectedServer - server to kickstart

data - the KickstartData we are using

userIn - user performing the kickstart

scheduleDateIn - Date to schedule the KS.

kickstartServerNameIn - the name of the server who is serving the kickstart

KickstartScheduleCommand

public KickstartScheduleCommand(java.lang.Long selectedHostServer,
                                java.lang.Long selectedTargetServer,
                                java.lang.Long ksid,
                                User userIn,
                                java.util.Date scheduleDateIn,
                                java.lang.String kickstartServerNameIn)

Constructor for a kickstart where the host and the target may or may *not* be the same system. If the target system does not yet exist, selectedTargetServer should be null. To be used when you want to call the store() method.

Parameters:

selectedHostServer - server to host the kickstart

selectedTargetServer - server to be kickstarted

ksid - id of the KickstartData we are using

userIn - user performing the kickstart

scheduleDateIn - Date to schedule the KS.

kickstartServerNameIn - the name of the server who is serving the kickstart

KickstartScheduleCommand

public KickstartScheduleCommand(java.lang.Long selectedHostServer,
                                java.lang.Long selectedTargetServer,
                                java.lang.String ksLabel,
                                User userIn,
                                java.util.Date scheduleDateIn,
                                java.lang.String kickstartServerNameIn)

Constructor for a kickstart where the host and the target may or may *not* be the same system. If the target system does not yet exist, selectedTargetServer should be null. To be used when you want to call the store() method.

Parameters:

selectedHostServer - server to host the kickstart

selectedTargetServer - server to be kickstarted

ksLabel - label of the KickstartData we are using

userIn - user performing the kickstart

scheduleDateIn - Date to schedule the KS.

kickstartServerNameIn - the name of the server who is serving the kickstart

KickstartScheduleCommand

public KickstartScheduleCommand(java.lang.Long selectedHostServer,
                                java.lang.Long selectedTargetServer,
                                KickstartData data,
                                User userIn,
                                java.util.Date scheduleDateIn,
                                java.lang.String kickstartServerNameIn)

Constructor for a kickstart where the host and the target may or may *not* be the same system. If the target system does not yet exist, selectedTargetServer should be null. To be used when you want to call the store() method.

Parameters:

selectedHostServer - server to host the kickstart

selectedTargetServer - server to be kickstarted

data - KickstartData object..

userIn - user performing the kickstart

scheduleDateIn - Date to schedule the KS.

kickstartServerNameIn - the name of the server who is serving the kickstart

Method Detail

createCobblerScheduleCommand

public static KickstartScheduleCommand createCobblerScheduleCommand(java.lang.Long selectedHostServer,
                                                                    java.lang.String label,
                                                                    User userIn,
                                                                    java.util.Date scheduleDateIn,
                                                                    java.lang.String kickstartServerNameIn)

Creates the Kickstart Sechdule command that works with a cobbler only kickstart where the host and the target are the same system To be used when you want to call the store() method.

Parameters:

selectedHostServer - server to host the kickstart

label - cobbler only profile label.

userIn - user performing the kickstart

scheduleDateIn - Date to schedule the KS.

kickstartServerNameIn - the name of the server who is serving the kickstart

Returns:

the created cobbler only profile aware kickstartScheduleCommand

getKickstartProfiles

public DataResult<KickstartDto> getKickstartProfiles()

Looks up a list of applicable kickstart profiles. The list is generated based on matches between the server's base channel arch and the profile's channel arch

Returns:

DataResult, else null if the server does not exist or does not have a base channel assigned

getMode

protected SelectMode getMode()

getProfiles

public java.util.List<ProfileDto> getProfiles()

Get the DataResult list of com.redhat.rhn.frontend.dto.ProfileDto that are compatible with the BaseChannel for the selected KickstartData object.

Returns:

DataResult list

getScheduledAction

public Action getScheduledAction()

Returns:

Returns the id of the action scheduled to perform the kickstart.

getKsdata

public KickstartData getKsdata()

Returns:

Returns the ksdata.

setKsdata

public void setKsdata(KickstartData ksdataIn)

Parameters:

ksdataIn - The ksdata to set.

getProxyHost

public java.lang.String getProxyHost()

Returns:

Returns the String representation of the proxy host to use.

setProxyHost

public void setProxyHost(java.lang.String proxyHostIn)

Parameters:

proxyHostIn - The proxy host to set.

store

public ValidatorError store()

Perform the storage Operation to the Persistence Layer.

Returns:

ValidatorError if there was an error trying to store the object.

getCobblerSystemCreateCommand

protected CobblerSystemCreateCommand getCobblerSystemCreateCommand(User userIn,
                                                                   Server serverIn,
                                                                   KickstartData ksdataIn,
                                                                   java.lang.String mediaPath,
                                                                   java.lang.String tokenList)

This method is extracted out so we can override them in the subclass

Parameters:

userIn - the user

serverIn - the system

ksdataIn - the kickstart data

mediaPath - the media path

tokenList - the token list

Returns:

the CobblerSystemCreateCommand

getCobblerSystemCreateCommand

protected CobblerSystemCreateCommand getCobblerSystemCreateCommand(User userIn,
                                                                   Server serverIn,
                                                                   java.lang.String cobblerProfileLabelIn)

This method is extracted out so we can override them in the subclass

Parameters:

userIn - the user

serverIn - the system

cobblerProfileLabelIn - the cobbler profile label

Returns:

the CobblerSystemCreateCommand

setupKickstartSession

protected KickstartSession setupKickstartSession(Action firstAction)

Parameters:

firstAction - The first Action in the session's action chain

Returns:

Returns the KickstartSession.

scheduleKickstartAction

public Action scheduleKickstartAction(Action prereqAction)

Parameters:

prereqAction - the prerequisite for this action

Returns:

Returns the KickstartAction

scheduleRebootAction

public Action scheduleRebootAction(Action prereqAction)

Parameters:

prereqAction - the prerequisite for this action

Returns:

Returns the rebootAction (if any)

doValidation

public ValidatorError doValidation()

Do the validation needed for this command. This ensures that the system hosting the kickstart has the necessary resources to do so.

Returns:

Returns a ValidatorError, if any errors occur

createKickstartActivationKey

public static ActivationKey createKickstartActivationKey(User creator,
                                                         KickstartData ksdata,
                                                         Server server,
                                                         KickstartSession session,
                                                         java.lang.Long usageLimit,
                                                         java.lang.String note)

Create a one time activation key for use with a kickstart

Parameters:

creator - of the key

ksdata - associated with the key

server - being kickstarted (can be null)

session - associated with the kickstart (NOT NULL)

note - to add to key

usageLimit - to apply to the key. null for unlimited.

Returns:

ActivationKey that has been saved to the DB.

getExtraOptions

public java.lang.String getExtraOptions()

Create ExtraOptions string

Returns:

extraOptions that will be appended to the Kickstart.

validateKickstartPackage

public ValidatorError validateKickstartPackage()

Get the id of the Package installed for this KS. Here we'll verify that the kickstart package exists in the host server's tools channel. The host server will need it to perform necessary actions on either itself or the target system (if different).

Returns:

Long id of Package used for this KS.

findKickstartPackageToInstall

public java.util.Map<java.lang.String,java.lang.Long> findKickstartPackageToInstall(Server server,
                                                                                    java.util.Collection<java.lang.Long> channelIds)

Looks for the package name among the specified channels and, if it is found, it returns the highest available version in Map form.

Parameters:

server - the server

channelIds - channels the server could be subscribed to

Returns:

a ValidationError or null

getKickstartPackageName

public java.lang.String getKickstartPackageName()

Return the kickstart package name for this kickstart action.

Returns:

kickstart package name

validateUp2dateVersion

protected ValidatorError validateUp2dateVersion()

getCompatibleSystems

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getCompatibleSystems()

Get the list of compatible systems you could sync to

Returns:

DataResult of System DTOs

getPackagesToInstall

public java.util.List getPackagesToInstall()

Returns:

Returns the packagesToInstall.

setPackagesToInstall

public void setPackagesToInstall(java.util.List packagesToInstallIn)

Parameters:

packagesToInstallIn - The packagesToInstall to set.

getProfileType

public java.lang.String getProfileType()

Returns:

Returns the profileType.

setProfileType

public void setProfileType(java.lang.String profileTypeIn)

Parameters:

profileTypeIn - The profileType to set.

getKickstartSession

public KickstartSession getKickstartSession()

Returns:

Returns the kickstartSession.

setKickstartSession

public void setKickstartSession(KickstartSession kickstartSessionIn)

Parameters:

kickstartSessionIn - The kickstartSession to set.

getProfileId

public java.lang.Long getProfileId()

Returns:

Returns the profileId.

setProfileId

public void setProfileId(java.lang.Long profileIdIn)

Parameters:

profileIdIn - The profileId to set.

getServerProfileId

public java.lang.Long getServerProfileId()

Returns:

Returns the serverProfileId.

setServerProfileId

public void setServerProfileId(java.lang.Long serverProfileIdIn)

Parameters:

serverProfileIdIn - The serverProfileId to set.

getCreatedProfile

public Profile getCreatedProfile()

Returns:

Returns the createdProfile.

setProxy

public void setProxy(Server serverIn)

Parameters:

serverIn - Proxy Host to set for this ks session

getScheduleDate

public java.util.Date getScheduleDate()

Returns:

Returns the scheduleDate.

setScheduleDate

public void setScheduleDate(java.util.Date scheduleDateIn)

Parameters:

scheduleDateIn - The scheduleDate to set.

getKickstartServerName

public java.lang.String getKickstartServerName()

Returns:

Returns the kickstart server name.

setKickstartServerName

public void setKickstartServerName(java.lang.String kickstartServerNameIn)

Parameters:

kickstartServerNameIn - The kickstartServerName to set.

setNetworkDevice

public void setNetworkDevice(java.lang.String networkType,
                             java.lang.String networkInterfaceIn)

Parameters:

networkType - dhcp/static/link one of em.

networkInterfaceIn - The staticDevice to set.

setIpv6Gateway

public void setIpv6Gateway()

Sets to use IPv6 gateway.

useIpv6Gateway

public boolean useIpv6Gateway()

Indicate whether an IPv6 gateway is to be used for re-provisioning.

Returns:

true if IPv6 gateway is to be used, false otherwise.

getBondInterface

public java.lang.String getBondInterface()

Returns:

Returns the bond name.

setBondInterface

public void setBondInterface(java.lang.String bondInterfaceIn)

Parameters:

bondInterfaceIn - The bond name to set

getBondSlaveInterfaces

public java.util.List<java.lang.String> getBondSlaveInterfaces()

Returns:

Returns a list of the bond slave interfaces.

setBondSlaveInterfaces

public void setBondSlaveInterfaces(java.util.List<java.lang.String> bondSlaveInterfacesIn)

Parameters:

bondSlaveInterfacesIn - The bond slave interfaces to set.

createBond

public boolean createBond()

Returns:

Returns whether or not we should create a bond

setCreateBond

public void setCreateBond(boolean createBondIn)

Parameters:

createBondIn - Whether or not to create a bond

getBondOptions

public java.lang.String getBondOptions()

Returns:

Returns the bondOptions

setBondOptions

public void setBondOptions(java.lang.String bondOptionsIn)

Parameters:

bondOptionsIn - The bond options to set.

isBondDhcp

public boolean isBondDhcp()

Returns:

Returns true if we are using dhcp for the bond

setBondDhcp

public void setBondDhcp(boolean isBondDhcpIn)

Parameters:

isBondDhcpIn - True if we want to use dhcp for the bond

getBondAddress

public java.lang.String getBondAddress()

Returns:

the bondAddress

setBondAddress

public void setBondAddress(java.lang.String bondAddressIn)

Parameters:

bondAddressIn - The bondAddress to set

getBondNetmask

public java.lang.String getBondNetmask()

Returns:

The bondNetmask

setBondNetmask

public void setBondNetmask(java.lang.String bondNetmaskIn)

Parameters:

bondNetmaskIn - The bondNetmask to set

getBondGateway

public java.lang.String getBondGateway()

Returns:

The bondGateway

setBondGateway

public void setBondGateway(java.lang.String bondGatewayIn)

Parameters:

bondGatewayIn - The bondGateway to set

getUser

public User getUser()

Description copied from class: BasePersistOperation

All PersistOperations must have a User object who is performing the Operation.

Specified by:

getUser in interface PersistOperation

Overrides:

getUser in class BasePersistOperation

Returns:

Returns the user.

setUser

public void setUser(User userIn)

Parameters:

userIn - The user to set.

getHostServer

public Server getHostServer()

Returns:

The host server.

setHostServer

public void setHostServer(Server serverIn)

Parameters:

serverIn - The host server to set.

getTargetServer

public Server getTargetServer()

Returns:

The target server.

setTargetServer

public void setTargetServer(Server serverIn)

Parameters:

serverIn - The server to set.

isCobblerOnly

public boolean isCobblerOnly()

Returns:

true if this cmd carries a cobbler only profile

setKernelOptions

public void setKernelOptions(java.lang.String kernelOptionsIn)

Parameters:

kernelOptionsIn - The kernelOptions to set.

setPostKernelOptions

public void setPostKernelOptions(java.lang.String postKernelOptionsIn)

Parameters:

postKernelOptionsIn - The postKernelOptions to set.