/*
* RHQ Management Platform
* Copyright (C) 2005-2008 Red Hat, Inc.
* All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License, version 2, as
* published by the Free Software Foundation, and/or the GNU Lesser
* General Public License, version 2.1, also as published by the Free
* Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License and the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License
* and the GNU Lesser General Public License along with this program;
* if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.rhq.core.domain.content;
import java.io.Serializable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import org.rhq.core.domain.content.transfer.ContentResponseResult;
/**
* Domain representation of the steps used to install a package.
*
* @author Jason Dobies
*/
@Entity
@NamedQueries( {
@NamedQuery(name = PackageInstallationStep.QUERY_DELETE_BY_RESOURCES, query = "DELETE PackageInstallationStep pis WHERE pis.installedPackageHistory IN ( SELECT iph FROM InstalledPackageHistory iph WHERE iph.resource.id IN ( :resourceIds ) )"),
@NamedQuery(name = PackageInstallationStep.QUERY_FIND_BY_INSTALLED_PACKAGE_HISTORY_ID, query = "SELECT pis FROM PackageInstallationStep pis "
+ "WHERE pis.installedPackageHistory.id = :installedPackageHistoryId")
})
@SequenceGenerator(allocationSize = org.rhq.core.domain.util.Constants.ALLOCATION_SIZE, name = "RHQ_PACKAGE_INST_STEP_ID_SEQ", sequenceName = "RHQ_PACKAGE_INST_STEP_ID_SEQ")
@Table(name = "RHQ_PACKAGE_INST_STEP")
public class PackageInstallationStep implements Serializable {
// Constants --------------------------------------------
private static final long serialVersionUID = 1L;
public static final String QUERY_DELETE_BY_RESOURCES = "PackageInstallationStep.deleteByResources";
public static final String QUERY_FIND_BY_INSTALLED_PACKAGE_HISTORY_ID = "PackageInstallationStep.findByInstalledPackageHistoryId";
// Attributes --------------------------------------------
/**
* Database assigned ID.
*/
@Column(name = "ID", nullable = false)
@GeneratedValue(strategy = GenerationType.AUTO, generator = "RHQ_PACKAGE_INST_STEP_ID_SEQ")
@Id
private int id;
@Column(name = "STEP_KEY", nullable = false)
private String key;
/**
* Relative order of the step in the overall list of steps.
*/
@Column(name = "STEP_ORDER", nullable = false)
private int order;
/**
* Description of what the step will do.
*/
@Column(name = "DESCRIPTION")
private String description;
/**
* If this step failed during execution, this will be populated with the plugin provided error message describing
* the failure.
*/
@Column(name = "ERROR_MSG")
private String errorMessage;
/**
* Plugin provided indicator of whether or not the step was executed successfully.
*/
@Column(name = "RESULT", nullable = false)
@Enumerated(EnumType.STRING)
private ContentResponseResult result;
/**
* Package version against which this step applies.
*/
@JoinColumn(name = "INSTALLED_PKG_HIST_ID", referencedColumnName = "ID")
@ManyToOne
private InstalledPackageHistory installedPackageHistory;
// Constructor ----------------------------------------
public PackageInstallationStep() {
// for JPA use
}
// Public --------------------------------------------
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getKey() {
return key;
}
public void setKey(String key) {
this.key = key;
}
public int getOrder() {
return order;
}
public void setOrder(int order) {
this.order = order;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public String getErrorMessage() {
return errorMessage;
}
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
public ContentResponseResult getResult() {
return result;
}
public void setResult(ContentResponseResult result) {
this.result = result;
}
public InstalledPackageHistory getInstalledPackageHistory() {
return installedPackageHistory;
}
public void setInstalledPackageHistory(InstalledPackageHistory installedPackageHistory) {
this.installedPackageHistory = installedPackageHistory;
}
}