# gisaia/arlas-server architecture

> Architecture diagram of the GitHub repository gisaia/arlas-server, 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/gisaia/arlas-server
- Repository: https://github.com/gisaia/arlas-server

## Overview

ARLAS-server exposes REST APIs for exploring Elasticsearch-backed collections and managing collection metadata. The main workflow is a client search request, parsed and validated by REST handlers, executed through exploration services, and returned as hits or aggregations; collection metadata and field permissions shape that workflow. Separate protocol branches provide OpenSearch, STAC, CSW, and WFS capabilities, with raster-tile support as another product feature. Source excerpts establish only some runtime links; undocumented protocol-to-service wiring is omitted or marked unverified.

Main entry points: [`arlas-core/src/main/java/io/arlas/server/core/services/ExploreService.java`](https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/services/ExploreService.java) (Explore service), [`arlas-core/src/main/java/io/arlas/server/core/services/CollectionReferenceService.java`](https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/services/CollectionReferenceService.java) (Collection metadata), [`arlas-rest/src/main/java/io/arlas/server/rest/explore/search/SearchRESTService.java`](https://github.com/gisaia/arlas-server/blob/develop/arlas-rest/src/main/java/io/arlas/server/rest/explore/search/SearchRESTService.java) (Search endpoints), [`ogc-common/src/main/java/io/arlas/server/ogc/common/OGCRESTService.java`](https://github.com/gisaia/arlas-server/blob/develop/ogc-common/src/main/java/io/arlas/server/ogc/common/OGCRESTService.java) (OGC common)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["REST exploration"]
  node_rest["Search endpoints"]
  node_geo["Geo search"]
  node_collectionapi["Collection API"]
  node_tiles["Raster tiles"]
end

subgraph group_core["Search and metadata"]
  node_explore["Explore service"]
  node_fluid["Fluid search"]
  node_collection["Collection metadata"]
  node_params["Parameter parsing<br/>[ParamsParser.java]"]
  node_validation["Request validation<br/>[CheckParams.java]"]
  node_columnfilter["Field permissions"]
end

subgraph group_protocols["Geospatial protocols"]
  node_opensearch["OpenSearch descriptors"]
  node_stac["STAC API"]
  node_csw["CSW services"]
  node_wfs["WFS services"]
  node_ogccommon["OGC common"]
end

subgraph group_platform["Runtime and access"]
  node_server["Server configuration"]
  node_auth["Policy enforcement"]
  node_cache["Response cache"]
end

node_client(("API client"))
node_elastic[("Elasticsearch")]

node_client -->|"requests"| node_rest
node_client -.->|"requests"| node_geo
node_rest -->|"calls"| node_explore
node_geo -->|"calls"| node_explore
node_rest -->|"parses"| node_params
node_rest -->|"validates"| node_validation
node_rest -->|"checks fields"| node_columnfilter
node_explore -->|"uses metadata"| node_collection
node_explore -.->|"builds queries"| node_fluid
node_fluid -->|"reads fields"| node_collection
node_explore -.->|"queries"| node_elastic
node_collectionapi -.->|"manages"| node_collection
node_collection -.->|"reads mappings"| node_elastic
node_opensearch -->|"uses search"| node_explore
node_stac -->|"searches"| node_explore
node_stac -->|"reads collections"| node_collection
node_csw -.->|"uses common"| node_ogccommon
node_wfs -.->|"uses common"| node_ogccommon
node_ogccommon -->|"accesses metadata"| node_collection
node_tiles -.->|"serves imagery"| node_elastic
node_server -.->|"configures"| node_auth
node_explore -.->|"caches responses"| node_cache

click node_rest "https://github.com/gisaia/arlas-server/blob/develop/arlas-rest/src/main/java/io/arlas/server/rest/explore/search/SearchRESTService.java"
click node_geo "https://github.com/gisaia/arlas-server/blob/develop/arlas-rest/src/main/java/io/arlas/server/rest/explore/search/GeoSearchRESTService.java"
click node_explore "https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/services/ExploreService.java"
click node_fluid "https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/services/FluidSearchService.java"
click node_collection "https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/services/CollectionReferenceService.java"
click node_collectionapi "https://github.com/gisaia/arlas-server/blob/develop/arlas-rest/src/main/java/io/arlas/server/rest/collections/CollectionRESTServices.java"
click node_opensearch "https://github.com/gisaia/arlas-server/blob/develop/arlas-opensearch/src/main/java/io/arlas/server/opensearch/rest/explore/OpenSearchDescriptorService.java"
click node_stac "https://github.com/gisaia/arlas-server/blob/develop/stac-api/src/main/java/io/arlas/server/stac/api/StacSearchRESTService.java"
click node_csw "https://github.com/gisaia/arlas-server/blob/develop/ogc-csw/src/main/java/io/arlas/server/ogc/csw/CSWRESTService.java"
click node_wfs "https://github.com/gisaia/arlas-server/blob/develop/ogc-wfs/src/main/java/io/arlas/server/ogc/wfs/WFSRESTService.java"
click node_ogccommon "https://github.com/gisaia/arlas-server/blob/develop/ogc-common/src/main/java/io/arlas/server/ogc/common/OGCRESTService.java"
click node_tiles "https://github.com/gisaia/arlas-server/blob/develop/arlas-rest/src/main/java/io/arlas/server/rest/plugins/eo/TileRESTService.java"
click node_server "https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/app/ArlasServerConfiguration.java"
click node_auth "https://github.com/gisaia/arlas-server/blob/develop/arlas-commons/src/main/java/io/arlas/filter/core/PolicyEnforcer.java"
click node_cache "https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/utils/ResponseCacheManager.java"
click node_params "https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/utils/ParamsParser.java"
click node_validation "https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/utils/CheckParams.java"
click node_columnfilter "https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/utils/ColumnFilterUtil.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_rest,node_geo,node_collectionapi,node_tiles,node_client toneBlue
class node_explore,node_fluid,node_collection,node_params,node_validation,node_columnfilter,node_elastic toneAmber
class node_opensearch,node_stac,node_csw,node_wfs,node_ogccommon toneMint
class node_server,node_auth,node_cache toneRose
```

## Components

### REST exploration

- [Search endpoints](https://github.com/gisaia/arlas-server/blob/develop/arlas-rest/src/main/java/io/arlas/server/rest/explore/search/SearchRESTService.java): `arlas-rest/src/main/java/io/arlas/server/rest/explore/search/SearchRESTService.java`
- [Geo search](https://github.com/gisaia/arlas-server/blob/develop/arlas-rest/src/main/java/io/arlas/server/rest/explore/search/GeoSearchRESTService.java): `arlas-rest/src/main/java/io/arlas/server/rest/explore/search/GeoSearchRESTService.java`
- [Collection API](https://github.com/gisaia/arlas-server/blob/develop/arlas-rest/src/main/java/io/arlas/server/rest/collections/CollectionRESTServices.java): `arlas-rest/src/main/java/io/arlas/server/rest/collections/CollectionRESTServices.java`
- [Raster tiles](https://github.com/gisaia/arlas-server/blob/develop/arlas-rest/src/main/java/io/arlas/server/rest/plugins/eo/TileRESTService.java): `arlas-rest/src/main/java/io/arlas/server/rest/plugins/eo/TileRESTService.java`

### Search and metadata

- [Explore service](https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/services/ExploreService.java): `arlas-core/src/main/java/io/arlas/server/core/services/ExploreService.java`
- [Fluid search](https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/services/FluidSearchService.java): `arlas-core/src/main/java/io/arlas/server/core/services/FluidSearchService.java`
- [Collection metadata](https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/services/CollectionReferenceService.java): `arlas-core/src/main/java/io/arlas/server/core/services/CollectionReferenceService.java`
- [Parameter parsing](https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/utils/ParamsParser.java): `arlas-core/src/main/java/io/arlas/server/core/utils/ParamsParser.java`
- [Request validation](https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/utils/CheckParams.java): `arlas-core/src/main/java/io/arlas/server/core/utils/CheckParams.java`
- [Field permissions](https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/utils/ColumnFilterUtil.java): `arlas-core/src/main/java/io/arlas/server/core/utils/ColumnFilterUtil.java`

### Geospatial protocols

- [OpenSearch descriptors](https://github.com/gisaia/arlas-server/blob/develop/arlas-opensearch/src/main/java/io/arlas/server/opensearch/rest/explore/OpenSearchDescriptorService.java): `arlas-opensearch/src/main/java/io/arlas/server/opensearch/rest/explore/OpenSearchDescriptorService.java`
- [STAC API](https://github.com/gisaia/arlas-server/blob/develop/stac-api/src/main/java/io/arlas/server/stac/api/StacSearchRESTService.java): `stac-api/src/main/java/io/arlas/server/stac/api/StacSearchRESTService.java`
- [CSW services](https://github.com/gisaia/arlas-server/blob/develop/ogc-csw/src/main/java/io/arlas/server/ogc/csw/CSWRESTService.java): `ogc-csw/src/main/java/io/arlas/server/ogc/csw/CSWRESTService.java`
- [WFS services](https://github.com/gisaia/arlas-server/blob/develop/ogc-wfs/src/main/java/io/arlas/server/ogc/wfs/WFSRESTService.java): `ogc-wfs/src/main/java/io/arlas/server/ogc/wfs/WFSRESTService.java`
- [OGC common](https://github.com/gisaia/arlas-server/blob/develop/ogc-common/src/main/java/io/arlas/server/ogc/common/OGCRESTService.java): `ogc-common/src/main/java/io/arlas/server/ogc/common/OGCRESTService.java`

### Runtime and access

- [Server configuration](https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/app/ArlasServerConfiguration.java): `arlas-core/src/main/java/io/arlas/server/core/app/ArlasServerConfiguration.java`
- [Policy enforcement](https://github.com/gisaia/arlas-server/blob/develop/arlas-commons/src/main/java/io/arlas/filter/core/PolicyEnforcer.java): `arlas-commons/src/main/java/io/arlas/filter/core/PolicyEnforcer.java`
- [Response cache](https://github.com/gisaia/arlas-server/blob/develop/arlas-core/src/main/java/io/arlas/server/core/utils/ResponseCacheManager.java): `arlas-core/src/main/java/io/arlas/server/core/utils/ResponseCacheManager.java`

### Other components

- **API client**
- **Elasticsearch**

## Connections

- API client → Search endpoints: requests
- API client → Geo search: requests
- Search endpoints → Explore service: calls (evidence: `arlas-rest/src/main/java/io/arlas/server/rest/explore/search/SearchRESTService.java`)
- Geo search → Explore service: calls (evidence: `arlas-rest/src/main/java/io/arlas/server/rest/explore/search/GeoSearchRESTService.java`)
- Search endpoints → Parameter parsing: parses (evidence: `arlas-rest/src/main/java/io/arlas/server/rest/explore/search/SearchRESTService.java`)
- Search endpoints → Request validation: validates (evidence: `arlas-rest/src/main/java/io/arlas/server/rest/explore/search/SearchRESTService.java`)
- Search endpoints → Field permissions: checks fields (evidence: `arlas-rest/src/main/java/io/arlas/server/rest/explore/search/SearchRESTService.java`)
- Explore service → Collection metadata: uses metadata (evidence: `arlas-core/src/main/java/io/arlas/server/core/services/ExploreService.java`)
- Explore service → Fluid search: builds queries (evidence: `arlas-core/src/main/java/io/arlas/server/core/services/ExploreService.java`)
- Fluid search → Collection metadata: reads fields (evidence: `arlas-core/src/main/java/io/arlas/server/core/services/FluidSearchService.java`)
- Explore service → Elasticsearch: queries
- Collection API → Collection metadata: manages
- Collection metadata → Elasticsearch: reads mappings
- OpenSearch descriptors → Explore service: uses search (evidence: `arlas-opensearch/src/main/java/io/arlas/server/opensearch/rest/explore/OpenSearchDescriptorService.java`)
- STAC API → Explore service: searches (evidence: `stac-api/src/main/java/io/arlas/server/stac/api/StacSearchRESTService.java`)
- STAC API → Collection metadata: reads collections (evidence: `stac-api/src/main/java/io/arlas/server/stac/api/StacSearchRESTService.java`)
- CSW services → OGC common: uses common (evidence: `ogc-csw/src/main/java/io/arlas/server/ogc/csw/CSWRESTService.java`)
- WFS services → OGC common: uses common (evidence: `ogc-wfs/src/main/java/io/arlas/server/ogc/wfs/WFSRESTService.java`)
- OGC common → Collection metadata: accesses metadata (evidence: `ogc-common/src/main/java/io/arlas/server/ogc/common/OGCRESTService.java`)
- Raster tiles → Elasticsearch: serves imagery
- Server configuration → Policy enforcement: configures
- Explore service → Response cache: caches responses (evidence: `arlas-core/src/main/java/io/arlas/server/core/services/ExploreService.java`)
