path: root/ECOMP-REST/src/main/java/org/openecomp/policy/rest/jpa/PolicyEntity.java

/*-
 * ============LICENSE_START=======================================================
 * ECOMP-REST
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed 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.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.policy.rest.jpa;
/*
 */
import java.io.Serializable;
import java.util.Date;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Index;
import javax.persistence.JoinColumn;
import javax.persistence.Lob;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToOne;
import javax.persistence.PrePersist;
import javax.persistence.PreUpdate;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.UniqueConstraint;
import javax.persistence.Version;

import com.fasterxml.jackson.annotation.JsonBackReference;
import com.fasterxml.jackson.annotation.JsonManagedReference;

/*
 * The Entity class to persist a policy object and its configuration data
 */

/**
 *
 */
@Entity
//Add a non-unique index and a constraint that says the combo of policyName and scopeId must be unique
@Table(name="PolicyEntity", indexes = {@Index(name="scope", columnList="scope", unique=false),
		@Index(name="policyName", columnList="policyName", unique=false)},
		uniqueConstraints=@UniqueConstraint(columnNames={"policyName", "scope"}))

//Using a sequence generator because the value is available as soon as the
//the object is persisted.  That is, you don't have to flush/commit to the DB.
//@SequenceGenerator(name="seqPolicy", initialValue=1, allocationSize=1)

@NamedQueries({
	@NamedQuery(name="PolicyEntity.findAll", query="SELECT e FROM PolicyEntity e "),
	@NamedQuery(name="PolicyEntity.findAllByDeletedFlag", query="SELECT e FROM PolicyEntity e WHERE e.deleted = :deleted"),
	@NamedQuery(name="PolicyEntity.FindById", query="SELECT e FROM PolicyEntity e WHERE e.policyId = :id"),
	@NamedQuery(name="PolicyEntity.deleteAll", query="DELETE FROM PolicyEntity WHERE 1=1"),
	@NamedQuery(name="PolicyEntity.findByNameAndScope", query="SELECT e FROM PolicyEntity e WHERE e.policyName = :name AND e.scope = :scope")
})

public class PolicyEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	@Id
	//@GeneratedValue(strategy = GenerationType.SEQUENCE, generator="seqPolicy")
	@GeneratedValue(strategy = GenerationType.AUTO)
	@Column (name="policyId")
	@JsonBackReference
	private long policyId;

	@Column(name="policyName", nullable=false, unique=false, length=255)
	private String policyName;
	
	//The scope is the directory structure in dot notation.  For example: org.openecomp.myproject 
	@Column(name="scope", nullable=false, unique=false, length=255)
	private String scope;
	
	@Version 
	@Column(name="version")
	private int version;
	
	//not going to be used
	@Column(name="policyVersion")
	private int policyVersion = 0;
	
	@Lob
	@Column(name="policyData", nullable=false, columnDefinition="TEXT")
	private String policyData = "NoData";

	@OneToOne(optional=true, orphanRemoval=true)
	@JoinColumn(name="configurationDataId", referencedColumnName="configurationDataId")
	@JsonManagedReference
	private ConfigurationDataEntity configurationDataEntity;
	
	@OneToOne(optional=true, orphanRemoval=true)
	@JoinColumn(name="actionBodyId", referencedColumnName="actionBodyId")
	@JsonManagedReference
	private ActionBodyEntity actionBodyEntity;
	
	@Column(name="created_by", nullable=false, length=255)
	private String createdBy = "guest";

	@Temporal(TemporalType.TIMESTAMP)
	@Column(name="created_date", updatable=false)
	private Date createdDate;

	@Column(name="description", nullable=false, length=2048)
	private String description = "NoDescription";

	@Column(name="modified_by", nullable=false, length=255)
	private String modifiedBy = "guest";

	@Temporal(TemporalType.TIMESTAMP)
	@Column(name="modified_date", nullable=false)
	private Date modifiedDate;
	
	@Column(name="deleted", nullable=false)
	private boolean deleted = false;

	public PolicyEntity() {
		super();
	}

	@PrePersist
	public void	prePersist() {
		Date date = new Date();
		this.createdDate = date;
		this.modifiedDate = date;
	}

	@PreUpdate
	public void preUpdate() {
		this.modifiedDate = new Date();		
	}
	
	/*
	public void resetPolicyVersion(){
		this.policyVersion = 1;
	}
	public void advancePolicyVersion(){
		this.policyVersion++;
	}
	public int getPolicyVersion(){
		return this.policyVersion;
	}
	public void setPolicyVersion(int polVer){
		this.policyVersion = polVer;
	}
	*/

	/**
	 * @return the policyId
	 */
	public long getPolicyId() {
		return policyId;
	}

	/**
	 * @param policyId cannot be set
	 */

	public String getPolicyName() {
		return policyName;
	}

	public void setPolicyName(String policyName) {
		this.policyName = policyName;
	}

	/**
	 * @return the policyData
	 */
	public String getPolicyData() {
		return policyData;
	}

	/**
	 * @param policyData the policyData to set
	 */
	public void setPolicyData(String policyData) {
		this.policyData = policyData;
	}

	/**
	 * @return the configurationDataEntity
	 */
	public ConfigurationDataEntity getConfigurationData() {
		return configurationDataEntity;
	}

	/**
	 * @param configurationDataEntity the configurationDataEntity to set
	 */
	public void setConfigurationData(ConfigurationDataEntity configurationDataEntity) {
		this.configurationDataEntity = configurationDataEntity;
	}

	/**
	 * @return the actionBodyEntity
	 */
	public ActionBodyEntity getActionBodyEntity() {
		return actionBodyEntity;
	}

	/**
	 * @param actionBodyEntity the actionBodyEntity to set
	 */
	public void setActionBodyEntity(ActionBodyEntity actionBodyEntity) {
		this.actionBodyEntity = actionBodyEntity;
	}

	/**
	 * @return the scope
	 */
	public String getScope() {
		return scope;
	}

	/**
	 * @param scope the scope to set
	 */
	public void setScope(String scope) {
		this.scope = scope;
	}

	/**
	 * @return the createdBy
	 */
	public String getCreatedBy() {
		return createdBy;
	}

	/**
	 * @param createdBy the createdBy to set
	 */
	public void setCreatedBy(String createdBy) {
		this.createdBy = createdBy;
	}

	/**
	 * @return the description
	 */
	public String getDescription() {
		return description;
	}

	/**
	 * @param description the description to set
	 */
	public void setDescription(String description) {
		this.description = description;
	}

	/**
	 * @return the modifiedBy
	 */
	public String getModifiedBy() {
		return modifiedBy;
	}

	/**
	 * @param modifiedBy the modifiedBy to set
	 */
	public void setModifiedBy(String modifiedBy) {
		this.modifiedBy = modifiedBy;
	}

	/**
	 * @return the version
	 */
	public int getVersion() {
		return version;
	}

	/**
	 * @return the createdDate
	 */
	public Date getCreatedDate() {
		return createdDate;
	}

	/**
	 * @return the modifiedDate
	 */
	public Date getModifiedDate() {
		return modifiedDate;
	}

	/**
	 * @return the deleted
	 */
	public boolean isDeleted() {
		return deleted;
	}

	/**
	 * @param deleted the deleted to set
	 */
	public void setDeleted(boolean deleted) {
		this.deleted = deleted;
	}


}