org.apache.ambari.server.orm.entities

Class UpgradeEntity

java.lang.Object

org.apache.ambari.server.orm.entities.UpgradeEntity

@Entity
public class UpgradeEntity
extends Object

Models the data representation of an upgrade

Constructor Summary

Constructors

Constructor and Description
UpgradeEntity()

Method Summary

Modifier and Type	Method and Description
void	addHistory(UpgradeHistoryEntity historicalEntry) Adds a historical entry for a service component in this upgrade.
boolean	equals(Object o)
Long	getClusterId()
Direction	getDirection()
List<UpgradeHistoryEntity>	getHistory() Gets the history of this component's upgrades and downgrades.
Long	getId()
org.apache.ambari.spi.RepositoryType	getOrchestration()
RepositoryVersionEntity	getRepositoryVersion() Upgrades will always have a single version being upgraded to and downgrades will have a single version being downgraded from.
Long	getRequestId()
List<UpgradeGroupEntity>	getUpgradeGroups()
String	getUpgradePackage()
StackId	getUpgradePackStackId()
org.apache.ambari.spi.upgrade.UpgradeType	getUpgradeType()
int	hashCode()
boolean	isComponentFailureAutoSkipped() Gets whether skippable components that failed are automatically skipped.
Boolean	isDowngradeAllowed()
Boolean	isRevertAllowed() Gets whether this upgrade supports being reverted.
boolean	isServiceCheckFailureAutoSkipped() Gets whether skippable service checks that failed are automatically skipped.
boolean	isSuspended() Gets whether the upgrade is suspended.
void	removeHistories(Collection<UpgradeHistoryEntity> upgradeHistoryEntity) Removes historical entries for a service component in this upgrade.
void	setAutoSkipComponentFailures(boolean autoSkipComponentFailures) Sets whether skippable components that failed are automatically skipped.
void	setAutoSkipServiceCheckFailures(boolean autoSkipServiceCheckFailures) Sets whether skippable service checks that failed are automatically skipped.
void	setClusterId(Long id)
void	setDirection(Direction direction)
void	setDowngradeAllowed(boolean canDowngrade)
void	setId(Long id)
void	setOrchestration(org.apache.ambari.spi.RepositoryType type) Sets the orchestration for the upgrade.
void	setRepositoryVersion(RepositoryVersionEntity repositoryVersion) Sets the repository version for this upgrade.
void	setRequestEntity(RequestEntity requestEntity)
void	setRevertAllowed(boolean revertable) Sets whether this upgrade supports being reverted.
void	setSuspended(boolean suspended) Sets whether the upgrade is suspended.
void	setUpgradeGroups(List<UpgradeGroupEntity> items)
void	setUpgradePackage(String upgradePackage)
void	setUpgradePackStackId(StackId stackId)
void	setUpgradeType(org.apache.ambari.spi.upgrade.UpgradeType upgradeType)

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeEntity

public UpgradeEntity()

Method Detail

getId

public Long getId()

Returns:

the id

setId

public void setId(Long id)

Parameters:

id - the id

getClusterId

public Long getClusterId()

Returns:

the cluster id

setClusterId

public void setClusterId(Long id)

Parameters:

id - the cluster id

getUpgradeGroups

public List<UpgradeGroupEntity> getUpgradeGroups()

Returns:

the upgrade items

setUpgradeGroups

public void setUpgradeGroups(List<UpgradeGroupEntity> items)

Parameters:

items - the upgrade items

getRequestId

public Long getRequestId()

Returns:

the request id

setRequestEntity

public void setRequestEntity(RequestEntity requestEntity)

getDirection

public Direction getDirection()

Returns:

the direction of the upgrade

setDirection

public void setDirection(Direction direction)

Parameters:

direction - the direction of the upgrade

getUpgradeType

public org.apache.ambari.spi.upgrade.UpgradeType getUpgradeType()

Returns:

the upgrade type, such as rolling oNr non_rolling

isDowngradeAllowed

public Boolean isDowngradeAllowed()

Returns:

possibility to process downgrade

setDowngradeAllowed

public void setDowngradeAllowed(boolean canDowngrade)

Parameters:

canDowngrade - true to allow downgrade, false to disallow downgrade

isRevertAllowed

public Boolean isRevertAllowed()

Gets whether this upgrade supports being reverted. Upgrades can be reverted (downgraded after finalization) if they are either RepositoryType.MAINT or RepositoryType.PATCH and have never been previously downgraded.

Returns:

true if this upgrade can potentially be revereted.

setRevertAllowed

public void setRevertAllowed(boolean revertable)

Sets whether this upgrade supports being reverted. This should only ever be called from the finalization of an upgrade. RepositoryType.MAINT or RepositoryType.PATCH upgrades can be revereted only if they have not previously been downgraded.

Parameters:

revertable - true to mark this as being revertable, false otherwise.

setUpgradeType

public void setUpgradeType(org.apache.ambari.spi.upgrade.UpgradeType upgradeType)

Parameters:

upgradeType - the upgrade type to set

getUpgradePackage

public String getUpgradePackage()

Returns:

the upgrade package name, without the extension.

setUpgradePackage

public void setUpgradePackage(String upgradePackage)

Parameters:

upgradePackage - the upgrade pack to set

getUpgradePackStackId

public StackId getUpgradePackStackId()

Returns:

the stack that owns the upgrade pack

setUpgradePackStackId

public void setUpgradePackStackId(StackId stackId)

Parameters:

stackId - the stack that owns the upgrade pack

isComponentFailureAutoSkipped

public boolean isComponentFailureAutoSkipped()

Gets whether skippable components that failed are automatically skipped. They will be placed into the HostRoleStatus.SKIPPED_FAILED state.

Returns:

true if skippable failed components are automatically skipped when they fail.

setAutoSkipComponentFailures

public void setAutoSkipComponentFailures(boolean autoSkipComponentFailures)

Sets whether skippable components that failed are automatically skipped.

Parameters:

autoSkipComponentFailures - true to automatically skip component failures which are marked as skippable.

isServiceCheckFailureAutoSkipped

public boolean isServiceCheckFailureAutoSkipped()

Gets whether skippable service checks that failed are automatically skipped. They will be placed into the HostRoleStatus.SKIPPED_FAILED state.

Returns:

true if service checks are automatically skipped when they fail.

setAutoSkipServiceCheckFailures

public void setAutoSkipServiceCheckFailures(boolean autoSkipServiceCheckFailures)

Sets whether skippable service checks that failed are automatically skipped.

Parameters:

autoSkipServiceCheckFailures - true to automatically skip service check failures which are marked as being skippable.

isSuspended

public boolean isSuspended()

Gets whether the upgrade is suspended. A suspended upgrade will appear to have its request aborted, but the intent is to resume it at a later point.

Returns:

true if the upgrade is suspended.

setSuspended

public void setSuspended(boolean suspended)

Sets whether the upgrade is suspended.

Parameters:

suspended - true to mark the upgrade as suspended.

addHistory

public void addHistory(UpgradeHistoryEntity historicalEntry)

Adds a historical entry for a service component in this upgrade.

Parameters:

historicalEntry - the entry to add.

getHistory

public List<UpgradeHistoryEntity> getHistory()

Gets the history of this component's upgrades and downgrades.

Returns:

the component history, or null if none.

getRepositoryVersion

public RepositoryVersionEntity getRepositoryVersion()

Upgrades will always have a single version being upgraded to and downgrades will have a single version being downgraded from. This repository represents that version.

When the direction is Direction.UPGRADE, this represents the target repository.
When the direction is Direction.DOWNGRADE, this represents the repository being downgraded from.

Returns:

the repository version being upgraded to or downgraded from (never null).

setRepositoryVersion

public void setRepositoryVersion(RepositoryVersionEntity repositoryVersion)

Sets the repository version for this upgrade. This value will change depending on the direction of the upgrade.

When the direction is Direction.UPGRADE, this represents the target repository.
When the direction is Direction.DOWNGRADE, this represents the repository being downgraded from.

Parameters:

repositoryVersion - the repository version being upgraded to or downgraded from (not null).

setOrchestration

public void setOrchestration(org.apache.ambari.spi.RepositoryType type)

Sets the orchestration for the upgrade. Only different when an upgrade is a revert of a patch. In that case, the orchestration is set to PATCH even if the target repository is type STANDARD.

Parameters:

type - the orchestration

getOrchestration

public org.apache.ambari.spi.RepositoryType getOrchestration()

Returns:

the orchestration type

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

removeHistories

public void removeHistories(Collection<UpgradeHistoryEntity> upgradeHistoryEntity)

Removes historical entries for a service component in this upgrade.