eu.clarussecure.datamodel.Policy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of CLARUS-DataModel Show documentation
Model of the security policy for CLARUS
The newest version!
package eu.clarussecure.datamodel;

import eu.clarussecure.datamodel.types.Usage;
import java.io.Serializable;

import java.util.Set;
import java.util.HashSet;
import java.util.stream.Stream;
import org.jdom2.Element;

public class Policy implements Serializable {

    // The name of the fields MUST match the keys of the Json
    private int policyId;
    private String policyName;
    private Usage dataUsage;
    private Endpoint endpoint;
    private Protection protection;
    private Set attributes;

    private boolean published;

    public Policy() {
        this.policyId = 0;
        this.policyName = "";
        this.dataUsage = Usage.COMPUTE;
        this.endpoint = new Endpoint();
        this.protection = new Protection();
        this.attributes = new HashSet<>();
    }

    public Policy(int id, String name) { // The commented fields might pose some problems
        this.policyId = id;
        this.policyName = name;
    }

    public int getPolicyId() {
        return this.policyId;
    }

    public void setPolicyId(int policyId) {
        this.policyId = policyId;
    }

    public String getPolicyName() {
        return this.policyName;
    }

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

    public Usage getDataUsage() {
        return this.dataUsage;
    }

    public void setDataUsage(Usage us) {
        this.dataUsage = us;
    }

    public Endpoint getEndpoint() {
        return this.endpoint;
    }

    public void setEndpoint(Endpoint e) {
        this.endpoint = e;
    }

    public Protection getProtection() {
        return this.protection;
    }

    public void setProtection(Protection p) {
        this.protection = p;
    }

    public Set getAttributes() {
        return this.attributes;
    }

    public void setAttributes(Set attributes) {
        this.attributes = attributes;
    }

    public void addAttribute(PolicyAttribute pa) {
        this.getAttributes().add(pa);
    }

    public void deleteAttribute(PolicyAttribute pa) {
        this.getAttributes().remove(pa);
    }

    @Override
    public String toString() {
        String s = "Policy: ID: " + this.getPolicyId() + ", name: " + this.getPolicyName() + ", " + this.getEndpoint()
                + ", " + this.getProtection();
        return s;
    }

    public boolean checkPolicyIntegrity() {
        // This method should check if the policy is completely specified or not.
        // An incomplete policy SHOULD NOT be capable of deploying it
        boolean valid = true;

        // A policy must have an Endpoint
        valid = valid && this.getEndpoint().isValid();

        // A policy must have a Usage
        valid = valid && (this.getDataUsage() != null);

        // A policy must have an protection module
        valid = valid && (this.getProtection().isValid());

        return valid;
    }

    public boolean isPublished() {
        return this.published;
    }

    public void setPublished(boolean published) {
        this.published = published;
    }

    public Element getXMLElement() {
        // Create the Element
        Element elem = new Element("schema");

        // Get the Attribute Names elements
        Stream attribs = this.attributes.stream().map(attrib -> {
            return attrib.getXMLElement();
        });

        // Attach the Attribute Names
        Element elem2 = new Element("data");
        attribs.forEach(e -> elem2.addContent(e));
        elem.addContent(elem2);

        // Attach the Protection Module
        elem.addContent(this.protection.getXMLElement());

        // Attach the Protocol tag
        Element elem3 = new Element("protocol");
        elem3.setAttribute("plugin", this.endpoint.getProtocol().getProtocolName());
        elem.addContent(elem3);

        return elem;
    }
}