Rate Limit — configuração de quotas¶

Owner: Rate Limit. Database/collection: MongoCollection<RateLimit> injetada pela biblioteca tenant, sem nome físico de collection declarado na entidade. RateLimit identifica o modelo, não um nome Mongo presumido.

Modelos visuais¶

Rate Limit — identidade¶

Nome físico delegado à biblioteca tenant.

Rate Limit — identidade; 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 LR
    policy["RateLimit<br/><small>Limite e janela configurados</small>"]:::store
    scheduler["Scheduler<br/><small>Atividade de reposição</small>"]:::async
    counter["Redis<br/><small>Contador consumido pelo Checker</small>"]:::store
    policy -->|Criação / alteração por API| scheduler
    scheduler -->|Reposição| counter
    classDef store stroke-width:1.5px;
    classDef async stroke-width:1.5px;

limit, windowSeconds, windowType e editable são configuração. Os valores de WindowType são SLIDING, FIXED, TOKEN_BUCKET, LEAKY_BUCKET; a existência do enum não comprova quatro algoritmos de execução. O contador de consumo fica em Redis e é descrito separadamente.

CRUD por _id, filtro regex de nome, paginação e ordenação permitida. Criação e alteração coordenam a atividade do Scheduler; exclusão verifica vínculos. Na criação idempotente, idempotencyKey opcional determina _id a partir de hash SHA-256 e permite recuperar a criação anterior. Não há índice secondary unique específico para a chave: a identidade determinística usa a unicidade de _id.

Não há TTL nem revisão Mongo de política no código próprio. O fluxo de upgrade cria quotas sem duplicar a identidade entre tentativas; alterações posteriores ainda precisam manter consistência entre Mongo, Scheduler e Redis.

Fontes: modelo, repository, serviços, SchedulerClient.

Na criação HTTP, name é não vazio; limit e windowSeconds são não nulos; windowSeconds deve estar entre 10 e 86400. editable é opcional e inicia em true na criação quando omitido. O serviço define windowType = SLIDING. São regras de RateLimitCreateDTO, construção do modelo e serviço, não um schema validator do MongoDB.

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
`Nome delegado à biblioteca (RateLimit)`	RateLimit

Nome delegado à biblioteca (RateLimit) — RateLimit¶

RateLimit.

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
`name`	String	string	Referência anulável; inicial Java: `null`
`limit`	Integer	int32	Referência anulável; inicial Java: `null`
`windowSeconds`	Integer	int32	Referência anulável; inicial Java: `null`
`windowType`	WindowType	enum string	Referência anulável; inicial Java: `null`
`editable`	Boolean	boolean	Referência anulável; inicial Java: `null`
`idempotencyKey`	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"
  },
  "name": "exemplo-sanitizado",
  "windowType": "SLIDING",
  "idempotencyKey": "exemplo-id"
}

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.

WindowType¶

ratelimit/WindowType.java.

Valores: SLIDING, FIXED, TOKEN_BUCKET, LEAKY_BUCKET.