ARC-1700: Spicegen: Add permission factory methods

api/src/main/java/com/oviva/spicegen/api/CheckPermission.java

@@ -0,0 +1,92 @@
+package com.oviva.spicegen.api;
+
+import java.util.Objects;
+
+public final class CheckPermission {
+
+  private final ObjectRef resource;
+  private final String permission;
+  private final SubjectRef subject;
+
+  private final Consistency consistency;
+
+  private CheckPermission(Builder builder) {
+    resource = builder.resource;
+    permission = builder.permission;
+    subject = builder.subject;
+    consistency = builder.consistency;
+  }
+
+  public static Builder newBuilder() {
+    return new Builder();
+  }
+
+  public ObjectRef resource() {
+    return resource;
+  }
+
+  public String permission() {
+    return permission;
+  }
+
+  public SubjectRef subject() {
+    return subject;
+  }
+
+  public Consistency consistency() {
+    return consistency;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    var that = (CheckPermission) o;
+    return Objects.equals(resource, that.resource)
+        && Objects.equals(permission, that.permission)
+        && Objects.equals(subject, that.subject)
+        && Objects.equals(consistency, that.consistency);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(resource, permission, subject, consistency);
+  }
+
+  public static final class Builder {
+    private ObjectRef resource;
+    private String permission;
+    private SubjectRef subject;
+    private Consistency consistency = Consistency.fullyConsistent();
+
+    private Builder() {}
+
+    public Builder resource(ObjectRef resource) {
+      this.resource = resource;
+      return this;
+    }
+
+    public Builder permission(String permission) {
+      this.permission = permission;
+      return this;
+    }
+
+    public Builder subject(SubjectRef subject) {
+      this.subject = subject;
+      return this;
+    }
+
+    public Builder consistency(Consistency consistency) {
+      this.consistency = consistency;
+      return this;
+    }
+
+    public CheckPermission build() {
+      return new CheckPermission(this);
+    }
+  }
+}

api/src/main/java/com/oviva/spicegen/api/Consistency.java

@@ -0,0 +1,58 @@
+package com.oviva.spicegen.api;
+
+import java.util.Objects;
+
+public final class Consistency {
+
+  private static Consistency FULLY_CONSISTENT = new Consistency(Requirement.FULLY_CONSISTENT, null);
+  private final Requirement requirement;
+
+  private final String consistencyToken;
+
+  private Consistency(Requirement requirement, String consistencyToken) {
+    this.requirement = requirement;
+    this.consistencyToken = consistencyToken;
+  }
+
+  public String consistencyToken() {
+    return consistencyToken;
+  }
+
+  public Requirement requirement() {
+    return requirement;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    var that = (Consistency) o;
+    return requirement == that.requirement
+        && Objects.equals(consistencyToken, that.consistencyToken);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(requirement, consistencyToken);
+  }
+
+  public static Consistency fullyConsistent() {
+    return FULLY_CONSISTENT;
+  }
+
+  public static Consistency atLeastAsFreshAs(String consistencyToken) {
+    if (consistencyToken == null) {
+      return FULLY_CONSISTENT;
+    }
+    return new Consistency(Requirement.AT_LEAST_AS_FRESH, consistencyToken);
+  }
+
+  public enum Requirement {
+    FULLY_CONSISTENT,
+    AT_LEAST_AS_FRESH
+  }
+}

api/src/main/java/com/oviva/spicegen/api/ObjectRef.java

@@ -1,11 +1,19 @@
 package com.oviva.spicegen.api;
 
+import java.util.Objects;
+
 public interface ObjectRef {
   String kind();
 
   String id();
 
   static ObjectRef of(String kind, String id) {
+    if (kind == null) {
+      throw new IllegalArgumentException("kind must  not be null");
+    }
+    if (id == null) {
+      throw new IllegalArgumentException("id must  not be null");
+    }
     return new ObjectRef() {
       @Override
       public String kind() {
@@ -16,6 +24,25 @@ public String kind() {
       public String id() {
         return id;
       }
+
+      @Override
+      public String toString() {
+        return "%s:%s".formatted(kind, id);
+      }
+
+      @Override
+      public int hashCode() {
+        return Objects.hash(kind, id);
+      }
+
+      @Override
+      public boolean equals(Object obj) {
+        if (!(obj instanceof ObjectRef ref)) {
+          return false;
+        }
+
+        return Objects.equals(this.kind(), ref.kind()) && Objects.equals(this.id(), ref.id());
+      }
     };
   }
 }

api/src/main/java/com/oviva/spicegen/api/PermissionService.java

@@ -12,4 +12,12 @@ public interface PermissionService {
    * @return the result, containing the consistencyToken
    */
   UpdateResult updateRelationships(UpdateRelationships updateRelationships);
+
+  /**
+   * Checks whether a subject has the given permission on a resource
+   *
+   * @param checkPermission the request
+   * @return true it the subject is permitted, false otherwise
+   */
+  boolean checkPermission(CheckPermission checkPermission);
 }

api/src/main/java/com/oviva/spicegen/api/Precondition.java

@@ -46,12 +46,12 @@ public static final class Builder {
 
     private Builder() {}
 
-    public Builder withCondition(Condition val) {
+    public Builder condition(Condition val) {
       condition = val;
       return this;
     }
 
-    public Builder withFilter(RelationshipFilter val) {
+    public Builder filter(RelationshipFilter val) {
       filter = val;
       return this;
     }

api/src/main/java/com/oviva/spicegen/api/RelationshipFilter.java

@@ -81,17 +81,17 @@ public static final class Builder {
 
       private Builder() {}
 
-      public Builder withSubjectKind(String val) {
+      public Builder subjectKind(String val) {
         subjectKind = val;
         return this;
       }
 
-      public Builder withSubjectId(String val) {
+      public Builder subjectId(String val) {
         subjectId = val;
         return this;
       }
 
-      public Builder withRelation(String val) {
+      public Builder relation(String val) {
         relation = val;
         return this;
       }
@@ -110,22 +110,22 @@ public static final class Builder {
 
     private Builder() {}
 
-    public Builder withResourceKind(String val) {
+    public Builder resourceKind(String val) {
       resourceKind = val;
       return this;
     }
 
-    public Builder withResourceId(String val) {
+    public Builder resourceId(String val) {
       resourceId = val;
       return this;
     }
 
-    public Builder withRelation(String val) {
+    public Builder relation(String val) {
       relation = val;
       return this;
     }
 
-    public Builder withSubjectFilter(SubjectFilter val) {
+    public Builder subjectFilter(SubjectFilter val) {
       subjectFilter = val;
       return this;
     }

api/src/main/java/com/oviva/spicegen/api/SubjectRef.java

@@ -1,5 +1,7 @@
 package com.oviva.spicegen.api;
 
+import java.util.Objects;
+
 public interface SubjectRef {
   String kind();
 
@@ -16,6 +18,28 @@ public String kind() {
       public String id() {
         return o.id();
       }
+
+      @Override
+      public int hashCode() {
+        return Objects.hash(o);
+      }
+
+      @Override
+      public boolean equals(Object obj) {
+        if (!(obj instanceof SubjectRef that)) {
+          return false;
+        }
+        return Objects.equals(this.kind(), that.kind()) && Objects.equals(this.id(), that.id());
+      }
+
+      @Override
+      public String toString() {
+        if (o == null) {
+          return "";
+        }
+
+        return o.toString();
+      }
     };
   }
 }

api/src/main/java/com/oviva/spicegen/api/UpdateRelationship.java

@@ -22,13 +22,13 @@ private UpdateRelationship(
   public static UpdateRelationship ofUpdate(
       ObjectRef resource, String relation, ObjectRef subject) {
     return new UpdateRelationship(
-        resource, relation, new ObjectRefSubject(subject), Operation.UPDATE);
+        resource, relation, SubjectRef.ofObject(subject), Operation.UPDATE);
   }
 
   public static UpdateRelationship ofDelete(
       ObjectRef resource, String relation, ObjectRef subject) {
     return new UpdateRelationship(
-        resource, relation, new ObjectRefSubject(subject), Operation.DELETE);
+        resource, relation, SubjectRef.ofObject(subject), Operation.DELETE);
   }
 
   public SubjectRef subject() {
@@ -80,22 +80,4 @@ public enum Operation {
 
     DELETE
   }
-
-  private static class ObjectRefSubject implements SubjectRef {
-    private final ObjectRef subject;
-
-    private ObjectRefSubject(ObjectRef subject) {
-      this.subject = subject;
-    }
-
-    @Override
-    public String kind() {
-      return subject.kind();
-    }
-
-    @Override
-    public String id() {
-      return subject.id();
-    }
-  }
 }