Pular para conteúdo

Global Registry — catálogo e aliases

Database: gateway-globals, explícita nas entidades e em DatabaseSetup. O serviço mantém documentos globais com ownership lógico, não uma database por tenant.

Modelos visuais

Catálogo e aliases globais

Collections independentes no banco global.

Catálogo e aliases globais; visão simplificada. Detalhes no visualizador abaixo. Catálogo e aliases globais; visão simplificada em tema escuro.

Explorar diagramas detalhados com zoom

Legenda e convenções dos modelos. Os dicionários e evidências desta página permanecem a referência dos campos.

%%{init: {"theme":"base","themeVariables":{"fontFamily":"Arial, sans-serif","fontSize":"16px","lineColor":"#64748b","primaryTextColor":"#172b4d"},"flowchart":{"htmlLabels":true,"useMaxWidth":true,"nodeSpacing":28,"rankSpacing":38,"padding":14,"curve":"linear","subGraphTitleMargin":{"top":12,"bottom":16}},"sequence":{"useMaxWidth":true,"actorMargin":28,"width":145,"height":45,"diagramMarginX":32,"diagramMarginY":12,"messageMargin":24,"wrap":true,"mirrorActors":false},"themeCSS":".edgeLabel, .edgeLabel p {background-color:var(--diagram-surface)!important;color:var(--diagram-text)!important}\n.cluster rect {fill:var(--diagram-group)!important;stroke:var(--diagram-line)!important}\n.cluster-label span, .cluster-label text {color:var(--diagram-text)!important;fill:var(--diagram-text)!important}\n.flowchart-link, .actor-line {stroke:var(--diagram-line)!important}\nmarker path {fill:var(--diagram-line)!important;stroke:var(--diagram-line)!important}\n.actor {fill:var(--diagram-domain)!important;stroke:var(--diagram-domain-border)!important}\ntext.actor, .messageText, .loopText, .labelText {fill:var(--diagram-text)!important}\n.messageLine0, .messageLine1, .loopLine {stroke:var(--diagram-line)!important}\n.labelBox {fill:var(--diagram-surface)!important;stroke:var(--diagram-line)!important}\n.note {fill:var(--diagram-async)!important;stroke:var(--diagram-async-border)!important}\n.noteText {fill:var(--diagram-text)!important}\n.nodeLabel, .nodeLabel p, .nodeLabel span {color:var(--diagram-text)!important}\n.node .nodeLabel, .node .nodeLabel p {font-size:17px;font-weight:600;line-height:1.4;text-align:center}\n.nodeLabel small {display:inline-block;margin-top:4px;font-size:15px;font-weight:400;line-height:1.4;color:var(--diagram-description)!important}\ntext.actor, text.actor tspan {font-size:17px;font-weight:600}\n.node.entry rect, .node.entry polygon, .node.entry path, .node.entry circle {fill:var(--diagram-entry)!important;stroke:var(--diagram-entry-border)!important}\n.node.domain rect, .node.domain polygon, .node.domain path, .node.domain circle {fill:var(--diagram-domain)!important;stroke:var(--diagram-domain-border)!important}\n.node.security rect, .node.security polygon, .node.security path, .node.security circle {fill:var(--diagram-security)!important;stroke:var(--diagram-security-border)!important}\n.node.store rect, .node.store polygon, .node.store path, .node.store circle {fill:var(--diagram-store)!important;stroke:var(--diagram-store-border)!important}\n.node.async rect, .node.async polygon, .node.async path, .node.async circle {fill:var(--diagram-async)!important;stroke:var(--diagram-async-border)!important}\n.node.external rect, .node.external polygon, .node.external path, .node.external circle {fill:var(--diagram-external)!important;stroke:var(--diagram-external-border)!important}\n text.actor tspan, .loopText tspan, .labelText tspan, .messageText tspan, .noteText tspan {fill:var(--diagram-text)!important}\n\n"}}%%
flowchart TB
    catalog["catalog<br/><small>Publicação e owner</small>"]:::store
    template["Template Service<br/><small>Modelo no banco do autor</small>"]:::domain
    alias["tenant-aliases<br/><small>Alias global do tenant</small>"]:::store
    cache["Redis · tenant-alias<br/><small>Projeção de leitura do BFF</small>"]:::store
    catalog -->|ownerTenantId / templateId / revisão| template
    alias -->|Projeção, não FK| cache
    classDef domain stroke-width:1.5px;
    classDef store stroke-width:1.5px;
Collection Regras e consultas
catalog Identifica uma publicação por owner, template e revisão. Consulta por visibilidade, nome, tags e owner; agregação agrupa versões e pagina resultados. Alteração de visibilidade pode atingir todas as revisões do mesmo owner/template. GLOBAL, TENANT_SEQUENCE e HIDDEN são visibilidades, não estados de revisão Core
tenant-aliases CRUD de _id, tenantId e alias; consulta global por alias e carga/reconciliação do cache Redis. Alias é único; não há índice único declarado para tenantId

CatalogTemplate é projeção de consulta, não collection. icon usa UUID; templateId usa ObjectId, templateRevision é string e ownerTenantId resolve o banco de origem. Não há cascata Mongo para apagar o template ou o ícone; publicação integra serviços por HTTP.

Collection Índices declarados
catalog uniq_owner_template_revision: {ownerTenantId:1,templateId:1,templateRevision:1}, unique; idx_templateId: {templateId:1}; {templateId:1,templateRevision:1,visibility:1}; idx_visibility, idx_tags, idx_name, todos crescentes
tenant-aliases {alias:1}, unique

DatabaseSetup cria collections/índices no startup. Não há TTL declarado. Timestamps e hasConfigurations são parte dos metadados da publicação; favoritos/aquisição pertencem à composição com Core.

Fontes: setup, índices catálogo, índices alias, consultas, alias.

Dicionário de documentos

Os nomes BSON abaixo respeitam @BsonId/@BsonProperty. A nulabilidade descreve o tipo Java, não uma validação de schema Mongo. Valores iniciais Java precedem os construtores e serviços; os defaults de criação e invariantes estão descritos acima. Referências anuláveis não significam que a API aceite omiti-las em todas as operações. Campos de mapas/documentos livres não possuem schema fechado no modelo.

Propriedades calculadas expostas por getters públicos são identificadas separadamente: fazem parte da superfície do codec POJO, não do estado independente da entidade. @BsonIgnore é respeitado. A representação UUID depende da configuração do codec; os tipos de transporte JSON não substituem os tipos BSON.

Collection / documento raiz Modelo
catalog Catalog
tenant-aliases TenantAlias

catalog — Catalog

Catalog.

Campo BSON Tipo Java / estrutura Representação Nulabilidade / valor inicial
_id ObjectId ObjectId Identificador BSON; tipo e geração conforme o ciclo de criação
templateId ObjectId ObjectId Referência anulável; inicial Java: null
templateRevision String string Referência anulável; inicial Java: null
ownerTenantId String string Referência anulável; inicial Java: null
tenantName String string Referência anulável; inicial Java: null
name String string Referência anulável; inicial Java: null
description String string Referência anulável; inicial Java: null
documentationPath String string Referência anulável; inicial Java: null
releaseNotes String string Referência anulável; inicial Java: null
hasConfigurations boolean boolean Primitivo não nulo; inicial Java: false
tags List<String> array Referência anulável; inicial Java: null
icon UUID UUID (representação do codec) Referência anulável; inicial Java: null
hash String string Referência anulável; inicial Java: null
visibility Visibility enum string Referência anulável; inicial Java: null
publishedAt Instant data/hora Referência anulável; inicial Java: null
publishedBy String string Referência anulável; inicial Java: null
createdAt Instant data/hora Referência anulável; inicial Java: null
updatedAt Instant data/hora Referência anulável; inicial Java: null

Exemplo de estrutura

Fragmento derivado dos campos do modelo vinculado acima, com valores substituídos por identificadores/textos sintéticos e data fixa. Não é um payload de criação nem um documento completo. ObjectId/data usam notação Extended JSON; nenhum dado de ambiente foi copiado.

{
  "_id": {
    "$oid": "000000000000000000000001"
  },
  "templateId": {
    "$oid": "000000000000000000000001"
  },
  "templateRevision": "exemplo-sanitizado",
  "ownerTenantId": "exemplo-id"
}

tenant-aliases — TenantAlias

TenantAlias.

Campo BSON Tipo Java / estrutura Representação Nulabilidade / valor inicial
_id ObjectId ObjectId Identificador BSON; tipo e geração conforme o ciclo de criação
tenantId String string Referência anulável; inicial Java: null
alias String string Referência anulável; inicial Java: null

Exemplo de estrutura

Fragmento derivado dos campos do modelo vinculado acima, com valores substituídos por identificadores/textos sintéticos e data fixa. Não é um payload de criação nem um documento completo. ObjectId/data usam notação Extended JSON; nenhum dado de ambiente foi copiado.

{
  "_id": {
    "$oid": "000000000000000000000001"
  },
  "tenantId": "exemplo-id",
  "alias": "exemplo-sanitizado"
}

Estruturas embutidas, herança e enums

Estes tipos não criam collections próprias. Quando uma entidade raiz aparece dentro de um snapshot, a mesma estrutura é embutida naquele caminho. Tipos de elementos de arrays e valores de mapas estão vinculados nas tabelas.

Visibility

enums/Visibility.java.

Valores: GLOBAL, TENANT_SEQUENCE, HIDDEN.