# usnistgov/policy-machine-core architecture

> Architecture diagram of the GitHub repository usnistgov/policy-machine-core, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/usnistgov/policy-machine-core
- Repository: https://github.com/usnistgov/policy-machine-core

## Overview

Policy Machine Core is a Java NGAC policy administration and decision library, with in-memory and optional embedded Neo4j storage plus a separate gRPC client artifact. The documented workflow is to administer and query policy through a PAP, optionally put a PDP in front of administrative operations for access checks, then connect an EPP to observe PDP events and process policy obligations. PML provides a policy-definition and execution path. Some subsystem connections are documented only at package level; unsampled implementation details are not inferred.

Main entry points: [`core/src/main/java/gov/nist/ngac/pm/core/pap/PAP.java`](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/PAP.java) (PAP API), [`core/src/main/java/gov/nist/ngac/pm/core/pap/pml/PMLCompiler.java`](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/pml/PMLCompiler.java) (PML compiler), [`core/src/main/java/gov/nist/ngac/pm/core/pap/pml/context/ExecutionContext.java`](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/pml/context/ExecutionContext.java) (PML execution), [`core/src/main/java/gov/nist/ngac/pm/core/epp/EPP.java`](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/epp/EPP.java) (Event Processing Point)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_policy["Policy services"]
  node_pap["PAP API<br/>[PAP.java]"]
  node_policy_model["Policy model<br/>[Node.java]"]
  node_queries["Policy queries<br/>[AccessQuery.java]"]
  node_adjudication["PDP adjudication<br/>[Adjudicator.java]"]
  node_query_adjudication["Query adjudicators"]
end

subgraph group_language["Policy language"]
  node_pml_compile["PML compiler<br/>[PMLCompiler.java]"]
  node_pml_execution["PML execution"]
  node_pml_operations["PML operations"]
end

subgraph group_storage["Policy storage"]
  node_memory_pap["Memory PAP<br/>[MemoryPAP.java]"]
  node_memory_store[("Memory stores<br/>[MemoryStore.java]")]
  node_neo4j_pap["Neo4j PAP"]
  node_neo4j_store[("Neo4j stores")]
end

subgraph group_integration["Events and remote access"]
  node_epp["Event Processing Point<br/>[EPP.java]"]
  node_obligations["Obligation rules<br/>[Obligation.java]"]
  node_grpc_client["gRPC client<br/>[GrpcQueryPDP.java]"]
  node_grpc_resource["gRPC resource adjudication"]
end

node_admin(("Policy administrator"))
node_event_source(("PDP event source"))

node_admin -->|"administers policy"| node_pap
node_admin -->|"defines policy"| node_pml_compile
node_pap -->|"modifies policy"| node_policy_model
node_pap -->|"queries policy"| node_queries
node_pap -->|"compiles PML"| node_pml_compile
node_pml_compile -.->|"produces statements"| node_pml_execution
node_pap -->|"executes statements"| node_pml_execution
node_pml_execution -->|"runs operations"| node_pml_operations
node_pap -->|"access-checks admin"| node_adjudication
node_adjudication -.->|"adjudicates queries"| node_query_adjudication
node_query_adjudication -->|"queries policy"| node_pap
node_pap -->|"uses implementation"| node_memory_pap
node_memory_pap -.->|"stores policy"| node_memory_store
node_pap -->|"uses implementation"| node_neo4j_pap
node_neo4j_pap -.->|"stores policy"| node_neo4j_store
node_pap -->|"defines obligations"| node_obligations
node_pap -->|"provides obligations"| node_epp
node_event_source -->|"publishes events"| node_epp
node_epp -->|"processes obligations"| node_obligations
node_grpc_client -.->|"supports adjudication"| node_grpc_resource

click node_pap "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/PAP.java"
click node_policy_model "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/common/graph/node/Node.java"
click node_queries "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/query/AccessQuery.java"
click node_adjudication "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pdp/adjudication/Adjudicator.java"
click node_query_adjudication "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pdp/query/GraphQueryAdjudicator.java"
click node_pml_compile "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/pml/PMLCompiler.java"
click node_pml_execution "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/pml/context/ExecutionContext.java"
click node_pml_operations "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/pml/operation/query/PMLStmtsQueryOperation.java"
click node_memory_pap "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/impl/memory/pap/MemoryPAP.java"
click node_memory_store "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/impl/memory/pap/store/MemoryStore.java"
click node_neo4j_pap "https://github.com/usnistgov/policy-machine-core/blob/main/neo4j/src/main/java/gov/nist/ngac/pm/core/neo4j/embedded/pap/Neo4jEmbeddedPAP.java"
click node_neo4j_store "https://github.com/usnistgov/policy-machine-core/blob/main/neo4j/src/main/java/gov/nist/ngac/pm/core/neo4j/embedded/pap/store/Neo4jEmbeddedGraphStore.java"
click node_epp "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/epp/EPP.java"
click node_obligations "https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/obligation/Obligation.java"
click node_grpc_client "https://github.com/usnistgov/policy-machine-core/blob/main/grpc/src/main/java/gov/nist/ngac/pm/core/grpc/client/GrpcQueryPDP.java"
click node_grpc_resource "https://github.com/usnistgov/policy-machine-core/blob/main/grpc/src/main/java/gov/nist/ngac/pm/core/grpc/client/GrpcResourceAdjudicationService.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_pap,node_policy_model,node_queries,node_adjudication,node_query_adjudication toneBlue
class node_pml_compile,node_pml_execution,node_pml_operations toneAmber
class node_memory_pap,node_memory_store,node_neo4j_pap,node_neo4j_store toneMint
class node_epp,node_obligations,node_grpc_client,node_grpc_resource toneRose
class node_admin,node_event_source toneIndigo
```

## Components

### Policy services

- [PAP API](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/PAP.java): `core/src/main/java/gov/nist/ngac/pm/core/pap/PAP.java`
- [Policy model](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/common/graph/node/Node.java): `core/src/main/java/gov/nist/ngac/pm/core/common/graph/node/Node.java`
- [Policy queries](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/query/AccessQuery.java): `core/src/main/java/gov/nist/ngac/pm/core/pap/query/AccessQuery.java`
- [PDP adjudication](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pdp/adjudication/Adjudicator.java): `core/src/main/java/gov/nist/ngac/pm/core/pdp/adjudication/Adjudicator.java`
- [Query adjudicators](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pdp/query/GraphQueryAdjudicator.java): `core/src/main/java/gov/nist/ngac/pm/core/pdp/query/GraphQueryAdjudicator.java`

### Policy language

- [PML compiler](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/pml/PMLCompiler.java): `core/src/main/java/gov/nist/ngac/pm/core/pap/pml/PMLCompiler.java`
- [PML execution](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/pml/context/ExecutionContext.java): `core/src/main/java/gov/nist/ngac/pm/core/pap/pml/context/ExecutionContext.java`
- [PML operations](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/pml/operation/query/PMLStmtsQueryOperation.java): `core/src/main/java/gov/nist/ngac/pm/core/pap/pml/operation/query/PMLStmtsQueryOperation.java`

### Policy storage

- [Memory PAP](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/impl/memory/pap/MemoryPAP.java): `core/src/main/java/gov/nist/ngac/pm/core/impl/memory/pap/MemoryPAP.java`
- [Memory stores](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/impl/memory/pap/store/MemoryStore.java): `core/src/main/java/gov/nist/ngac/pm/core/impl/memory/pap/store/MemoryStore.java`
- [Neo4j PAP](https://github.com/usnistgov/policy-machine-core/blob/main/neo4j/src/main/java/gov/nist/ngac/pm/core/neo4j/embedded/pap/Neo4jEmbeddedPAP.java): `neo4j/src/main/java/gov/nist/ngac/pm/core/neo4j/embedded/pap/Neo4jEmbeddedPAP.java`
- [Neo4j stores](https://github.com/usnistgov/policy-machine-core/blob/main/neo4j/src/main/java/gov/nist/ngac/pm/core/neo4j/embedded/pap/store/Neo4jEmbeddedGraphStore.java): `neo4j/src/main/java/gov/nist/ngac/pm/core/neo4j/embedded/pap/store/Neo4jEmbeddedGraphStore.java`

### Events and remote access

- [Event Processing Point](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/epp/EPP.java): `core/src/main/java/gov/nist/ngac/pm/core/epp/EPP.java`
- [Obligation rules](https://github.com/usnistgov/policy-machine-core/blob/main/core/src/main/java/gov/nist/ngac/pm/core/pap/obligation/Obligation.java): `core/src/main/java/gov/nist/ngac/pm/core/pap/obligation/Obligation.java`
- [gRPC client](https://github.com/usnistgov/policy-machine-core/blob/main/grpc/src/main/java/gov/nist/ngac/pm/core/grpc/client/GrpcQueryPDP.java): `grpc/src/main/java/gov/nist/ngac/pm/core/grpc/client/GrpcQueryPDP.java`
- [gRPC resource adjudication](https://github.com/usnistgov/policy-machine-core/blob/main/grpc/src/main/java/gov/nist/ngac/pm/core/grpc/client/GrpcResourceAdjudicationService.java): `grpc/src/main/java/gov/nist/ngac/pm/core/grpc/client/GrpcResourceAdjudicationService.java`

### Other components

- **Policy administrator**
- **PDP event source**

## Connections

- Policy administrator → PAP API: administers policy (evidence: `README.md`)
- Policy administrator → PML compiler: defines policy (evidence: `README.md`)
- PAP API → Policy model: modifies policy (evidence: `README.md`)
- PAP API → Policy queries: queries policy (evidence: `core/src/main/java/gov/nist/ngac/pm/core/pap/PAP.java`)
- PAP API → PML compiler: compiles PML (evidence: `core/src/main/java/gov/nist/ngac/pm/core/pap/PAP.java`)
- PML compiler → PML execution: produces statements
- PAP API → PML execution: executes statements (evidence: `core/src/main/java/gov/nist/ngac/pm/core/pap/PAP.java`)
- PML execution → PML operations: runs operations (evidence: `core/src/main/java/gov/nist/ngac/pm/core/pap/pml/operation/query/PMLStmtsQueryOperation.java`)
- PAP API → PDP adjudication: access-checks admin (evidence: `README.md`)
- PDP adjudication → Query adjudicators: adjudicates queries (evidence: `core/src/main/java/gov/nist/ngac/pm/core/pdp/query/GraphQueryAdjudicator.java`)
- Query adjudicators → PAP API: queries policy (evidence: `core/src/main/java/gov/nist/ngac/pm/core/pdp/query/GraphQueryAdjudicator.java`)
- PAP API → Memory PAP: uses implementation (evidence: `README.md`)
- Memory PAP → Memory stores: stores policy
- PAP API → Neo4j PAP: uses implementation (evidence: `README.md`)
- Neo4j PAP → Neo4j stores: stores policy
- PAP API → Obligation rules: defines obligations (evidence: `README.md`)
- PAP API → Event Processing Point: provides obligations (evidence: `README.md`)
- PDP event source → Event Processing Point: publishes events (evidence: `README.md`)
- Event Processing Point → Obligation rules: processes obligations (evidence: `README.md`)
- gRPC client → gRPC resource adjudication: supports adjudication
