Merge pull request #688 from overture-stack/feature/visaPermissions

committing changes related to Visa permissions schema

Author: Azher2Ali

src/main/java/bio/overture/ego/controller/VisaController.java

@@ -44,6 +44,11 @@ public VisaController(
     this.applicationPermissionService = applicationPermissionService;
   }
 
+  /*
+   * This method is used to fetch visa using id
+   * @param id UUID
+   * @return visa Visa
+   */
   @AdminScoped
   @RequestMapping(method = GET, value = "/{id}")
   @ApiResponses(

src/main/java/bio/overture/ego/model/entity/Visa.java

@@ -1,12 +1,16 @@
 package bio.overture.ego.model.entity;
 
+import static com.google.common.collect.Sets.newHashSet;
+
 import bio.overture.ego.model.enums.JavaFields;
 import bio.overture.ego.model.enums.SqlFields;
 import bio.overture.ego.model.enums.Tables;
 import bio.overture.ego.view.Views;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.annotation.JsonView;
+import java.util.Set;
 import java.util.UUID;
 import javax.persistence.*;
 import javax.validation.constraints.NotNull;
@@ -58,4 +62,9 @@ public class Visa implements Identifiable<UUID> {
   @JsonView({Views.JWTAccessToken.class, Views.REST.class})
   @Column(name = SqlFields.BY)
   private String by;
+
+  @JsonIgnore
+  @ManyToMany(mappedBy = "visaId", cascade = CascadeType.ALL, fetch = FetchType.LAZY)
+  @Builder.Default
+  private Set<VisaPermission> visaPermissions = newHashSet();
 }

src/main/java/bio/overture/ego/model/entity/VisaPermission.java

@@ -0,0 +1,62 @@
+package bio.overture.ego.model.entity;
+
+import static bio.overture.ego.model.enums.AccessLevel.EGO_ACCESS_LEVEL_ENUM;
+
+import bio.overture.ego.model.enums.AccessLevel;
+import bio.overture.ego.model.enums.SqlFields;
+import bio.overture.ego.model.enums.Tables;
+import bio.overture.ego.view.Views;
+import com.fasterxml.jackson.annotation.JsonView;
+import java.util.Collection;
+import java.util.UUID;
+import javax.persistence.*;
+import javax.validation.constraints.NotNull;
+import lombok.*;
+import lombok.experimental.FieldNameConstants;
+import org.hibernate.annotations.GenericGenerator;
+import org.hibernate.annotations.Type;
+
+@Entity
+@Table(name = Tables.ACLVISAPERMISSION)
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@JsonView(Views.REST.class)
+@ToString(callSuper = true)
+@FieldNameConstants
+public class VisaPermission extends AbstractPermission<Visa> {
+
+  @Id
+  @Column(name = SqlFields.ID, updatable = false, nullable = false)
+  @GenericGenerator(name = "aclp_uuid", strategy = "org.hibernate.id.UUIDGenerator")
+  @GeneratedValue(generator = "aclp_uuid")
+  private UUID id;
+
+  @JoinColumn(name = SqlFields.ID, nullable = false)
+  private UUID entity;
+
+  @JoinColumn(name = SqlFields.ID, nullable = false)
+  private UUID visaId;
+
+  @NotNull
+  @Column(name = SqlFields.MASK, nullable = false)
+  @Enumerated(EnumType.STRING)
+  @Type(type = EGO_ACCESS_LEVEL_ENUM)
+  private AccessLevel mask;
+
+  @ManyToMany
+  @JoinTable(
+      name = "ga4ghvisa",
+      joinColumns = @JoinColumn(name = "aclp_id", referencedColumnName = "visaId"),
+      inverseJoinColumns = @JoinColumn(name = "visa_id", referencedColumnName = "id"))
+  private Collection<Visa> visas;
+
+  @Override
+  public Visa getOwner() {
+    return null;
+  }
+
+  @Override
+  public void setOwner(Visa owner) {}
+}

src/main/java/bio/overture/ego/model/enums/JavaFields.java

@@ -71,4 +71,6 @@ public class JavaFields {
   public static final String VALUE = "value";
 
   public static final String BY = "by";
+
+  public static final String VISAPERMISSION = "ACLVISAPERMISSION";
 }

src/main/java/bio/overture/ego/model/enums/SqlFields.java

@@ -42,4 +42,10 @@ public class SqlFields {
   public static final String VALUE = "value";
 
   public static final String BY = "by";
+
+  public static final String ENTITY = "entity";
+
+  public static final String VISAID = "visaId";
+
+  public static final String MASK = "mask";
 }

src/main/java/bio/overture/ego/model/enums/Tables.java

@@ -24,4 +24,6 @@ public class Tables {
   public static final String INITTRIPWIRE = "inittripwire";
 
   public static final String GA4GHVISA = "ga4ghvisa";
+
+  public static final String ACLVISAPERMISSION = "ACLVISAPERMISSION";
 }

src/main/java/bio/overture/ego/service/VisaPermissionService.java

@@ -0,0 +1,16 @@
+package bio.overture.ego.service;
+
+import bio.overture.ego.model.entity.*;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@Slf4j
+@Service
+@Transactional
+public class VisaPermissionService {
+
+  /** Dependencies */
+  @Autowired private VisaService visaService;
+}

src/main/java/bio/overture/ego/service/VisaService.java

@@ -65,11 +65,6 @@ public void delete(@NonNull UUID id) {
     super.delete(id);
   }
 
-  @Override
-  public Visa getWithRelationships(UUID uuid) {
-    return null;
-  }
-
   public Page<Visa> listVisa(@NonNull Pageable pageable) {
     return visaRepository.findAll(pageable);
   }
@@ -88,4 +83,9 @@ public abstract static class VisaConverter {
 
     public abstract void updateVisa(VisaRequest request, @MappingTarget Visa visaToUpdate);
   }
+
+  @Override
+  public Visa getWithRelationships(UUID uuid) {
+    return null;
+  }
 }

src/main/resources/flyway/sql/V1_23__add_visa_pcl.sql

@@ -0,0 +1,8 @@
+CREATE TABLE ACLVISAPERMISSION (
+  id                      UUID PRIMARY KEY,
+  entity                  UUID,
+  visaId                  UUID,
+  mask                    ACLMASK NOT NULL,
+  FOREIGN KEY (entity)    REFERENCES POLICY(id),
+  FOREIGN KEY (visaId)    REFERENCES GA4GHVISA(id)
+);