/*
* LinShare is an open source filesharing software, part of the LinPKI software
* suite, developed by Linagora.
*
* Copyright (C) 2015 LINAGORA
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version, provided you comply with the Additional Terms applicable for
* LinShare software by Linagora pursuant to Section 7 of the GNU Affero General
* Public License, subsections (b), (c), and (e), pursuant to which you must
* notably (i) retain the display of the “LinShare™” trademark/logo at the top
* of the interface window, the display of the “You are using the Open Source
* and free version of LinShare™, powered by Linagora © 2009–2015. Contribute to
* Linshare R&D by subscribing to an Enterprise offer!” infobox and in the
* e-mails sent with the Program, (ii) retain all hypertext links between
* LinShare and linshare.org, between linagora.com and Linagora, and (iii)
* refrain from infringing Linagora intellectual property rights over its
* trademarks and commercial brands. Other Additional Terms apply, see
* <http://www.linagora.com/licenses/> for more details.
*
* 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 Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License and
* its applicable Additional Terms for LinShare along with this program. If not,
* see <http://www.gnu.org/licenses/> for the GNU Affero General Public License
* version 3 and <http://www.linagora.com/licenses/> for the Additional Terms
* applicable to LinShare software.
*/
package org.linagora.linshare.core.domain.entities;
import java.util.HashSet;
import java.util.Set;
import org.linagora.linshare.core.domain.constants.FunctionalityNames;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public abstract class AbstractFunctionality implements Cloneable {
/**
* Database persistence identifier
*/
protected long id;
/**
* An unique string code designed to identify a Functionality. This code should represent the Functionality.
* Ex : QUOTA_USER for the user quota Functionality.
*/
protected String identifier;
/**
* configure if the Functionality is system or not, if it should be used by the UI
*/
protected boolean system;
protected Policy activationPolicy;
protected Policy configurationPolicy;
protected Policy delegationPolicy;
protected AbstractDomain domain;
/**
* This member is not persisted into the database.
* It is only used to compute update right.
*/
protected Boolean displayable = null;
protected Boolean parentAllowParametersUpdate = null;
protected Set<AbstractFunctionality> children = new HashSet<AbstractFunctionality>();
/**
* Logger available to subclasses.
*/
protected final Logger logger = LoggerFactory.getLogger(Functionality.class);
public AbstractFunctionality() {
super();
}
public AbstractFunctionality(String identifier, boolean system,
Policy activationPolicy, Policy configurationPolicy,
AbstractDomain domain) {
super();
this.identifier = identifier;
this.system = system;
this.activationPolicy = activationPolicy;
this.configurationPolicy = configurationPolicy;
this.domain = domain;
}
public AbstractFunctionality(String identifier, boolean system,
Policy activationPolicy, Policy configurationPolicy, Policy delegationPolicy,
AbstractDomain domain) {
super();
this.identifier = identifier;
this.system = system;
this.activationPolicy = activationPolicy;
this.configurationPolicy = configurationPolicy;
this.delegationPolicy = delegationPolicy;
this.domain = domain;
}
public long getId() {
return id;
}
public void setId(long id) {
this.id = id;
}
public String getIdentifier() {
return identifier;
}
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
public boolean isSystem() {
return system;
}
public void setSystem(boolean system) {
this.system = system;
}
public Policy getActivationPolicy() {
return activationPolicy;
}
public void setActivationPolicy(Policy activationPolicy) {
this.activationPolicy = activationPolicy;
}
public Policy getDelegationPolicy() {
return delegationPolicy;
}
public void setDelegationPolicy(Policy delegationPolicy) {
this.delegationPolicy = delegationPolicy;
}
public Policy getConfigurationPolicy() {
return configurationPolicy;
}
public void setConfigurationPolicy(Policy configurationPolicy) {
this.configurationPolicy = configurationPolicy;
}
public AbstractDomain getDomain() {
return domain;
}
public void setDomain(AbstractDomain domain) {
this.domain = domain;
}
public Boolean getDisplayable() {
return displayable;
}
public Boolean isDisplayable() {
return displayable;
}
public void setDisplayable(Boolean displayable) {
this.displayable = displayable;
}
public Boolean getParentAllowParametersUpdate() {
return parentAllowParametersUpdate;
}
public void setParentAllowParametersUpdate(Boolean parentAllowParametersUpdate) {
this.parentAllowParametersUpdate = parentAllowParametersUpdate;
}
public Set<AbstractFunctionality> getChildren() {
return children;
}
public void setChildren(Set<AbstractFunctionality> children) {
this.children = children;
}
public void addChild(AbstractFunctionality child) {
this.children.add(child);
}
public boolean businessEquals(AbstractFunctionality fonc, boolean checkPolicies) {
if(identifier.equals(fonc.getIdentifier())) {
if(system == fonc.isSystem()) {
if(checkPolicies) {
if(configurationPolicy.businessEquals(fonc.getConfigurationPolicy())) {
if(activationPolicy.businessEquals(fonc.getActivationPolicy())) {
if (delegationPolicy != null) {
if(delegationPolicy.businessEquals(fonc.getDelegationPolicy())) {
logger.debug("Functionality : " + this.toString() + " is equal to Functionality " + fonc.toString());
return true;
}
} else {
logger.debug("Functionality : " + this.toString() + " is equal to Functionality " + fonc.toString());
return true;
}
}
}
} else {
logger.debug("Functionality : " + this.toString() + " is equal to Functionality " + fonc.toString());
return true;
}
}
}
logger.debug("Functionality : " + this.toString() + " is not equal to Functionality " + fonc.toString());
return false;
}
public Object clone() {
// Every properties are clones, except domain.
AbstractFunctionality func = null;
try {
func = (AbstractFunctionality) super.clone();
} catch (CloneNotSupportedException cnse) {
cnse.printStackTrace(System.err);
}
func.activationPolicy = (Policy) activationPolicy.clone();
func.configurationPolicy = (Policy) configurationPolicy.clone();
if (delegationPolicy != null) {
func.delegationPolicy = (Policy) delegationPolicy.clone();
}
func.id = 0;
return func;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result
+ ((identifier == null) ? 0 : identifier.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
Functionality other = (Functionality) obj;
if (identifier == null) {
if (other.identifier != null)
return false;
} else if (!identifier.equals(other.identifier))
return false;
return true;
}
public boolean equalsIdentifier(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
AbstractFunctionality other = (AbstractFunctionality) obj;
if (!this.identifier.equals(other.identifier))
return false;
return true;
}
public boolean equalsIdentifier(FunctionalityNames name) {
return identifier.equals(name.toString());
}
public void updateFunctionalityFrom(AbstractFunctionality functionality) {
this.activationPolicy.updatePolicyFrom(functionality.getActivationPolicy());
this.configurationPolicy.updatePolicyFrom(functionality.getConfigurationPolicy());
if (this.delegationPolicy!= null) {
this.delegationPolicy.updatePolicyFrom(functionality.getDelegationPolicy());
}
}
public void updateFunctionalityValuesOnlyFrom(AbstractFunctionality functionality) {
// no data in this class.
}
public boolean hasSomeParam() {
return false;
}
}