[api, frontend] Endpoints modelization (#268)

openex-model/pom.xml

@@ -13,6 +13,11 @@
     <name>OpenEx model</name>
     <description>OpenEx model</description>
 
+    <properties>
+        <commons-validator.version>1.7</commons-validator.version>
+        <lombok.version>1.18.26</lombok.version>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>org.springframework.boot</groupId>
@@ -76,5 +81,16 @@
             <artifactId>validation-api</artifactId>
             <version>2.0.1.Final</version>
         </dependency>
+        <dependency>
+            <groupId>commons-validator</groupId>
+            <artifactId>commons-validator</artifactId>
+            <version>${commons-validator.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>${lombok.version}</version>
+            <scope>provided</scope>
+        </dependency>
     </dependencies>
 </project>

openex-model/src/main/java/io/openex/annotation/Ipv4OrIpv6Constraint.java

@@ -0,0 +1,24 @@
+package io.openex.annotation;
+
+import io.openex.validator.Ipv4OrIpv6Validator;
+
+import javax.validation.Constraint;
+import javax.validation.Payload;
+import javax.validation.ReportAsSingleViolation;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+@Target(FIELD)
+@Retention(RUNTIME)
+@Constraint(validatedBy = Ipv4OrIpv6Validator.class)
+@ReportAsSingleViolation
+public @interface Ipv4OrIpv6Constraint {
+    String message() default "must be ipv4 or ipv6";
+
+    Class<?>[] groups() default {};
+
+    Class<? extends Payload>[] payload() default {};
+}

openex-model/src/main/java/io/openex/database/audit/ModelBaseListener.java

@@ -45,6 +45,7 @@ void postUpdate(Object base) {
     @PreRemove
     void preRemove(Object base) {
         Base instance = (Base) base;
-        appPublisher.publishEvent(new BaseEvent(DATA_DELETE, instance, mapper));
+        BaseEvent event = new BaseEvent(DATA_DELETE, instance, mapper);
+        appPublisher.publishEvent(event);
     }
 }

openex-model/src/main/java/io/openex/database/model/System.java

@@ -0,0 +1,78 @@
+package io.openex.database.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import io.openex.annotation.Ipv4OrIpv6Constraint;
+import io.openex.database.audit.ModelBaseListener;
+import io.openex.helper.MultiIdDeserializer;
+import lombok.Getter;
+import lombok.Setter;
+import org.hibernate.annotations.GenericGenerator;
+
+import javax.persistence.*;
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
+
+import static java.time.Instant.now;
+
+@Getter
+@Setter
+@Entity
+@Table(name = "systems")
+@EntityListeners(ModelBaseListener.class)
+public class System implements Base {
+
+    public enum SYSTEM_TYPE {
+        ENDPOINT,
+        WEBSITE,
+    }
+
+    public enum OS_TYPE {
+        LINUX,
+        WINDOWS,
+    }
+
+    @Id
+    @Column(name = "system_id")
+    @GeneratedValue(generator = "UUID")
+    @GenericGenerator(name = "UUID", strategy = "org.hibernate.id.UUIDGenerator")
+    @JsonProperty("system_id")
+    private String id;
+
+    @Column(name = "system_created_at")
+    @JsonProperty("system_created_at")
+    private Instant createdAt = now();
+
+    @Column(name = "system_updated_at")
+    @JsonProperty("system_updated_at")
+    private Instant updatedAt = now();
+
+    @Column(name = "system_name")
+    @JsonProperty("system_name")
+    private String name;
+
+    @Column(name = "system_type")
+    @JsonProperty("system_type")
+    @Enumerated(EnumType.STRING)
+    private SYSTEM_TYPE type;
+
+    @Ipv4OrIpv6Constraint
+    @Column(name = "system_ip")
+    @JsonProperty("system_ip")
+    private String ip;
+
+    @Column(name = "system_hostname")
+    @JsonProperty("system_hostname")
+    private String hostname;
+
+    @Column(name = "system_os")
+    @JsonProperty("system_os")
+    @Enumerated(EnumType.STRING)
+    private OS_TYPE os;
+
+    @ManyToMany(mappedBy = "systems", fetch = FetchType.LAZY)
+    @JsonSerialize(using = MultiIdDeserializer.class)
+    @JsonProperty("system_zones")
+    private List<Zone> zones = new ArrayList<>();
+}

openex-model/src/main/java/io/openex/database/model/User.java

@@ -181,7 +181,8 @@ public boolean isPlanner() {
     @JsonProperty("user_is_observer")
     public boolean isObserver() {
         return isAdmin() || getGroups().stream()
-                .mapToLong(group -> group.getGrants().size()).sum() > 0;
+                .flatMap(group -> group.getGrants().stream())
+                .anyMatch(grant -> Grant.GRANT_TYPE.OBSERVER.equals(grant.getName()));
     }
 
     @JsonProperty("user_is_manager")

openex-model/src/main/java/io/openex/database/model/Zone.java

@@ -0,0 +1,56 @@
+package io.openex.database.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import io.openex.annotation.Ipv4OrIpv6Constraint;
+import io.openex.database.audit.ModelBaseListener;
+import io.openex.helper.MultiIdDeserializer;
+import lombok.Getter;
+import lombok.Setter;
+import org.hibernate.annotations.GenericGenerator;
+
+import javax.persistence.*;
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
+
+import static java.time.Instant.now;
+
+@Getter
+@Setter
+@Entity
+@Table(name = "zones")
+@EntityListeners(ModelBaseListener.class)
+public class Zone implements Base {
+
+    @Id
+    @Column(name = "zone_id")
+    @GeneratedValue(generator = "UUID")
+    @GenericGenerator(name = "UUID", strategy = "org.hibernate.id.UUIDGenerator")
+    @JsonProperty("zone_id")
+    private String id;
+
+    @Column(name = "zone_name")
+    @JsonProperty("zone_name")
+    private String name;
+
+    @Column(name = "zone_description")
+    @JsonProperty("zone_description")
+    private String description;
+
+    @Column(name = "zone_created_at")
+    @JsonProperty("zone_created_at")
+    private Instant createdAt = now();
+
+    @Column(name = "zone_updated_at")
+    @JsonProperty("zone_updated_at")
+    private Instant updatedAt = now();
+
+    @ManyToMany(fetch = FetchType.LAZY)
+    @JoinTable(name = "systems_zones",
+            joinColumns = @JoinColumn(name = "zone_id"),
+            inverseJoinColumns = @JoinColumn(name = "system_id"))
+    @JsonSerialize(using = MultiIdDeserializer.class)
+    @JsonProperty("zone_systems")
+    private List<System> systems = new ArrayList<>();
+}

openex-model/src/main/java/io/openex/database/repository/SystemRepository.java

@@ -0,0 +1,8 @@
+package io.openex.database.repository;
+
+import io.openex.database.model.System;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface SystemRepository extends CrudRepository<System, String>  { }

openex-model/src/main/java/io/openex/database/repository/ZoneRepository.java

@@ -0,0 +1,8 @@
+package io.openex.database.repository;
+
+import io.openex.database.model.Zone;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface ZoneRepository extends CrudRepository<Zone, String>  { }

openex-model/src/main/java/io/openex/validator/Ipv4OrIpv6Validator.java

@@ -0,0 +1,21 @@
+package io.openex.validator;
+
+import io.openex.annotation.Ipv4OrIpv6Constraint;
+import org.apache.commons.validator.routines.InetAddressValidator;
+
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+
+public class Ipv4OrIpv6Validator implements ConstraintValidator<Ipv4OrIpv6Constraint, String> {
+
+    @Override
+    public void initialize(Ipv4OrIpv6Constraint ip) {
+    }
+
+    @Override
+    public boolean isValid(String ip, ConstraintValidatorContext cxt) {
+        InetAddressValidator validator = InetAddressValidator.getInstance();
+        return validator.isValid(ip);
+    }
+
+}