fix explain algorithm (#159)

* fic explain and change format

* update path

* before changing references of modifiers to modification

* add explain to pdp

* move modifiers to base pap package

* add test if explain is false

src/main/java/gov/nist/csd/pm/impl/memory/pap/MemoryPAP.java

@@ -3,7 +3,7 @@
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.impl.memory.pap.store.MemoryPolicyStore;
 import gov.nist.csd.pm.pap.PAP;
-import gov.nist.csd.pm.pap.query.PolicyQuerier;
+import gov.nist.csd.pm.pap.PolicyQuerier;
 
 public class MemoryPAP extends PAP {
 

src/main/java/gov/nist/csd/pm/impl/memory/pap/MemoryPolicyQuerier.java

@@ -1,6 +1,6 @@
 package gov.nist.csd.pm.impl.memory.pap;
 
-import gov.nist.csd.pm.pap.query.*;
+import gov.nist.csd.pm.pap.PolicyQuerier;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 
 public class MemoryPolicyQuerier extends PolicyQuerier {

src/main/java/gov/nist/csd/pm/pap/query/AccessQuerier.java → src/main/java/gov/nist/csd/pm/pap/AccessQuerier.java

@@ -1,8 +1,9 @@
-package gov.nist.csd.pm.pap.query;
+package gov.nist.csd.pm.pap;
 
+import gov.nist.csd.pm.pap.query.AccessQuery;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 
-public abstract class AccessQuerier extends Querier implements AccessQuery{
+public abstract class AccessQuerier extends Querier implements AccessQuery {
 
     public AccessQuerier(PolicyStore store) {
         super(store);

src/main/java/gov/nist/csd/pm/pap/query/AccessRightResolver.java → src/main/java/gov/nist/csd/pm/pap/AccessRightResolver.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.query;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.graph.dag.TargetDagResult;
 import gov.nist.csd.pm.pap.graph.dag.UserDagResult;

src/main/java/gov/nist/csd/pm/pap/modification/GraphModifier.java → src/main/java/gov/nist/csd/pm/pap/GraphModifier.java

@@ -1,11 +1,12 @@
-package gov.nist.csd.pm.pap.modification;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.pap.graph.dag.Direction;
 import gov.nist.csd.pm.pap.graph.node.Node;
 import gov.nist.csd.pm.pap.graph.node.NodeType;
 import gov.nist.csd.pm.pap.graph.relationship.Assignment;
 import gov.nist.csd.pm.pap.graph.relationship.Association;
+import gov.nist.csd.pm.pap.modification.GraphModification;
 import gov.nist.csd.pm.pap.obligation.EventPattern;
 import gov.nist.csd.pm.pap.obligation.Obligation;
 import gov.nist.csd.pm.pap.obligation.Rule;

src/main/java/gov/nist/csd/pm/pap/query/GraphQuerier.java → src/main/java/gov/nist/csd/pm/pap/GraphQuerier.java

@@ -1,16 +1,17 @@
-package gov.nist.csd.pm.pap.query;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.pap.graph.node.Node;
 import gov.nist.csd.pm.pap.graph.node.NodeType;
 import gov.nist.csd.pm.pap.graph.relationship.Association;
 import gov.nist.csd.pm.pap.exception.NodeDoesNotExistException;
+import gov.nist.csd.pm.pap.query.GraphQuery;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 
 import java.util.Collection;
 import java.util.Map;
 
-public class GraphQuerier extends Querier implements GraphQuery{
+public class GraphQuerier extends Querier implements GraphQuery {
 
     public GraphQuerier(PolicyStore store) {
         super(store);

src/main/java/gov/nist/csd/pm/pap/modification/Modifier.java → src/main/java/gov/nist/csd/pm/pap/Modifier.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.modification;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.pap.tx.Transactional;

src/main/java/gov/nist/csd/pm/pap/modification/ObligationsModifier.java → src/main/java/gov/nist/csd/pm/pap/ObligationsModifier.java

@@ -1,6 +1,7 @@
-package gov.nist.csd.pm.pap.modification;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
+import gov.nist.csd.pm.pap.modification.ObligationsModification;
 import gov.nist.csd.pm.pap.obligation.EventPattern;
 import gov.nist.csd.pm.pap.obligation.Rule;
 import gov.nist.csd.pm.pap.pml.pattern.Pattern;

src/main/java/gov/nist/csd/pm/pap/query/ObligationsQuerier.java → src/main/java/gov/nist/csd/pm/pap/ObligationsQuerier.java

@@ -1,15 +1,16 @@
-package gov.nist.csd.pm.pap.query;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.pap.obligation.Obligation;
 import gov.nist.csd.pm.pap.exception.ObligationDoesNotExistException;
+import gov.nist.csd.pm.pap.query.ObligationsQuery;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
 
-public class ObligationsQuerier extends Querier implements ObligationsQuery{
+public class ObligationsQuerier extends Querier implements ObligationsQuery {
 
     public ObligationsQuerier(PolicyStore store) {
         super(store);

src/main/java/gov/nist/csd/pm/pap/modification/OperationsModifier.java → src/main/java/gov/nist/csd/pm/pap/OperationsModifier.java

@@ -1,17 +1,18 @@
-package gov.nist.csd.pm.pap.modification;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.pap.graph.relationship.AccessRightSet;
 import gov.nist.csd.pm.pap.exception.AdminAccessRightExistsException;
 import gov.nist.csd.pm.pap.exception.OperationExistsException;
+import gov.nist.csd.pm.pap.modification.OperationsModification;
 import gov.nist.csd.pm.pap.op.AdminOperations;
 import gov.nist.csd.pm.pap.op.Operation;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 
 import static gov.nist.csd.pm.pap.op.AdminAccessRights.isAdminAccessRight;
 import static gov.nist.csd.pm.pap.op.AdminAccessRights.isWildcardAccessRight;
 
-public class OperationsModifier extends Modifier implements OperationsModification{
+public class OperationsModifier extends Modifier implements OperationsModification {
 
     public OperationsModifier(PolicyStore store) throws PMException {
         super(store);

src/main/java/gov/nist/csd/pm/pap/query/OperationsQuerier.java → src/main/java/gov/nist/csd/pm/pap/OperationsQuerier.java

@@ -1,14 +1,15 @@
-package gov.nist.csd.pm.pap.query;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.pap.graph.relationship.AccessRightSet;
 import gov.nist.csd.pm.pap.exception.OperationDoesNotExistException;
 import gov.nist.csd.pm.pap.op.Operation;
+import gov.nist.csd.pm.pap.query.OperationsQuery;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 
 import java.util.*;
 
-public class OperationsQuerier extends Querier implements OperationsQuery{
+public class OperationsQuerier extends Querier implements OperationsQuery {
 
     public OperationsQuerier(PolicyStore store) {
         super(store);

src/main/java/gov/nist/csd/pm/pap/PAP.java

@@ -3,25 +3,26 @@
 import gov.nist.csd.pm.pap.admin.AdminPolicy;
 import gov.nist.csd.pm.pap.executable.AdminExecutable;
 import gov.nist.csd.pm.pap.executable.AdminExecutor;
-import gov.nist.csd.pm.pap.modification.PolicyModifier;
+import gov.nist.csd.pm.pap.modification.PolicyModification;
 import gov.nist.csd.pm.pap.pml.PMLCompiler;
 import gov.nist.csd.pm.pap.pml.context.ExecutionContext;
 import gov.nist.csd.pm.pap.pml.executable.operation.PMLOperation;
 import gov.nist.csd.pm.pap.pml.executable.routine.PMLRoutine;
 import gov.nist.csd.pm.pap.pml.statement.PMLStatement;
 import gov.nist.csd.pm.pap.pml.value.Value;
-import gov.nist.csd.pm.pap.query.PolicyQuerier;
+import gov.nist.csd.pm.pap.query.PolicyQuery;
+import gov.nist.csd.pm.pap.query.UserContext;
 import gov.nist.csd.pm.pap.serialization.PolicyDeserializer;
 import gov.nist.csd.pm.pap.serialization.PolicySerializer;
 import gov.nist.csd.pm.pap.exception.PMException;
-import gov.nist.csd.pm.pap.query.UserContext;
 import gov.nist.csd.pm.pap.store.PolicyStore;
+import gov.nist.csd.pm.pap.tx.Transactional;
 
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
-public abstract class PAP implements PolicyPoint, AdminExecutor {
+public abstract class PAP implements AdminExecutor, Transactional {
 
     protected final PolicyStore policyStore;
     private final PolicyModifier modifier;
@@ -44,17 +45,16 @@ public PAP(PAP pap) throws PMException {
         this(pap.policyStore);
     }
 
-    public abstract PolicyQuerier query();
-
-    public PolicyModifier modify() {
-        return modifier;
+    public PolicyStore policyStore() {
+        return policyStore;
     }
 
-    protected PolicyStore policyStore() {
-        return policyStore;
+    public abstract PolicyQuery query();
+
+    public PolicyModification modify() {
+        return modifier;
     }
 
-    @Override
     public void reset() throws PMException {
         policyStore.reset();
 

src/main/java/gov/nist/csd/pm/pap/modification/PolicyModifier.java → src/main/java/gov/nist/csd/pm/pap/PolicyModifier.java

@@ -1,8 +1,9 @@
-package gov.nist.csd.pm.pap.modification;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.pap.admin.AdminPolicy;
 import gov.nist.csd.pm.pap.admin.AdminPolicyNode;
+import gov.nist.csd.pm.pap.modification.PolicyModification;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 
 import static gov.nist.csd.pm.pap.graph.node.NodeType.OA;
@@ -28,10 +29,6 @@ public PolicyModifier(PolicyStore store) throws PMException {
         this.routinesModifier = new RoutinesModifier(store);
     }
 
-    public PolicyModifier(PolicyModifier modifier) throws PMException {
-        this(modifier.store);
-    }
-
     @Override
     public GraphModifier graph() {
         return graphModifier;

src/main/java/gov/nist/csd/pm/pap/query/PolicyQuerier.java → src/main/java/gov/nist/csd/pm/pap/PolicyQuerier.java

@@ -1,5 +1,6 @@
-package gov.nist.csd.pm.pap.query;
+package gov.nist.csd.pm.pap;
 
+import gov.nist.csd.pm.pap.query.PolicyQuery;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 
 public abstract class PolicyQuerier extends Querier implements PolicyQuery {
@@ -20,10 +21,6 @@ public PolicyQuerier(PolicyStore store) {
         this.routinesQuerier = new RoutinesQuerier(store);
     }
 
-    public PolicyQuerier(Querier querier) {
-        this(querier.store);
-    }
-
     @Override
     public abstract AccessQuerier access();
 

src/main/java/gov/nist/csd/pm/pap/modification/ProhibitionsModifier.java → src/main/java/gov/nist/csd/pm/pap/ProhibitionsModifier.java

@@ -1,6 +1,7 @@
-package gov.nist.csd.pm.pap.modification;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
+import gov.nist.csd.pm.pap.modification.ProhibitionsModification;
 import gov.nist.csd.pm.pap.prohibition.ContainerCondition;
 import gov.nist.csd.pm.pap.prohibition.ProhibitionSubject;
 import gov.nist.csd.pm.pap.exception.ProhibitionContainerDoesNotExistException;
@@ -12,7 +13,7 @@
 import java.util.ArrayList;
 import java.util.Collection;
 
-import static gov.nist.csd.pm.pap.modification.GraphModifier.checkAccessRightsValid;
+import static gov.nist.csd.pm.pap.GraphModifier.checkAccessRightsValid;
 
 public class ProhibitionsModifier extends Modifier implements ProhibitionsModification {
 

src/main/java/gov/nist/csd/pm/pap/query/ProhibitionsQuerier.java → src/main/java/gov/nist/csd/pm/pap/ProhibitionsQuerier.java

@@ -1,11 +1,12 @@
-package gov.nist.csd.pm.pap.query;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.pap.graph.dag.DepthFirstGraphWalker;
 import gov.nist.csd.pm.pap.graph.dag.Direction;
 import gov.nist.csd.pm.pap.prohibition.ContainerCondition;
 import gov.nist.csd.pm.pap.prohibition.Prohibition;
 import gov.nist.csd.pm.pap.exception.ProhibitionDoesNotExistException;
+import gov.nist.csd.pm.pap.query.ProhibitionsQuery;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 
 import java.util.ArrayList;

src/main/java/gov/nist/csd/pm/pap/query/Querier.java → src/main/java/gov/nist/csd/pm/pap/Querier.java

@@ -1,4 +1,4 @@
-package gov.nist.csd.pm.pap.query;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.store.PolicyStore;
 

src/main/java/gov/nist/csd/pm/pap/modification/RoutinesModifier.java → src/main/java/gov/nist/csd/pm/pap/RoutinesModifier.java

@@ -1,11 +1,12 @@
-package gov.nist.csd.pm.pap.modification;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.pap.exception.RoutineExistsException;
+import gov.nist.csd.pm.pap.modification.RoutinesModification;
 import gov.nist.csd.pm.pap.routine.Routine;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 
-public class RoutinesModifier extends Modifier implements RoutinesModification{
+public class RoutinesModifier extends Modifier implements RoutinesModification {
 
     public RoutinesModifier(PolicyStore store) {
         super(store);

src/main/java/gov/nist/csd/pm/pap/query/RoutinesQuerier.java → src/main/java/gov/nist/csd/pm/pap/RoutinesQuerier.java

@@ -1,7 +1,8 @@
-package gov.nist.csd.pm.pap.query;
+package gov.nist.csd.pm.pap;
 
 import gov.nist.csd.pm.pap.exception.PMException;
 import gov.nist.csd.pm.pap.exception.RoutineDoesNotExistException;
+import gov.nist.csd.pm.pap.query.RoutinesQuery;
 import gov.nist.csd.pm.pap.routine.Routine;
 import gov.nist.csd.pm.pap.store.PolicyStore;
 

src/main/java/gov/nist/csd/pm/pap/graph/dag/AllPathsShortCircuit.java

@@ -1,5 +1,7 @@
 package gov.nist.csd.pm.pap.graph.dag;
 
+import gov.nist.csd.pm.pap.exception.PMException;
+
 public class AllPathsShortCircuit implements ShortCircuit{
 
     private boolean s;
@@ -11,7 +13,7 @@ public AllPathsShortCircuit(ShortCircuit shortCircuit) {
     }
 
     @Override
-    public boolean evaluate(String node) {
+    public boolean evaluate(String node) throws PMException {
         boolean e = this.shortCircuit.evaluate(node);
         if (!s) {
             s = e;

src/main/java/gov/nist/csd/pm/pap/graph/dag/ShortCircuit.java

@@ -1,7 +1,9 @@
 package gov.nist.csd.pm.pap.graph.dag;
 
+import gov.nist.csd.pm.pap.exception.PMException;
+
 public interface ShortCircuit {
 
-    boolean evaluate(String node);
+    boolean evaluate(String node) throws PMException;
 
 }