Safe Haskell	None
Language	GHC2021

Ecluse.Core.Registry.Adapter

Contents

The capability record
Registration

Description

The ecosystem adapter registry: which ecosystems this build supports, independent of what an operator configures. An unsupported ecosystem resolves to Nothing here and an unconfigured one is never activated, so the composition root can tell a missing adapter from an unconfigured mount.

Synopsis

The capability record

data RegistryAdapter Source #

One ecosystem's complete capability record, which the composition root wires every consuming pipeline from. adapterFor resolves it.

Constructors

RegistryAdapter

Fields

adapterEcosystem :: Ecosystem
The registry key must agree with it, so no record can register under a foreign ecosystem.
adapterServe :: AdapterServe
The web-facing serve surface: the route grammar and response contracts.
adapterMetadata :: AdapterMetadata
The metadata capability: the read-handle constructor and the packument assembly.
adapterArtifact :: AdapterArtifact
The artifact request formation, by filename and by authoritative URL.
adapterProjectName :: ProjectName
The ecosystem's own name parser, which every caller that turns a raw string into a PackageName reads.
adapterPublish :: Maybe AdapterPublish
Nothing for an ecosystem this build writes nothing for, whose publish route then answers 405 and whose declared write destination refuses the boot.
adapterMaintenance :: AdapterMaintenance
The store maintenance verbs. Either may be absent, and a Dredger then refuses the mount.

data AdapterServe Source #

The ecosystem's web-facing serve surface. Both routing fields are derived from one declarative route table, so the routed surface and the documented one cannot drift apart.

Constructors

AdapterServe

Fields

serveRouter :: MountRouter
Which path a mount-relative request names. An unrecognised one yields the default 404.
serveRoutes :: NonEmpty RouteSpec
The same route table as data, which the OpenAPI spec (Ecluse.Manifest) renders.
serveCredential :: CredentialMapping
How the mount recovers a client's credential and how Écluse carries one upstream. The neutral pipeline spells no scheme of its own.

Registration

adapterFor :: Ecosystem -> Maybe RegistryAdapter Source #

Resolve an ecosystem to its registered RegistryAdapter. Every arm is explicit, so an added Ecosystem surfaces here as a compiler error rather than a silent Nothing.