path: root/ECOMP-REST/src/main/java/org/openecomp/policy/rest/jpa/Attribute.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 java.util.HashSet;
import java.util.Set;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.NamedQuery;
import javax.persistence.OneToMany;
import javax.persistence.OrderBy;
import javax.persistence.PrePersist;
import javax.persistence.PreUpdate;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.Transient;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openecomp.policy.rest.XacmlAdminAuthorization;
import org.openecomp.policy.rest.jpa.UserInfo;

import com.att.research.xacml.api.Identifier;
import com.att.research.xacml.std.IdentifierImpl;
import com.fasterxml.jackson.annotation.JsonBackReference;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonManagedReference;

/**
 * The persistent class for the Attribute database table.
 * 
 */
@Entity
@Table(name="Attribute")
@NamedQuery(name="Attribute.findAll", query="SELECT a FROM Attribute a order by  a.priority asc, a.xacmlId asc")
public class Attribute implements Serializable {
	private static final long serialVersionUID = 1L;
	
	public static String	ATTRIBUTE_DESIGNATOR = "Attribute Designator";
	public static String	ATTRIBUTE_SELECTOR = "Attribute Selector";

	@Id
	@GeneratedValue(strategy = GenerationType.AUTO)
	@Column(name="id")
	private int id;

	//bi-directional many-to-one association to Category
	@ManyToOne
	@JoinColumn(name="constraint_type", nullable=true)
	@JsonIgnore
	private ConstraintType constraintType;

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

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

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

	@Column(name="PRIORITY", nullable=true)
	@OrderBy("asc")
	private String priority;
	
	@Column(name="ATTRIBUTE_VALUE", nullable=true)
	@OrderBy("asc")
	private String attributeValue;

	@Column(name="xacml_id",  unique = true, nullable=false)
	@OrderBy("asc")
	private String xacmlId = "urn";

	//bi-directional many-to-one association to ConstraintValue
	@OneToMany(mappedBy="attribute", orphanRemoval=true, cascade=CascadeType.REMOVE)
	@JsonIgnore
	private Set<ConstraintValue> constraintValues = new HashSet<ConstraintValue>();

	//bi-directional many-to-one association to Category
	@ManyToOne
	@JoinColumn(name="category")
	@JsonIgnore
	private Category categoryBean;

	//bi-directional many-to-one association to Datatype
	@ManyToOne
	@JoinColumn(name="datatype")
	private Datatype datatypeBean;

	@Column(name="is_designator", nullable=false)
	@JsonIgnore
	private char isDesignator = '1';

	@Column(name="selector_path", nullable=true, length=2048)
	private String selectorPath;
	

	
	@Transient
	private String issuer = null;
	
	@Transient
	private boolean mustBePresent = false;

	@ManyToOne(optional = false)
	@JoinColumn(name="created_by")
	private UserInfo userCreatedBy;

	@ManyToOne(optional = false)
	@JoinColumn(name="modified_by")
	private UserInfo userModifiedBy;
	
	public UserInfo getUserCreatedBy() {
		return userCreatedBy;
	}

	public void setUserCreatedBy(UserInfo userCreatedBy) {
		this.userCreatedBy = userCreatedBy;
	}

	public UserInfo getUserModifiedBy() {
		return userModifiedBy;
	}

	public void setUserModifiedBy(UserInfo userModifiedBy) {
		this.userModifiedBy = userModifiedBy;
	}

	private static Log logger = LogFactory.getLog(Attribute.class);
	public Attribute() {
	}
	
	public Attribute(String domain) {
		this.xacmlId = domain;
	}
	
	public Attribute(String domain, String user) {
		this(domain);
	}
	
	public Attribute(Attribute copy, String user) {
		this(copy.getXacmlId() + ":(0)", user);
		this.constraintType = copy.getConstraintType();
		this.categoryBean = copy.getCategoryBean();
		this.datatypeBean = copy.getDatatypeBean();
		this.description = copy.getDescription();
		for (ConstraintValue value : copy.getConstraintValues()) {
			ConstraintValue newValue = new ConstraintValue(value);
			newValue.setAttribute(this);
			this.addConstraintValue(newValue);
		}
	}

	@PrePersist
	public void	prePersist() {
		Date date = new Date();
		this.createdDate = date;
		this.modifiedDate = date;
	}
	
	@PreUpdate
	public void preUpdate() {
		this.modifiedDate = new Date();
		try {
			this.userModifiedBy = XacmlAdminAuthorization.getUserId();
		} catch (Exception e) {
			logger.error("Exception caused While adding Modified by Role"+e);
			// TODO:EELF Cleanup - Remove logger
			//PolicyLogger.error(MessageCodes.EXCEPTION_ERROR, e, "Attribute", "Exception caused While adding Modified by Role");
		}
	}

	public int getId() {
		return this.id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public ConstraintType getConstraintType() {
		return this.constraintType;
	}

	public void setConstraintType(ConstraintType constraintType) {
		this.constraintType = constraintType;
	}

	public Date getCreatedDate() {
		return this.createdDate;
	}

	public void setCreatedDate(Date createdDate) {
		this.createdDate = createdDate;
	}

	public String getDescription() {
		return this.description;
	}

	public void setDescription(String description) {
		this.description = description;
	}

	public Date getModifiedDate() {
		return this.modifiedDate;
	}

	public void setModifiedDate(Date modifiedDate) {
		this.modifiedDate = modifiedDate;
	}

	public String getXacmlId() {
		return this.xacmlId;
	}
	
/*	@Transient
	public Identifier getXacmlIdentifier() {
		return new IdentifierImpl(this.xacmlId);
	}*/

	public void setXacmlId(String xacmlId) {
		this.xacmlId = xacmlId;
	}

	public Set<ConstraintValue> getConstraintValues() {
		return this.constraintValues;
	}

	public void setConstraintValues(Set<ConstraintValue> constraintValues) {
		for (ConstraintValue value : this.constraintValues) {
			value.setAttribute(this);
		}
		this.constraintValues = constraintValues;
	}

	public ConstraintValue addConstraintValue(ConstraintValue constraintValue) {
		if (this.constraintValues == null) {
			this.constraintValues = new HashSet<ConstraintValue>();
		}
		this.constraintValues.add(constraintValue);
		constraintValue.setAttribute(this);

		return constraintValue;
	}

	public ConstraintValue removeConstraintValue(ConstraintValue constraintValue) {
		this.constraintValues.remove(constraintValue);
		constraintValue.setAttribute(null);

		return constraintValue;
	}
	
	public void removeAllConstraintValues() {
		if (this.constraintValues == null) {
			return;
		}
		for (ConstraintValue value : this.constraintValues) {
			value.setAttribute(null);
		}
		this.constraintValues.clear();
	}

	public Category getCategoryBean() {
		return this.categoryBean;
	}

	public void setCategoryBean(Category categoryBean) {
		this.categoryBean = categoryBean;
	}

	public Datatype getDatatypeBean() {
		return this.datatypeBean;
	}

	public void setDatatypeBean(Datatype datatypeBean) {
		this.datatypeBean = datatypeBean;
	}

	public char getIsDesignator() {
		return this.isDesignator;
	}
	
	public void setIsDesignator(char is) {
		this.isDesignator = is;
	}
	
	public String getSelectorPath() {
		return this.selectorPath;
	}
	
	public void setSelectorPath(String path) {
		this.selectorPath = path;
	}
	
	@Transient
	public String getIssuer() {
		return issuer;
	}

	@Transient
	public void setIssuer(String issuer) {
		this.issuer = issuer;
	}

	@Transient
	public boolean isMustBePresent() {
		return mustBePresent;
	}

	@Transient
	public void setMustBePresent(boolean mustBePresent) {
		this.mustBePresent = mustBePresent;
	}

	@Transient
	public boolean isDesignator() {
		return (this.isDesignator == '1');
	}
	
	@Transient
	public void setIsDesignator(boolean is) {
		if (is) {
			this.isDesignator = '1';
		} else {
			this.isDesignator = '0';
		}
	}	
	
	public String getPriority() {
		return priority;
	}

	public void setPriority(String priority) {
		this.priority = priority;
	}
	
	public String getAttributeValue() {
		return attributeValue;
	}

	public void setAttributeValue(String attributeValue) {
		this.attributeValue = attributeValue;
	}
}