/**
* Copyright (C) 2008 - Abiquo Holdings S.L. All rights reserved.
*
* Please see /opt/abiquo/tomcat/webapps/legal/ on Abiquo server
* or contact contact@abiquo.com for licensing information.
*/
package com.abiquo.server.core.enterprise;
import java.util.ArrayList;
import java.util.List;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.OneToOne;
import javax.persistence.PrimaryKeyJoinColumn;
import javax.persistence.Table;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;
import org.hibernate.annotations.Filter;
import org.hibernate.annotations.FilterDef;
import org.hibernate.annotations.FilterDefs;
import org.hibernate.annotations.Filters;
import org.hibernate.annotations.ForeignKey;
import org.hibernate.annotations.NamedQueries;
import org.hibernate.annotations.NamedQuery;
import org.hibernate.annotations.ParamDef;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.Range;
import org.hibernate.validator.constraints.URL;
import com.abiquo.model.validation.LimitRange;
import com.abiquo.server.core.appslibrary.AppsLibrary;
import com.abiquo.server.core.appslibrary.VirtualMachineTemplate;
import com.abiquo.server.core.common.DefaultEntityWithLimits;
import com.abiquo.server.core.common.Limit;
import com.abiquo.server.core.pricing.PricingTemplate;
import com.softwarementors.validation.constraints.LeadingOrTrailingWhitespace;
import com.softwarementors.validation.constraints.Required;
@Entity
@FilterDefs( {@FilterDef(name = Enterprise.SCOPE_VIEW, parameters = {@ParamDef(type = "integer", name = Scope.SCOPE_ID)})})
@Filters( {@Filter(name = Enterprise.SCOPE_VIEW, condition = " idEnterprise in (SELECT e.idEnterprise FROM enterprise e inner join scope_resource s on e.idEnterprise=s.idResource and s.idScope=:idScope and s.resourceType='ENTERPRISE') ")})
@Table(name = Enterprise.TABLE_NAME, uniqueConstraints = {})
@org.hibernate.annotations.Table(appliesTo = Enterprise.TABLE_NAME, indexes = {})
@NamedQueries( {@NamedQuery(name = Enterprise.NAMED_QUERY_FIND_ID_NAME_BY_SCOPE, query = "select new com.abiquo.server.core.enterprise.Enterprise(e.id, e.name) from Enterprise e where e.name like :name order by e.name asc")})
public class Enterprise extends DefaultEntityWithLimits
{
public static final String SCOPE_VIEW = "scope_view";
// ****************************** JPA support *******************************
public static final String TABLE_NAME = "enterprise";
// ********** Named queries **************
public static final String NAMED_QUERY_FIND_ID_NAME_BY_SCOPE = "Enterprise.findIdNameByScope";
// DO NOT ACCESS: present due to needs of infrastructure support. *NEVER* call from business
// code
protected Enterprise()
{
// Just for JPA support
setName("FIXME");
}
private final static String ID_COLUMN = "idEnterprise";
@Id
@GeneratedValue
@Column(name = ID_COLUMN, nullable = false)
private Integer id;
@Override
public Integer getId()
{
return this.id;
}
// ******************************* Properties *******************************
public final static String NAME_PROPERTY = "name";
private final static boolean NAME_REQUIRED = true;
public final static int NAME_LENGTH_MIN = 1;
public final static int NAME_LENGTH_MAX = 40;
private final static boolean NAME_LEADING_OR_TRAILING_WHITESPACES_ALLOWED = false;
private final static String NAME_COLUMN = "name";
@Column(name = NAME_COLUMN, nullable = !NAME_REQUIRED, length = NAME_LENGTH_MAX)
private String name;
@Required(value = NAME_REQUIRED)
@Length(min = NAME_LENGTH_MIN, max = NAME_LENGTH_MAX)
@LeadingOrTrailingWhitespace(allowed = NAME_LEADING_OR_TRAILING_WHITESPACES_ALLOWED)
public String getName()
{
return this.name;
}
public void setName(final String name)
{
this.name = name;
}
public final static String IS_RESTRICTED_RESERVATION_PROPERTY = "isReservationRestricted";
private final static boolean IS_RESTRICTED_RESERVATION_REQUIRED = false;
private final static String IS_RESTRICTED_RESERVATION_COLUMN = "isReservationRestricted";
@Column(name = IS_RESTRICTED_RESERVATION_COLUMN, nullable = !IS_RESTRICTED_RESERVATION_REQUIRED)
private boolean isReservationRestricted;
@Required(value = IS_RESTRICTED_RESERVATION_REQUIRED)
public boolean getIsReservationRestricted()
{
return this.isReservationRestricted;
}
public void setIsReservationRestricted(final boolean isReservationRestricted)
{
this.isReservationRestricted = isReservationRestricted;
}
public final static String REPOSITORY_SOFT_PROPERTY = "repositorySoft";
/* package */final static String REPOSITORY_SOFT_COLUMN = "repositorySoft";
/* package */final static long REPOSITORY_SOFT_MIN = 0;
/* package */final static long REPOSITORY_SOFT_MAX = Long.MAX_VALUE;
/* package */final static boolean REPOSITORY_SOFT_REQUIRED = true;
@Column(name = REPOSITORY_SOFT_COLUMN, nullable = false)
@Range(min = REPOSITORY_SOFT_MIN, max = REPOSITORY_SOFT_MAX)
private long repositorySoft;
@Required(value = REPOSITORY_SOFT_REQUIRED)
public long getRepositorySoft()
{
return this.repositorySoft;
}
private void setRepositorySoft(final long repositorySoft)
{
this.repositorySoft = repositorySoft;
}
public final static String REPOSITORY_HARD_PROPERTY = "repositoryHard";
/* package */final static String REPOSITORY_HARD_COLUMN = "repositoryHard";
/* package */final static long REPOSITORY_HARD_MIN = 0;
/* package */final static long REPOSITORY_HARD_MAX = Long.MAX_VALUE;
/* package */final static boolean REPOSITORY_HARD_REQUIRED = true;
@Column(name = REPOSITORY_HARD_COLUMN, nullable = false)
@Range(min = REPOSITORY_HARD_MIN, max = REPOSITORY_HARD_MAX)
private long repositoryHard;
@Required(value = REPOSITORY_HARD_REQUIRED)
public long getRepositoryHard()
{
return this.repositoryHard;
}
private void setRepositoryHard(final long repositoryHard)
{
this.repositoryHard = repositoryHard;
}
@LimitRange(type = "repository")
public Limit getRepositoryLimits()
{
return new Limit(repositorySoft, repositoryHard);
}
public void setRepositoryLimits(final Limit limit)
{
setRepositorySoft(limit.soft);
setRepositoryHard(limit.hard);
}
public final static String CHEF_URL_PROPERTY = "chefURL";
private final static boolean CHEF_URL_REQUIRED = false;
public final static int CHEF_URL_LENGTH_MIN = 1;
public final static int CHEF_URL_LENGTH_MAX = 255;
private final static boolean CHEF_URL_LEADING_OR_TRAILING_WHITESPACES_ALLOWED = false;
private final static String CHEF_URL_COLUMN = "chef_url";
@Column(name = CHEF_URL_COLUMN, nullable = !CHEF_URL_REQUIRED, length = CHEF_URL_LENGTH_MAX)
private String chefURL;
@Required(value = CHEF_URL_REQUIRED)
@Length(min = CHEF_URL_LENGTH_MIN, max = CHEF_URL_LENGTH_MAX)
@LeadingOrTrailingWhitespace(allowed = CHEF_URL_LEADING_OR_TRAILING_WHITESPACES_ALLOWED)
@URL
public String getChefURL()
{
return chefURL;
}
public void setChefURL(final String chefURL)
{
this.chefURL = chefURL;
}
public final static String CHEF_VALIDATOR_PROPERTY = "chefValidator";
private final static boolean CHEF_VALIDATOR_REQUIRED = false;
/* package */final static int CHEF_VALIDATOR_LENGTH_MIN = 1;
/* package */final static int CHEF_VALIDATOR_LENGTH_MAX = 50;
private final static boolean CHEF_VALIDATOR_LEADING_OR_TRAILING_WHITESPACES_ALLOWED = false;
private final static String CHEF_VALIDATOR_COLUMN = "chef_validator";
@Column(name = CHEF_VALIDATOR_COLUMN, nullable = !CHEF_VALIDATOR_REQUIRED, length = CHEF_VALIDATOR_LENGTH_MAX)
private String chefValidator;
@Required(value = CHEF_VALIDATOR_REQUIRED)
@Length(min = CHEF_VALIDATOR_LENGTH_MIN, max = CHEF_VALIDATOR_LENGTH_MAX)
@LeadingOrTrailingWhitespace(allowed = CHEF_VALIDATOR_LEADING_OR_TRAILING_WHITESPACES_ALLOWED)
public String getChefValidator()
{
return this.chefValidator;
}
public void setChefValidator(final String chefValidator)
{
this.chefValidator = chefValidator;
}
public final static String CHEF_CLIENT_PROPERTY = "chefClient";
private final static boolean CHEF_CLIENT_REQUIRED = false;
/* package */final static int CHEF_CLIENT_LENGTH_MIN = 1;
/* package */final static int CHEF_CLIENT_LENGTH_MAX = 50;
private final static boolean CHEF_CLIENT_LEADING_OR_TRAILING_WHITESPACES_ALLOWED = false;
private final static String CHEF_CLIENT_COLUMN = "chef_client";
@Column(name = CHEF_CLIENT_COLUMN, nullable = !CHEF_CLIENT_REQUIRED, length = CHEF_CLIENT_LENGTH_MAX)
private String chefClient;
@Required(value = CHEF_CLIENT_REQUIRED)
@Length(min = CHEF_CLIENT_LENGTH_MIN, max = CHEF_CLIENT_LENGTH_MAX)
@LeadingOrTrailingWhitespace(allowed = CHEF_CLIENT_LEADING_OR_TRAILING_WHITESPACES_ALLOWED)
public String getChefClient()
{
return this.chefClient;
}
public void setChefClient(final String chefClient)
{
this.chefClient = chefClient;
}
public final static String CHEF_CLIENT_CERT_PROPERTY = "chefClientCertificate";
private final static boolean CHEF_CLIENT_CERT_REQUIRED = false;
private final static boolean CHEF_CLIENT_CERT_LEADING_OR_TRAILING_WHITESPACES_ALLOWED = false;
private final static String CHEF_CLIENT_CERT_COLUMN = "chef_client_certificate";
@Column(name = CHEF_CLIENT_CERT_COLUMN, nullable = !CHEF_CLIENT_CERT_REQUIRED, columnDefinition = "TEXT")
private String chefClientCertificate;
@Required(value = CHEF_CLIENT_CERT_REQUIRED)
@LeadingOrTrailingWhitespace(allowed = CHEF_CLIENT_CERT_LEADING_OR_TRAILING_WHITESPACES_ALLOWED)
public String getChefClientCertificate()
{
return chefClientCertificate;
}
public void setChefClientCertificate(final String chefClientCertificate)
{
this.chefClientCertificate = chefClientCertificate.trim();
}
public final static String CHEF_VALIDATOR_CERT_PROPERTY = "chefValidatorCertificate";
private final static boolean CHEF_VALIDATOR_CERT_REQUIRED = false;
private final static boolean CHEF_VALIDATOR_CERT_LEADING_OR_TRAILING_WHITESPACES_ALLOWED =
false;
private final static String CHEF_VALIDATOR_CERT_COLUMN = "chef_validator_certificate";
@Column(name = CHEF_VALIDATOR_CERT_COLUMN, nullable = !CHEF_VALIDATOR_CERT_REQUIRED, columnDefinition = "TEXT")
private String chefValidatorCertificate;
@Required(value = CHEF_VALIDATOR_CERT_REQUIRED)
@LeadingOrTrailingWhitespace(allowed = CHEF_VALIDATOR_CERT_LEADING_OR_TRAILING_WHITESPACES_ALLOWED)
public String getChefValidatorCertificate()
{
return chefValidatorCertificate;
}
public void setChefValidatorCertificate(final String chefValidatorCertificate)
{
this.chefValidatorCertificate = chefValidatorCertificate.trim();
}
public final static String PRICING_PROPERTY = "pricingTemplate";
private final static boolean PRICING_REQUIRED = false;
private final static String PRICING_ID_COLUMN = "idPricingTemplate";
@JoinColumn(name = PRICING_ID_COLUMN)
@ManyToOne(fetch = FetchType.LAZY)
@ForeignKey(name = "enterprise_pricingTemp_fk")
private PricingTemplate pricingTemplate;
@Required(value = PRICING_REQUIRED)
public PricingTemplate getPricingTemplate()
{
return pricingTemplate;
}
public void setPricingTemplate(final PricingTemplate pricingTemplate)
{
this.pricingTemplate = pricingTemplate;
}
public final static String THEME_PROPERTY = "enterpriseTheme";
public final static String THEME_TABLE = "enterprise_theme";
private final static boolean THEME_REQUIRED = false;
@OneToOne(fetch = FetchType.LAZY, cascade = CascadeType.ALL, optional = !THEME_REQUIRED)
@PrimaryKeyJoinColumn
private EnterpriseTheme theme;
@Required(value = THEME_REQUIRED)
public EnterpriseTheme getEnterpriseTheme()
{
return theme;
}
public void setEnterpriseTheme(final EnterpriseTheme theme)
{
theme.setId(getId());
this.theme = theme;
}
// *************************** Mandatory constructors ***********************
public Enterprise(final String name, final int ramSoftLimitInMb, final int cpuCountSoftLimit,
final long hdSoftLimitInMb, final int ramHardLimitInMb, final int cpuCountHardLimit,
final long hdHardLimitInMb)
{
setName(name);
setIsReservationRestricted(Boolean.FALSE);
setRamLimitsInMb(new Limit((long) ramSoftLimitInMb, (long) ramHardLimitInMb));
setHdLimitsInMb(new Limit(hdSoftLimitInMb, hdHardLimitInMb));
setCpuCountLimits(new Limit((long) cpuCountSoftLimit, (long) cpuCountHardLimit));
}
/**
* This constructor is meant to be used only to retrieve from db this dto:
* vnd.abiquo.enterprise-id-name.xml
*
* @param id Identifier in DB.
* @param name Name.
*/
public Enterprise(final Integer id, final String name)
{
this.id = id;
this.name = name;
}
// ********************************** Others ********************************
public boolean isChefEnabled()
{
return getChefURL() != null && getChefClient() != null
&& getChefClientCertificate() != null && getChefValidator() != null
&& getChefValidatorCertificate() != null;
}
@Override
public String toString()
{
return ToStringBuilder.reflectionToString(this, ToStringStyle.MULTI_LINE_STYLE);
}
// I don't want to access the users directly but I want to remove them in cascade
@OneToMany(cascade = CascadeType.ALL, fetch = FetchType.LAZY, orphanRemoval = true, mappedBy = "enterprise")
private final List<User> users = new ArrayList<User>();
@OneToMany(cascade = CascadeType.ALL, fetch = FetchType.LAZY, orphanRemoval = true, mappedBy = "enterprise")
private final List<DatacenterLimits> datacenterLimits = new ArrayList<DatacenterLimits>();
@OneToMany(cascade = CascadeType.ALL, fetch = FetchType.LAZY, orphanRemoval = true, mappedBy = "enterprise")
private final List<VirtualMachineTemplate> virtualImages =
new ArrayList<VirtualMachineTemplate>();
@OneToMany(cascade = CascadeType.ALL, fetch = FetchType.LAZY, orphanRemoval = true, mappedBy = "enterprise")
private final List<AppsLibrary> appsLibraries = new ArrayList<AppsLibrary>();
public User createUser(final Role role, final String name, final String surname,
final String email, final String nick, final String password, final String locale)
{
return new User(this, role, name, surname, email, nick, password, locale);
}
}