content: /*
   * Licensed to the Apache Software Foundation (ASF) under one
   * or more contributor license agreements.  See the NOTICE file
   * distributed with this work for additional information
   * regarding copyright ownership.  The ASF licenses this file
   * to you under the Apache License, Version 2.0 (the
   * "License"); you may not use this file except in compliance
   * with the License.  You may obtain a copy of the License at
   *
   *     http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.ambari.server.orm.entities;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.List;
  
  import jakarta.persistence.CascadeType;
  import jakarta.persistence.Column;
  import jakarta.persistence.Entity;
  import jakarta.persistence.EnumType;
  import jakarta.persistence.Enumerated;
  import jakarta.persistence.FetchType;
  import jakarta.persistence.GeneratedValue;
  import jakarta.persistence.GenerationType;
  import jakarta.persistence.Id;
  import jakarta.persistence.JoinColumn;
  import jakarta.persistence.NamedQueries;
  import jakarta.persistence.NamedQuery;
  import jakarta.persistence.OneToMany;
  import jakarta.persistence.OneToOne;
  import jakarta.persistence.QueryHint;
  import jakarta.persistence.Table;
  import jakarta.persistence.TableGenerator;
  
  import org.apache.ambari.server.actionmanager.HostRoleStatus;
  import org.apache.ambari.server.stack.upgrade.Direction;
  import org.apache.ambari.server.state.StackId;
  import org.apache.ambari.spi.RepositoryType;
  import org.apache.ambari.spi.upgrade.UpgradeType;
  import org.apache.commons.lang.builder.EqualsBuilder;
  
  import com.google.common.base.Objects;
  
  /**
   * Models the data representation of an upgrade
   */
  @Entity
  @Table(name = "upgrade")
  @TableGenerator(
      name = "upgrade_id_generator",
      table = "ambari_sequences",
      pkColumnName = "sequence_name",
      valueColumnName = "sequence_value",
      pkColumnValue = "upgrade_id_seq",
      initialValue = 0)
  @NamedQueries({
      @NamedQuery(name = "UpgradeEntity.findAll", query = "SELECT u FROM UpgradeEntity u"),
      @NamedQuery(
          name = "UpgradeEntity.findAllForCluster",
          query = "SELECT u FROM UpgradeEntity u WHERE u.clusterId = :clusterId"),
      @NamedQuery(
          name = "UpgradeEntity.findUpgrade",
          query = "SELECT u FROM UpgradeEntity u WHERE u.upgradeId = :upgradeId"),
      @NamedQuery(
          name = "UpgradeEntity.findUpgradeByRequestId",
          query = "SELECT u FROM UpgradeEntity u WHERE u.requestId = :requestId"),
      @NamedQuery(
          name = "UpgradeEntity.findLatestForClusterInDirection",
          query = "SELECT u FROM UpgradeEntity u JOIN RequestEntity r ON u.requestId = r.requestId WHERE u.clusterId = :clusterId AND u.direction = :direction ORDER BY r.startTime DESC, u.upgradeId DESC"),
      @NamedQuery(
          name = "UpgradeEntity.findLatestForCluster",
          query = "SELECT u FROM UpgradeEntity u JOIN RequestEntity r ON u.requestId = r.requestId WHERE u.clusterId = :clusterId ORDER BY r.startTime DESC"),
      @NamedQuery(
          name = "UpgradeEntity.findAllRequestIds",
          query = "SELECT upgrade.requestId FROM UpgradeEntity upgrade"),
      @NamedQuery(
          name = "UpgradeEntity.findRevertable",
          query = "SELECT upgrade FROM UpgradeEntity upgrade WHERE upgrade.revertAllowed = 1 AND upgrade.clusterId = :clusterId ORDER BY upgrade.upgradeId DESC",
          hints = {
              @QueryHint(name = "eclipselink.query-results-cache", value = "true"),
              @QueryHint(name = "eclipselink.query-results-cache.ignore-null", value = "false"),
              @QueryHint(name = "eclipselink.query-results-cache.size", value = "1")
            }),
      @NamedQuery(
          name = "UpgradeEntity.findRevertableUsingJPQL",
          query = "SELECT upgrade FROM UpgradeEntity upgrade WHERE upgrade.repoVersionId IN (SELECT upgrade.repoVersionId FROM UpgradeEntity upgrade WHERE upgrade.clusterId = :clusterId AND upgrade.orchestration IN :revertableTypes GROUP BY upgrade.repoVersionId HAVING MOD(COUNT(upgrade.repoVersionId), 2) != 0) ORDER BY upgrade.upgradeId DESC",
          hints = {
              @QueryHint(name = "eclipselink.query-results-cache", value = "true"),
              @QueryHint(name = "eclipselink.query-results-cache.ignore-null", value = "false"),
              @QueryHint(name = "eclipselink.query-results-cache.size", value = "1")
            })
          })
  public class UpgradeEntity {
  
    @Id
    @Column(name = "upgrade_id", nullable = false, insertable = true, updatable = false)
    @GeneratedValue(strategy = GenerationType.TABLE, generator = "upgrade_id_generator")
    private Long upgradeId;
  
    @Column(name = "cluster_id", nullable = false, insertable = true, updatable = false)
    private Long clusterId;
  
    @Column(name = "request_id", nullable = false, insertable = false, updatable = false)
    private Long requestId;
  
    /**
     * The request entity associated with this upgrade. This relationship allows
     * JPA to correctly order non-flushed commits during the transaction which
     * creates the upgrade. Without it, JPA would not know the correct order and
     * may try to create the upgrade before the request.
     */
    @OneToOne(optional = false, fetch = FetchType.LAZY)
    @JoinColumn(name = "request_id", nullable = false, insertable = true, updatable = false)
    private RequestEntity requestEntity = null;
  
    @Column(name="direction", nullable = false)
    @Enumerated(value = EnumType.STRING)
    private Direction direction = Direction.UPGRADE;
  
    @Column(name="upgrade_package", nullable = false)
    private String upgradePackage;
  
    @Column(name="upgrade_package_stack", nullable = false)
    private String upgradePackStack;
  
    @Column(name="upgrade_type", nullable = false)
    @Enumerated(value = EnumType.STRING)
    private UpgradeType upgradeType;
  
    @Column(name = "repo_version_id", insertable = false, updatable = false)
    private Long repoVersionId;
  
    @JoinColumn(name = "repo_version_id", referencedColumnName = "repo_version_id", nullable = false)
    private RepositoryVersionEntity repositoryVersion;
  
    @Column(name = "skip_failures", nullable = false)
    private Integer skipFailures = 0;
  
    @Column(name = "skip_sc_failures", nullable = false)
    private Integer skipServiceCheckFailures = 0;
  
    @Column(name="downgrade_allowed", nullable = false)
    private Short downgradeAllowed = 1;
  
    /**
     * Whether this upgrade is a candidate to be reverted. The current restriction
     * on this behavior is that only the most recent
     * {@link RepositoryType#PATCH}/{@link RepositoryType#MAINT} for a given
     * cluster can be reverted at a time.
     * <p/>
     * All upgrades are created with this value defaulted to {@code false}. Upon
     * successful finalization of the upgrade, if the upgrade was the correct type
     * and direction, then it becomes a candidate for reversion and this value is
     * set to {@code true}. If an upgrade is reverted after being finalized, then
     * this value to should set to {@code false} explicitely.
     * <p/>
     * There can exist <i>n</i> number of upgrades with this value set to
     * {@code true}. The idea is that only the most recent upgrade with this value
     * set to {@code true} will be able to be reverted.
     */
    @Column(name = "revert_allowed", nullable = false)
    private Short revertAllowed = 0;
  
    @Column(name="orchestration", nullable = false)
    @Enumerated(value = EnumType.STRING)
    private RepositoryType orchestration = RepositoryType.STANDARD;
  
    /**
     * {@code true} if the upgrade has been marked as suspended.
     */
    @Column(name = "suspended", nullable = false, length = 1)
    private Short suspended = 0;
  
    @OneToMany(mappedBy = "upgradeEntity", cascade = { CascadeType.ALL })
    private List<UpgradeGroupEntity> upgradeGroupEntities;
  
    /**
     * Uni-directional relationship between an upgrade an all of the components in
     * that upgrade.
     */
    @OneToMany(orphanRemoval=true, cascade = { CascadeType.ALL })
    @JoinColumn(name = "upgrade_id")
    private List<UpgradeHistoryEntity> upgradeHistory;
  
    /**
     * @return the id
     */
    public Long getId() {
      return upgradeId;
    }
  
    /**
     * @param id the id
     */
    public void setId(Long id) {
      upgradeId = id;
    }
  
    /**
     * @return the cluster id
     */
    public Long getClusterId() {
      return clusterId;
    }
  
    /**
     * @param id the cluster id
     */
    public void setClusterId(Long id) {
      clusterId = id;
    }
  
    /**
     * @return the upgrade items
     */
    public List<UpgradeGroupEntity> getUpgradeGroups() {
      return upgradeGroupEntities;
    }
  
    /**
     * @param items the upgrade items
     */
    public void setUpgradeGroups(List<UpgradeGroupEntity> items) {
      for (UpgradeGroupEntity entity : items) {
        entity.setUpgradeEntity(this);
      }
      upgradeGroupEntities = items;
    }
  
    /**
     * @return the request id
     */
    public Long getRequestId() {
      return requestId;
    }
  
    public void setRequestEntity(RequestEntity requestEntity) {
      this.requestEntity = requestEntity;
      requestId = requestEntity.getRequestId();
    }
  
    /**
     * @return the direction of the upgrade
     */
    public Direction getDirection() {
      return direction;
    }
  
    /**
     * @param direction the direction of the upgrade
     */
    public void setDirection(Direction direction) {
      this.direction = direction;
    }
  
    /**
     * @return the upgrade type, such as rolling oNr non_rolling
     */
    public UpgradeType getUpgradeType() {
      return upgradeType;
    }
  
    /**
     * @return possibility to process downgrade
     */
    public Boolean isDowngradeAllowed() {
      return downgradeAllowed != null ? (downgradeAllowed != 0) : null;
    }
  
    /**
     * @param canDowngrade {@code true} to allow downgrade, {@code false} to disallow downgrade
     */
    public void setDowngradeAllowed(boolean canDowngrade) {
      downgradeAllowed = (!canDowngrade ? (short) 0 : (short) 1);
    }
  
    /**
     * Gets whether this upgrade supports being reverted. Upgrades can be reverted
     * (downgraded after finalization) if they are either
     * {@link RepositoryType#MAINT} or {@link RepositoryType#PATCH} and have never
     * been previously downgraded.
     *
     * @return {@code true} if this upgrade can potentially be revereted.
     */
    public Boolean isRevertAllowed() {
      return revertAllowed != null ? (revertAllowed != 0) : null;
    }
  
    /**
     * Sets whether this upgrade supports being reverted. This should only ever be
     * called from the finalization of an upgrade. {@link RepositoryType#MAINT} or
     * {@link RepositoryType#PATCH} upgrades can be revereted only if they have
     * not previously been downgraded.
     *
     * @param revertable
     *          {@code true} to mark this as being revertable, {@code false}
     *          otherwise.
     */
    public void setRevertAllowed(boolean revertable) {
      revertAllowed = (!revertable ? (short) 0 : (short) 1);
    }
  
    /**
     * @param upgradeType
     *          the upgrade type to set
     */
    public void setUpgradeType(UpgradeType upgradeType) {
      this.upgradeType = upgradeType;
    }
  
    /**
     * @return the upgrade package name, without the extension.
     */
    public String getUpgradePackage() {
      return upgradePackage;
    }
  
    /**
     * @param upgradePackage the upgrade pack to set
     */
    public void setUpgradePackage(String upgradePackage) {
      this.upgradePackage = upgradePackage;
    }
  
    /**
     * @return the stack that owns the upgrade pack
     */
    public StackId getUpgradePackStackId() {
      return null == upgradePackStack ? null : new StackId(upgradePackStack);
    }
  
    /**
     * @param stackId
     *          the stack that owns the upgrade pack
     */
    public void setUpgradePackStackId(StackId stackId) {
      upgradePackStack = stackId.toString();
    }
  
    /**
     * Gets whether skippable components that failed are automatically skipped.
     * They will be placed into the {@link HostRoleStatus#SKIPPED_FAILED} state.
     *
     * @return {@code true} if skippable failed components are automatically
     *         skipped when they fail.
     */
    public boolean isComponentFailureAutoSkipped() {
      return skipFailures != 0;
    }
  
    /**
     * Sets whether skippable components that failed are automatically skipped.
     *
     * @param autoSkipComponentFailures
     *          {@code true} to automatically skip component failures which are
     *          marked as skippable.
     */
    public void setAutoSkipComponentFailures(boolean autoSkipComponentFailures) {
      skipFailures = autoSkipComponentFailures ? 1 : 0;
    }
  
    /**
     * Gets whether skippable service checks that failed are automatically
     * skipped. They will be placed into the {@link HostRoleStatus#SKIPPED_FAILED}
     * state.
     *
     * @return {@code true} if service checks are automatically skipped when they
     *         fail.
     */
    public boolean isServiceCheckFailureAutoSkipped() {
      return skipServiceCheckFailures != 0;
    }
  
    /**
     * Sets whether skippable service checks that failed are automatically
     * skipped.
     *
     * @param autoSkipServiceCheckFailures
     *          {@code true} to automatically skip service check failures which
     *          are marked as being skippable.
     */
    public void setAutoSkipServiceCheckFailures(boolean autoSkipServiceCheckFailures) {
      skipServiceCheckFailures = autoSkipServiceCheckFailures ? 1 : 0;
    }
  
    /**
     * 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.
     *
     * @return {@code true} if the upgrade is suspended.
     */
    public boolean isSuspended() {
      return suspended != 0;
    }
  
    /**
     * Sets whether the upgrade is suspended.
     *
     * @param suspended
     *          {@code true} to mark the upgrade as suspended.
     */
    public void setSuspended(boolean suspended) {
      this.suspended = suspended ? (short) 1 : (short) 0;
    }
  
    /**
     * Adds a historical entry for a service component in this upgrade.
     *
     * @param historicalEntry
     *          the entry to add.
     */
    public void addHistory(UpgradeHistoryEntity historicalEntry) {
      if (null == upgradeHistory) {
        upgradeHistory = new ArrayList<>();
      }
  
      upgradeHistory.add(historicalEntry);
    }
  
    /**
     * Gets the history of this component's upgrades and downgrades.
     *
     * @return the component history, or {@code null} if none.
     */
    public List<UpgradeHistoryEntity> getHistory() {
      return upgradeHistory;
    }
  
    /**
     * 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.
     * <p/>
     * When the direction is {@link Direction#UPGRADE}, this represents the target
     * repository. <br/>
     * When the direction is {@link Direction#DOWNGRADE}, this represents the
     * repository being downgraded from.
     *
     * @return the repository version being upgraded to or downgraded from (never
     *         {@code null}).
     */
    public RepositoryVersionEntity getRepositoryVersion() {
      return repositoryVersion;
    }
  
    /**
     * Sets the repository version for this upgrade. This value will change
     * depending on the direction of the upgrade.
     * <p/>
     * When the direction is {@link Direction#UPGRADE}, this represents the target
     * repository. <br/>
     * When the direction is {@link Direction#DOWNGRADE}, this represents the
     * repository being downgraded from.
     *
     * @param repositoryVersion
     *          the repository version being upgraded to or downgraded from (not
     *          {@code null}).
     */
    public void setRepositoryVersion(RepositoryVersionEntity repositoryVersion) {
      this.repositoryVersion = repositoryVersion;
    }
  
    /**
     * 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.
     *
     * @param type  the orchestration
     */
    public void setOrchestration(RepositoryType type) {
      orchestration = type;
    }
  
    /**
     * @return  the orchestration type
     */
    public RepositoryType getOrchestration() {
      return orchestration;
    }
  
    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object o) {
      if (this == o) {
        return true;
      }
  
      if (o == null || getClass() != o.getClass()) {
        return false;
      }
  
      UpgradeEntity that = (UpgradeEntity) o;
      return new EqualsBuilder()
          .append(upgradeId, that.upgradeId)
          .append(clusterId, that.clusterId)
          .append(requestId, that.requestId)
          .append(direction, that.direction)
          .append(suspended, that.suspended)
          .append(upgradeType, that.upgradeType)
          .append(upgradePackage, that.upgradePackage)
          .isEquals();
    }
  
    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode() {
      return Objects.hashCode(upgradeId, clusterId, requestId, direction, suspended, upgradeType,
          upgradePackage);
    }
  
   /**
   * Removes historical entries for a service component in this upgrade.
   */
   public void removeHistories(Collection<UpgradeHistoryEntity> upgradeHistoryEntity) {
      if (upgradeHistory != null) {
        upgradeHistory.removeAll(upgradeHistoryEntity);
      }
    }
  }
  