add support for neo4j embedded and package refactor (#177)

bump grpc related versions

add maven wrapper

move index creation to a static method in neo4j to be called outside of the PAP class

change OperandEntry value to a oneof

add named routine rpc

add dissociate op

update neo4j tx handler

move verification to store

make policyStore public for PAP

rename EPP interfaces

first pass at package refactor

package refactor

README.md

@@ -63,10 +63,10 @@ package gov.nist.csd.pm;
 import gov.nist.csd.pm.epp.EPP;
 import gov.nist.csd.pm.impl.memory.pap.MemoryPAP;
 import gov.nist.csd.pm.pap.PAP;
-import gov.nist.csd.pm.pap.exception.PMException;
-import gov.nist.csd.pm.pap.graph.relationship.AccessRightSet;
-import gov.nist.csd.pm.pap.prohibition.ContainerCondition;
-import gov.nist.csd.pm.pap.prohibition.ProhibitionSubject;
+import gov.nist.csd.pm.common.exception.PMException;
+import gov.nist.csd.pm.common.graph.relationship.AccessRightSet;
+import gov.nist.csd.pm.common.prohibition.ContainerCondition;
+import gov.nist.csd.pm.common.prohibition.ProhibitionSubject;
 import gov.nist.csd.pm.pap.query.model.context.UserContext;
 import gov.nist.csd.pm.pap.query.model.context.TargetContext;
 import gov.nist.csd.pm.pdp.PDP;

pom.xml

@@ -7,7 +7,7 @@
     <groupId>gov.nist.csd.pm</groupId>
     <artifactId>policy-machine-core</artifactId>
     <packaging>jar</packaging>
-    <version>3.0.0-alpha.1</version>
+    <version>3.0.0</version>
 
     <build>
         <extensions>
@@ -28,10 +28,10 @@
                     <outputDirectory>${project.build.directory}/generated-sources</outputDirectory>
                     <clearOutputDirectory>false</clearOutputDirectory>
                     <!-- Protobuf Compiler -->
-                    <protocArtifact>com.google.protobuf:protoc:3.24.3:exe:${os.detected.classifier}</protocArtifact>
+                    <protocArtifact>com.google.protobuf:protoc:3.25.5:exe:${os.detected.classifier}</protocArtifact>
                     <!-- gRPC Compiler -->
                     <pluginId>grpc-java</pluginId>
-                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.57.0:exe:${os.detected.classifier}</pluginArtifact>
+                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.61.1:exe:${os.detected.classifier}</pluginArtifact>
                 </configuration>
                 <executions>
                     <!-- Execution for Message Classes -->
@@ -190,6 +190,11 @@
             <artifactId>commons-lang3</artifactId>
             <version>3.13.0</version>
         </dependency>
+        <dependency>
+            <groupId>commons-codec</groupId>
+            <artifactId>commons-codec</artifactId>
+            <version>1.15</version>
+        </dependency>
         <dependency>
             <groupId>it.unimi.dsi</groupId>
             <artifactId>fastutil</artifactId>
@@ -204,19 +209,25 @@
         <dependency>
             <groupId>io.grpc</groupId>
             <artifactId>grpc-protobuf</artifactId>
-            <version>1.57.0</version>
+            <version>1.61.1</version>
         </dependency>
         <dependency>
             <groupId>io.grpc</groupId>
             <artifactId>grpc-stub</artifactId>
-            <version>1.57.0</version>
+            <version>1.61.1</version>
         </dependency>
         <dependency>
             <groupId>org.apache.tomcat</groupId>
             <artifactId>annotations-api</artifactId>
             <version>6.0.53</version>
             <scope>provided</scope>
         </dependency>
+
+        <dependency>
+            <groupId>org.neo4j</groupId>
+            <artifactId>neo4j</artifactId>
+            <version>5.25.1</version>
+        </dependency>
     </dependencies>
 
     <properties>

src/main/java/gov/nist/csd/pm/pap/obligation/EventContext.java → src/main/java/gov/nist/csd/pm/common/event/EventContext.java

@@ -1,8 +1,7 @@
-package gov.nist.csd.pm.pap.obligation;
+package gov.nist.csd.pm.common.event;
 
-import gov.nist.csd.pm.pap.op.Operation;
+import gov.nist.csd.pm.common.op.Operation;
 
-import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 

src/main/java/gov/nist/csd/pm/epp/EventEmitter.java → src/main/java/gov/nist/csd/pm/common/event/EventPublisher.java

@@ -1,30 +1,29 @@
-package gov.nist.csd.pm.epp;
+package gov.nist.csd.pm.common.event;
 
-import gov.nist.csd.pm.pap.exception.PMException;
-import gov.nist.csd.pm.pap.obligation.EventContext;
+import gov.nist.csd.pm.common.exception.PMException;
 
 /**
  * Interface for emitting events to be processed by an EPP.
  */
-public interface EventEmitter {
+public interface EventPublisher {
 
     /**
      * Add the given EventProcessor as a listener for policy events.
      * @param processor The processor to add as a listener.
      */
-    void addEventListener(EventProcessor processor);
+    void addEventSubscriber(EventSubscriber processor);
 
     /**
      * Remove the given EventProcessor as a listener.
      * @param processor The processor to remove.
      */
-    void removeEventListener(EventProcessor processor);
+    void removeEventSubscriber(EventSubscriber processor);
 
     /**
      * Emit the given event context to any EventProcessors listening.
      * @param event The EventContext to emit.
      * @throws PMException If there is an exception emitting the event.
      */
-    void emitEvent(EventContext event) throws PMException;
+    void publishEvent(EventContext event) throws PMException;
 
 }

src/main/java/gov/nist/csd/pm/common/event/EventSubscriber.java

@@ -0,0 +1,17 @@
+package gov.nist.csd.pm.common.event;
+
+import gov.nist.csd.pm.common.exception.PMException;
+
+/**
+ * Interface for processing EventContexts.
+ */
+public interface EventSubscriber {
+
+    /**
+     * Process the given EventContext.
+     * @param eventCtx The event context to process.
+     * @throws PMException If there is an error processing the EventContext.
+     */
+    void processEvent(EventContext eventCtx) throws PMException;
+
+}

src/main/java/gov/nist/csd/pm/pap/exception/AdminAccessRightExistsException.java → src/main/java/gov/nist/csd/pm/common/exception/AdminAccessRightExistsException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class AdminAccessRightExistsException extends PMException {
     public AdminAccessRightExistsException(String ar) {

src/main/java/gov/nist/csd/pm/pap/exception/AdminPolicyVerificationException.java → src/main/java/gov/nist/csd/pm/common/exception/AdminPolicyVerificationException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class AdminPolicyVerificationException extends PMException {
     public AdminPolicyVerificationException(PMException e) {

src/main/java/gov/nist/csd/pm/pap/exception/AssignmentCausesLoopException.java → src/main/java/gov/nist/csd/pm/common/exception/AssignmentCausesLoopException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class AssignmentCausesLoopException extends PMException {
 

src/main/java/gov/nist/csd/pm/pap/exception/BootstrapExistingPolicyException.java → src/main/java/gov/nist/csd/pm/common/exception/BootstrapExistingPolicyException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class BootstrapExistingPolicyException extends PMException {
     public BootstrapExistingPolicyException() {

src/main/java/gov/nist/csd/pm/pap/exception/CannotDeleteAdminPolicyConfigException.java → src/main/java/gov/nist/csd/pm/common/exception/CannotDeleteAdminPolicyConfigException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class CannotDeleteAdminPolicyConfigException extends PMException {
     public CannotDeleteAdminPolicyConfigException() {

src/main/java/gov/nist/csd/pm/pap/exception/DisconnectedNodeException.java → src/main/java/gov/nist/csd/pm/common/exception/DisconnectedNodeException.java

@@ -1,6 +1,6 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
-import gov.nist.csd.pm.pap.graph.node.NodeType;
+import gov.nist.csd.pm.common.graph.node.NodeType;
 
 public class DisconnectedNodeException extends PMException {
     public DisconnectedNodeException(String ascendant, String descendant) {

src/main/java/gov/nist/csd/pm/pap/exception/InvalidProhibitionSubjectException.java → src/main/java/gov/nist/csd/pm/common/exception/InvalidProhibitionSubjectException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class InvalidProhibitionSubjectException extends PMException {
     public InvalidProhibitionSubjectException(String type) {

src/main/java/gov/nist/csd/pm/pap/exception/NodeDoesNotExistException.java → src/main/java/gov/nist/csd/pm/common/exception/NodeDoesNotExistException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class NodeDoesNotExistException extends PMException {
     public NodeDoesNotExistException(String name) {

src/main/java/gov/nist/csd/pm/pap/exception/NodeHasAscendantsException.java → src/main/java/gov/nist/csd/pm/common/exception/NodeHasAscendantsException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class NodeHasAscendantsException extends PMException {
     public NodeHasAscendantsException(String node) {

src/main/java/gov/nist/csd/pm/pap/exception/NodeNameExistsException.java → src/main/java/gov/nist/csd/pm/common/exception/NodeNameExistsException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class NodeNameExistsException extends PMException {
     public NodeNameExistsException(String nodeName) {

src/main/java/gov/nist/csd/pm/pap/exception/NodeReferencedInObligationException.java → src/main/java/gov/nist/csd/pm/common/exception/NodeReferencedInObligationException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class NodeReferencedInObligationException extends PMException {
 

src/main/java/gov/nist/csd/pm/pap/exception/NodeReferencedInProhibitionException.java → src/main/java/gov/nist/csd/pm/common/exception/NodeReferencedInProhibitionException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class NodeReferencedInProhibitionException extends PMException {
     public NodeReferencedInProhibitionException(String nodeToDelete, String prohibitionName) {

src/main/java/gov/nist/csd/pm/pap/exception/NodesAlreadyAssignedException.java → src/main/java/gov/nist/csd/pm/common/exception/NodesAlreadyAssignedException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class NodesAlreadyAssignedException extends PMException {
     public NodesAlreadyAssignedException(String ua, String target) {

src/main/java/gov/nist/csd/pm/pap/exception/ObligationDoesNotExistException.java → src/main/java/gov/nist/csd/pm/common/exception/ObligationDoesNotExistException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class ObligationDoesNotExistException extends PMException {
     public ObligationDoesNotExistException(String name) {

src/main/java/gov/nist/csd/pm/pap/exception/ObligationNameExistsException.java → src/main/java/gov/nist/csd/pm/common/exception/ObligationNameExistsException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class ObligationNameExistsException extends PMException {
     public ObligationNameExistsException(String name) {

src/main/java/gov/nist/csd/pm/pap/exception/ObligationRuleNameExistsException.java → src/main/java/gov/nist/csd/pm/common/exception/ObligationRuleNameExistsException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class ObligationRuleNameExistsException extends PMException {
     public ObligationRuleNameExistsException(String obligationName, String ruleName) {

src/main/java/gov/nist/csd/pm/pap/exception/OperandsDoNotMatchException.java → src/main/java/gov/nist/csd/pm/common/exception/OperandsDoNotMatchException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 import java.util.Collection;
 

src/main/java/gov/nist/csd/pm/pap/exception/OperationDoesNotExistException.java → src/main/java/gov/nist/csd/pm/common/exception/OperationDoesNotExistException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class OperationDoesNotExistException extends PMException {
     public OperationDoesNotExistException(String op) {

src/main/java/gov/nist/csd/pm/pap/exception/OperationExistsException.java → src/main/java/gov/nist/csd/pm/common/exception/OperationExistsException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class OperationExistsException extends PMException {
     public OperationExistsException(String op) {

src/main/java/gov/nist/csd/pm/pap/exception/PMBackendException.java → src/main/java/gov/nist/csd/pm/common/exception/PMBackendException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 /**
  * Wrapper for backend related exceptions independent of backend implementation.

src/main/java/gov/nist/csd/pm/pap/exception/PMException.java → src/main/java/gov/nist/csd/pm/common/exception/PMException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 /**
  * Root exception to cover any possible error in the Policy Machine interfaces. This is to support multiple implementations

src/main/java/gov/nist/csd/pm/pap/exception/PMLConstantAlreadyDefinedException.java → src/main/java/gov/nist/csd/pm/common/exception/PMLConstantAlreadyDefinedException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class PMLConstantAlreadyDefinedException extends PMException {
     public PMLConstantAlreadyDefinedException(String name) {

src/main/java/gov/nist/csd/pm/pap/exception/PMLConstantNotDefinedException.java → src/main/java/gov/nist/csd/pm/common/exception/PMLConstantNotDefinedException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class PMLConstantNotDefinedException extends PMException {
     public PMLConstantNotDefinedException(String c) {

src/main/java/gov/nist/csd/pm/pap/exception/PMLFunctionAlreadyDefinedException.java → src/main/java/gov/nist/csd/pm/common/exception/PMLFunctionAlreadyDefinedException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class PMLFunctionAlreadyDefinedException extends PMException {
     public PMLFunctionAlreadyDefinedException(String functionName) {

src/main/java/gov/nist/csd/pm/pap/exception/PMLFunctionNotDefinedException.java → src/main/java/gov/nist/csd/pm/common/exception/PMLFunctionNotDefinedException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class PMLFunctionNotDefinedException extends PMException {
 

src/main/java/gov/nist/csd/pm/pap/exception/PMRuntimeException.java → src/main/java/gov/nist/csd/pm/common/exception/PMRuntimeException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class PMRuntimeException extends RuntimeException {
 

src/main/java/gov/nist/csd/pm/pap/exception/PolicyEntityDoesNotExistException.java → src/main/java/gov/nist/csd/pm/common/exception/PolicyEntityDoesNotExistException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class PolicyEntityDoesNotExistException extends PMException {
     public PolicyEntityDoesNotExistException(String msg) {

src/main/java/gov/nist/csd/pm/pap/exception/ProhibitionContainerDoesNotExistException.java → src/main/java/gov/nist/csd/pm/common/exception/ProhibitionContainerDoesNotExistException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class ProhibitionContainerDoesNotExistException extends PMException {
     public ProhibitionContainerDoesNotExistException(String name) {

src/main/java/gov/nist/csd/pm/pap/exception/ProhibitionDoesNotExistException.java → src/main/java/gov/nist/csd/pm/common/exception/ProhibitionDoesNotExistException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class ProhibitionDoesNotExistException extends PMException {
     public ProhibitionDoesNotExistException(String name) {

src/main/java/gov/nist/csd/pm/pap/exception/ProhibitionExistsException.java → src/main/java/gov/nist/csd/pm/common/exception/ProhibitionExistsException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class ProhibitionExistsException extends PMException {
     public ProhibitionExistsException(String name) {

src/main/java/gov/nist/csd/pm/pap/exception/ProhibitionSubjectDoesNotExistException.java → src/main/java/gov/nist/csd/pm/common/exception/ProhibitionSubjectDoesNotExistException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class ProhibitionSubjectDoesNotExistException extends PMException {
     public ProhibitionSubjectDoesNotExistException(String name) {

src/main/java/gov/nist/csd/pm/pap/exception/RepObjectNotSetException.java → src/main/java/gov/nist/csd/pm/common/exception/RepObjectNotSetException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class RepObjectNotSetException extends PMException {
 

src/main/java/gov/nist/csd/pm/pap/exception/RoutineDoesNotExistException.java → src/main/java/gov/nist/csd/pm/common/exception/RoutineDoesNotExistException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class RoutineDoesNotExistException extends PMException {
     public RoutineDoesNotExistException(String routine) {

src/main/java/gov/nist/csd/pm/pap/exception/RoutineExistsException.java → src/main/java/gov/nist/csd/pm/common/exception/RoutineExistsException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class RoutineExistsException extends PMException {
     public RoutineExistsException(String routine) {

src/main/java/gov/nist/csd/pm/pap/exception/UnknownAccessRightException.java → src/main/java/gov/nist/csd/pm/common/exception/UnknownAccessRightException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class UnknownAccessRightException extends PMException {
     public UnknownAccessRightException(String ar) {

src/main/java/gov/nist/csd/pm/pap/exception/UnknownOperandException.java → src/main/java/gov/nist/csd/pm/common/exception/UnknownOperandException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class UnknownOperandException extends PMException {
     public UnknownOperandException(String operand) {

src/main/java/gov/nist/csd/pm/pap/exception/UnknownPatternException.java → src/main/java/gov/nist/csd/pm/common/exception/UnknownPatternException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class UnknownPatternException extends PMException {
     public UnknownPatternException() {

src/main/java/gov/nist/csd/pm/pap/exception/UnknownTypeException.java → src/main/java/gov/nist/csd/pm/common/exception/UnknownTypeException.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.exception;
+package gov.nist.csd.pm.common.exception;
 
 public class UnknownTypeException extends PMException {
     public UnknownTypeException(String type) {