Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractFilter - Class in org.miaixz.bus.vortex.filter
-
抽象过滤器基类,提供公共方法和模板方法模式 所有具体过滤器继承此类,实现 doFilterInternal 方法
- AbstractFilter() - Constructor for class org.miaixz.bus.vortex.filter.AbstractFilter
- AbstractHandler - Class in org.miaixz.bus.vortex.handler
-
抽象 API 处理类,提供异步拦截器实现的基类 子类可选择性覆盖 Handler 接口的默认实现
- AbstractHandler() - Constructor for class org.miaixz.bus.vortex.handler.AbstractHandler
- AbstractRegistry<T> - Class in org.miaixz.bus.vortex.registry
-
抽象注册类,提供通用的注册表功能,用于管理和存储键值对数据
- AbstractRegistry() - Constructor for class org.miaixz.bus.vortex.registry.AbstractRegistry
- AbstractRegistry.RegistryKey<T> - Interface in org.miaixz.bus.vortex.registry
-
键生成策略接口
- AccessHandler - Class in org.miaixz.bus.vortex.handler
-
用于异步处理 API 请求的前置逻辑
- AccessHandler() - Constructor for class org.miaixz.bus.vortex.handler.AccessHandler
- acquire() - Method in class org.miaixz.bus.vortex.magic.Limiter
-
尝试获取一个令牌,阻塞直到获取成功
- add(String, T) - Method in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
添加键值对到注册表
- add(String, T) - Method in interface org.miaixz.bus.vortex.Registry
-
添加键值对到注册表
- add(T) - Method in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
添加对象到注册表,使用键生成策略生成键
- afterCompletion(ServerWebExchange, Object, Object, Object, Throwable) - Method in class org.miaixz.bus.vortex.handler.AccessHandler
-
异步完成处理方法,执行清理或日志记录
- afterCompletion(ServerWebExchange, Object, Object, Object, Throwable) - Method in interface org.miaixz.bus.vortex.Handler
-
异步完成处理方法,在请求完成后执行(无论成功或失败)
- afterPropertiesSet() - Method in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
Spring 初始化回调,在 bean 属性设置后调用,触发注册表刷新
- amend(String, T) - Method in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
更新注册表中的键值对,先移除后添加
- amend(String, T) - Method in interface org.miaixz.bus.vortex.Registry
-
修改注册表中的键值对
- amend(T) - Method in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
更新注册表中的对象,使用键生成策略生成键
- APP - Enum constant in enum class org.miaixz.bus.vortex.Channel
-
APP 请求,表示通过移动应用程序发起的请求。
- assets - Variable in class org.miaixz.bus.vortex.magic.Principal
-
Contains configuration and information about the resources or "assets" associated with this token.
- Assets - Class in org.miaixz.bus.vortex
-
api definition
- Assets() - Constructor for class org.miaixz.bus.vortex.Assets
- AssetsRegistry - Class in org.miaixz.bus.vortex.registry
-
默认资产注册实现类,基于 AbstractRegistry 提供资产(Assets)的注册、修改和查询功能
- AssetsRegistry() - Constructor for class org.miaixz.bus.vortex.registry.AssetsRegistry
-
构造函数,设置键生成策略
- authorize(Principal) - Method in interface org.miaixz.bus.vortex.provider.AuthorizeProvider
-
执行认证操作,验证授权主体并返回认证结果
- authorize(ServerWebExchange, Context, Assets) - Method in class org.miaixz.bus.vortex.filter.AuthorizeFilter
-
校验令牌(如果资产要求)并将认证结果参数填充到请求参数中
- AuthorizeFilter - Class in org.miaixz.bus.vortex.filter
-
访问鉴权过滤器,负责验证请求的合法性、方法、令牌和应用 ID
- AuthorizeFilter(AuthorizeProvider, AssetsRegistry) - Constructor for class org.miaixz.bus.vortex.filter.AuthorizeFilter
-
构造器,初始化授权提供者和资产注册表
- AuthorizeProvider - Interface in org.miaixz.bus.vortex.provider
-
访问授权认证接口,定义授权认证相关的功能
B
- BINARY - Enum constant in enum class org.miaixz.bus.vortex.Format
-
二进制文件流,表示响应数据以文件流形式输出。
- buildErrorMessage(Throwable, ServerWebExchange) - Method in class org.miaixz.bus.vortex.handler.ErrorsHandler
-
构建错误消息
- bus.vortex - module bus.vortex
-
bus.vortex
C
- channel - Variable in class org.miaixz.bus.vortex.magic.Principal
-
An integer identifier for the source channel of the request.
- Channel - Enum Class in org.miaixz.bus.vortex
-
请求渠道枚举,定义不同的请求来源及其属性。
- CipherFilter - Class in org.miaixz.bus.vortex.filter
-
数据加解密过滤器,负责对请求参数进行解密和对响应数据进行加密处理
- CipherFilter(Config.Decrypt, Config.Encrypt) - Constructor for class org.miaixz.bus.vortex.filter.CipherFilter
-
构造器,初始化加解密配置
- Config - Class in org.miaixz.bus.vortex
-
服务端配置类,用于存储和管理服务器相关的配置信息
- Config() - Constructor for class org.miaixz.bus.vortex.Config
- Config.Decrypt - Class in org.miaixz.bus.vortex
-
解密配置类,定义解密相关参数
- Config.Encrypt - Class in org.miaixz.bus.vortex
-
加密配置类,定义加密相关参数
- Config.Limit - Class in org.miaixz.bus.vortex
-
限流配置类,定义流量限制相关参数
- Config.Security - Class in org.miaixz.bus.vortex
-
安全配置类,定义安全相关参数
- Context - Class in org.miaixz.bus.vortex
-
上下文传参类,用于存储和传递请求相关的上下文信息
- Context() - Constructor for class org.miaixz.bus.vortex.Context
D
- debug(ServerWebExchange, String, String) - Static method in enum class org.miaixz.bus.vortex.Format
-
记录调试级别的日志。
- Decrypt() - Constructor for class org.miaixz.bus.vortex.Config.Decrypt
- Delegate - Class in org.miaixz.bus.vortex.magic
-
认证及委托处理类,用于封装认证结果和 OAuth2 授权信息
- Delegate() - Constructor for class org.miaixz.bus.vortex.magic.Delegate
- DINGTALK - Enum constant in enum class org.miaixz.bus.vortex.Channel
-
钉钉请求,表示通过钉钉平台发起的请求。
- doFilter(ServerWebExchange, WebFilterChain, Context) - Method in class org.miaixz.bus.vortex.filter.AbstractFilter
-
内部过滤方法,由子类实现具体逻辑
- doFilter(ServerWebExchange, WebFilterChain, Context) - Method in class org.miaixz.bus.vortex.filter.AuthorizeFilter
-
内部过滤方法,执行授权验证逻辑
- doFilter(ServerWebExchange, WebFilterChain, Context) - Method in class org.miaixz.bus.vortex.filter.CipherFilter
-
内部过滤方法,执行加解密逻辑
- doFilter(ServerWebExchange, WebFilterChain, Context) - Method in class org.miaixz.bus.vortex.filter.FormatFilter
-
内部过滤方法,执行响应格式化逻辑
- doFilter(ServerWebExchange, WebFilterChain, Context) - Method in class org.miaixz.bus.vortex.filter.LicenseFilter
-
过滤器的核心执行方法。
- doFilter(ServerWebExchange, WebFilterChain, Context) - Method in class org.miaixz.bus.vortex.filter.LimitFilter
-
内部过滤方法,执行限流逻辑
- doFilter(ServerWebExchange, WebFilterChain, Context) - Method in class org.miaixz.bus.vortex.filter.PrimaryFilter
-
过滤器的核心执行方法,负责对请求进行初步安全检查和分发处理。
E
- Encrypt() - Constructor for class org.miaixz.bus.vortex.Config.Encrypt
- equals(Object) - Method in class org.miaixz.bus.vortex.Assets
- error(ServerWebExchange, String, String) - Static method in enum class org.miaixz.bus.vortex.Format
-
记录错误级别的日志。
- ErrorCode - Class in org.miaixz.bus.vortex.magic
-
网关错误码: 116xxx
- ErrorCode() - Constructor for class org.miaixz.bus.vortex.magic.ErrorCode
- ErrorsHandler - Class in org.miaixz.bus.vortex.handler
-
全局异常处理器,处理 Web 应用中的异常并返回标准化的 JSON 响应
- ErrorsHandler() - Constructor for class org.miaixz.bus.vortex.handler.ErrorsHandler
- ErrorsHandler.Message - Class in org.miaixz.bus.vortex.handler
F
- fetchRateLimiter() - Method in class org.miaixz.bus.vortex.magic.Limiter
-
获取令牌桶实例,采用双重检查锁确保线程安全
- filter(ServerWebExchange, WebFilterChain) - Method in class org.miaixz.bus.vortex.filter.AbstractFilter
-
过滤器主逻辑,获取上下文并调用子类的内部过滤方法
- Filter - Interface in org.miaixz.bus.vortex
-
定义一个过滤器接口,扩展 Spring WebFlux 的
WebFilter接口。 - Format - Enum Class in org.miaixz.bus.vortex
-
数据格式枚举,定义支持的响应数据格式及其相关属性,并提供日志记录功能。
- FORMAT - Static variable in class org.miaixz.bus.vortex.Config
-
格式化数据参数名,用于指定响应数据格式
- FormatFilter - Class in org.miaixz.bus.vortex.filter
-
响应格式化过滤器,确保所有响应数据都是JSON格式
- FormatFilter() - Constructor for class org.miaixz.bus.vortex.filter.FormatFilter
G
- get(String) - Static method in enum class org.miaixz.bus.vortex.Channel
-
根据渠道值获取对应的渠道枚举实例。
- get(String) - Method in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
获取指定键对应的值
- get(String) - Method in interface org.miaixz.bus.vortex.Registry
-
获取指定键对应的值
- get(String, String) - Method in class org.miaixz.bus.vortex.registry.AssetsRegistry
-
根据方法名和版本号获取对应的资产
- get(String, String, String) - Method in class org.miaixz.bus.vortex.registry.LimiterRegistry
-
根据 IP、方法名和版本号获取对应的限流配置
- get(ServerRequest) - Static method in class org.miaixz.bus.vortex.Context
-
从 ServerRequest 获取或初始化上下文对象 会自动从请求中提取header信息并设置到headerMap中
- get(ServerWebExchange) - Static method in class org.miaixz.bus.vortex.Context
-
从 ServerWebExchange 获取或初始化上下文对象 会自动从请求中提取header信息并设置到headerMap中
- getAssets(Context) - Method in class org.miaixz.bus.vortex.filter.AbstractFilter
-
获取资产信息
- getContext(ServerWebExchange) - Method in class org.miaixz.bus.vortex.filter.AbstractFilter
-
获取请求上下文
- getOrder() - Method in interface org.miaixz.bus.vortex.Handler
-
获取处理器顺序
- getOriginalAuthority(ServerHttpRequest) - Static method in class org.miaixz.bus.vortex.filter.AbstractFilter
-
从多个渠道安全地获取请求的原始 Authority(主机+端口),专为代理环境设计。
- getOriginalProtocol(ServerHttpRequest) - Static method in class org.miaixz.bus.vortex.filter.AbstractFilter
-
获取请求的原始协议(http 或 https)。
- getRequestMap(Context) - Method in class org.miaixz.bus.vortex.filter.AbstractFilter
-
获取请求参数映射
H
- handle(ServerRequest) - Method in class org.miaixz.bus.vortex.handler.VortexHandler
-
处理客户端请求,执行控制流程并返回响应。
- handle(ServerWebExchange, Throwable) - Method in class org.miaixz.bus.vortex.handler.ErrorsHandler
-
处理异常,生成标准化的错误响应
- Handler - Interface in org.miaixz.bus.vortex
-
异步拦截器接口,定义请求处理的三个阶段
- handleUncheckedException(UncheckedException, ServerWebExchange) - Method in class org.miaixz.bus.vortex.handler.ErrorsHandler
-
处理 InternalException
- handleUnknownException(Throwable, ServerWebExchange) - Method in class org.miaixz.bus.vortex.handler.ErrorsHandler
-
处理未知异常
- handleWebClientException(WebClientException, ServerWebExchange) - Method in class org.miaixz.bus.vortex.handler.ErrorsHandler
-
处理 WebClientException
- hashCode() - Method in class org.miaixz.bus.vortex.Assets
I
- id - Variable in class org.miaixz.bus.vortex.magic.Principal
-
The identifier for the tenant in a multi-tenant architecture.
- info(ServerWebExchange, String, String) - Static method in enum class org.miaixz.bus.vortex.Format
-
记录信息级别的日志。
- init() - Method in class org.miaixz.bus.vortex.filter.CipherFilter
-
初始化方法,在 bean 创建后执行,配置 AES 加解密实例
- init() - Method in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
初始化注册表,子类需实现具体初始化逻辑
- init() - Method in class org.miaixz.bus.vortex.registry.AssetsRegistry
-
初始化注册表,当前实现为空,子类可根据需要扩展
- init() - Method in interface org.miaixz.bus.vortex.Registry
-
初始化注册表,加载初始数据或配置
- init() - Method in class org.miaixz.bus.vortex.registry.LimiterRegistry
-
初始化注册表,当前实现为空,子类可根据需要扩展
- initRateLimiter() - Method in class org.miaixz.bus.vortex.magic.Limiter
-
初始化令牌桶,设置令牌生成速率 使用 synchronized 确保线程安全
- isOk() - Method in class org.miaixz.bus.vortex.magic.Delegate
-
判断认证是否成功
J
- JSON - Enum constant in enum class org.miaixz.bus.vortex.Format
-
JSON 格式,表示响应数据以 JSON 格式输出。
- JsonProvider - Class in org.miaixz.bus.vortex.provider
-
JSON 序列化提供者,实现对象到 JSON 字符串的转换
- JsonProvider() - Constructor for class org.miaixz.bus.vortex.provider.JsonProvider
K
- keys(T) - Method in interface org.miaixz.bus.vortex.registry.AbstractRegistry.RegistryKey
-
根据对象生成键
L
- LicenseFilter - Class in org.miaixz.bus.vortex.filter
-
许可证校验过滤器。
- LicenseFilter(LicenseProvider) - Constructor for class org.miaixz.bus.vortex.filter.LicenseFilter
-
构造器,注入许可证校验提供者。
- LicenseProvider - Interface in org.miaixz.bus.vortex.provider
-
许可证校验提供者接口。
- Limit() - Constructor for class org.miaixz.bus.vortex.Config.Limit
- Limiter - Class in org.miaixz.bus.vortex.magic
-
限流器类,基于令牌桶算法实现请求限流功能
- Limiter() - Constructor for class org.miaixz.bus.vortex.magic.Limiter
- LimiterRegistry - Class in org.miaixz.bus.vortex.registry
-
默认限流注册实现类,基于 AbstractRegistry 提供限流配置(Limiter)的注册和管理功能
- LimiterRegistry() - Constructor for class org.miaixz.bus.vortex.registry.LimiterRegistry
-
构造函数,设置键生成策略
- LimitFilter - Class in org.miaixz.bus.vortex.filter
-
限流过滤器,基于令牌桶算法对请求进行流量限制
- LimitFilter(LimiterRegistry) - Constructor for class org.miaixz.bus.vortex.filter.LimitFilter
-
构造器,初始化限流注册表
M
- Message() - Constructor for class org.miaixz.bus.vortex.handler.ErrorsHandler.Message
- method(ServerWebExchange, Assets) - Method in class org.miaixz.bus.vortex.filter.AuthorizeFilter
-
校验请求的 HTTP 方法是否匹配资产配置
- METHOD - Static variable in class org.miaixz.bus.vortex.Config
-
请求方法参数名,用于标识请求的处理方法
O
- org.miaixz.bus.vortex - package org.miaixz.bus.vortex
-
基于spring webflux 开发的API网关
- org.miaixz.bus.vortex.filter - package org.miaixz.bus.vortex.filter
-
安全规则等过滤
- org.miaixz.bus.vortex.handler - package org.miaixz.bus.vortex.handler
-
权限等相关参数校验
- org.miaixz.bus.vortex.magic - package org.miaixz.bus.vortex.magic
-
基础信息
- org.miaixz.bus.vortex.provider - package org.miaixz.bus.vortex.provider
-
数据输出处理
- org.miaixz.bus.vortex.registry - package org.miaixz.bus.vortex.registry
-
流量及资源匹配
- OTHER - Enum constant in enum class org.miaixz.bus.vortex.Channel
-
其他请求,表示无法归类到特定渠道的请求,作为默认回退值。
P
- PDF - Enum constant in enum class org.miaixz.bus.vortex.Format
-
PDF 格式,表示响应数据以 PDF 格式输出。
- postHandle(ServerWebExchange, Object, Object, Object) - Method in class org.miaixz.bus.vortex.handler.AccessHandler
-
异步后处理方法,处理响应数据
- postHandle(ServerWebExchange, Object, Object, Object) - Method in interface org.miaixz.bus.vortex.Handler
-
异步后处理方法,在请求处理后执行
- preHandle(ServerWebExchange, Object, Object) - Method in class org.miaixz.bus.vortex.handler.AccessHandler
-
异步预处理方法,执行权限验证
- preHandle(ServerWebExchange, Object, Object) - Method in interface org.miaixz.bus.vortex.Handler
-
异步预处理方法,在请求处理前执行
- PrimaryFilter - Class in org.miaixz.bus.vortex.filter
-
核心前置过滤器,作为请求处理链的入口,负责初步的安全校验、参数解析和上下文初始化。
- PrimaryFilter() - Constructor for class org.miaixz.bus.vortex.filter.PrimaryFilter
- Principal - Class in org.miaixz.bus.vortex.magic
-
Represents an authentication token and its associated context.
- Principal() - Constructor for class org.miaixz.bus.vortex.magic.Principal
- Provider - Interface in org.miaixz.bus.vortex
-
数据序列化接口,定义对象序列化为字符串的通用方法
R
- refresh() - Method in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
刷新注册表,清空缓存并重新初始化
- refresh() - Method in interface org.miaixz.bus.vortex.Registry
-
刷新注册表,重新加载数据或清空后初始化
- Registry<T> - Interface in org.miaixz.bus.vortex
-
通用注册表接口,用于管理和操作键值对数据(如路由、限流配置等)
- registryKey - Variable in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
键生成策略
- remove(String) - Method in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
从注册表中移除指定键的记录
- remove(String) - Method in interface org.miaixz.bus.vortex.Registry
-
从注册表中移除指定键的记录
- requestEnd(ServerWebExchange, int) - Static method in enum class org.miaixz.bus.vortex.Format
-
记录请求结束的日志。
- requestStart(ServerWebExchange) - Static method in enum class org.miaixz.bus.vortex.Format
-
记录请求开始的日志。
- route(ServerRequest, Context, Assets) - Method in interface org.miaixz.bus.vortex.Router
-
路由请求到目标服务
- Router - Interface in org.miaixz.bus.vortex
-
调度接口,定义请求路由的基本行为
S
- Security() - Constructor for class org.miaixz.bus.vortex.Config.Security
- serialize(Object) - Method in class org.miaixz.bus.vortex.provider.JsonProvider
-
将对象序列化为 JSON 字符串
- serialize(Object) - Method in interface org.miaixz.bus.vortex.Provider
-
将对象序列化为字符串
- serialize(Object) - Method in class org.miaixz.bus.vortex.provider.XmlProvider
-
将对象序列化为 XML 字符串
- setContentType(ServerWebExchange) - Method in class org.miaixz.bus.vortex.filter.AbstractFilter
-
设置默认 Content-Type(如果请求头缺失)
- setKeyGenerator(AbstractRegistry.RegistryKey<T>) - Method in class org.miaixz.bus.vortex.registry.AbstractRegistry
-
设置键生成策略
- SIGN - Static variable in class org.miaixz.bus.vortex.Config
-
签名信息参数名,用于验证请求签名
T
- trace(ServerWebExchange, String, String) - Static method in enum class org.miaixz.bus.vortex.Format
-
记录跟踪级别的日志。
- type - Variable in class org.miaixz.bus.vortex.magic.Principal
-
类型 1.token 2. apiKey
V
- validate(String) - Method in interface org.miaixz.bus.vortex.provider.LicenseProvider
-
执行许可证验证操作。
- validate(ServerWebExchange) - Method in class org.miaixz.bus.vortex.filter.AbstractFilter
-
校验请求参数,确保必要参数存在且有效
- value - Variable in class org.miaixz.bus.vortex.magic.Principal
-
根据type确定是token还是apiKey
- valueOf(int) - Method in class org.miaixz.bus.vortex.filter.AbstractFilter
-
请求方式转换
- valueOf(String) - Static method in enum class org.miaixz.bus.vortex.Channel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.miaixz.bus.vortex.Format
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.miaixz.bus.vortex.Channel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.miaixz.bus.vortex.Format
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VERSION - Static variable in class org.miaixz.bus.vortex.Config
-
版本信息参数名,用于指定接口版本
- Vortex - Class in org.miaixz.bus.vortex
-
服务端类,负责启动和管理基于 Reactor Netty 的 HTTP 服务器
- Vortex(HttpServer) - Constructor for class org.miaixz.bus.vortex.Vortex
-
构造器,初始化 Athlete 实例
- VortexHandler - Class in org.miaixz.bus.vortex.handler
-
请求处理入口类,负责路由请求并异步调用多个拦截器逻辑。
- VortexHandler(List<Handler>) - Constructor for class org.miaixz.bus.vortex.handler.VortexHandler
-
构造函数,初始化策略映射和拦截器列表。
W
- warn(ServerWebExchange, String, String) - Static method in enum class org.miaixz.bus.vortex.Format
-
记录警告级别的日志。
- WEB - Enum constant in enum class org.miaixz.bus.vortex.Channel
-
WEB 请求,表示通过浏览器或网页发起的请求。
- WECHAT - Enum constant in enum class org.miaixz.bus.vortex.Channel
-
微信请求,表示通过微信平台发起的请求。
X
- X_ACCESS_TOKEN - Static variable in class org.miaixz.bus.vortex.Config
-
授权信息头,存储访问令牌
- X_REMOTE_CHANNEL - Static variable in class org.miaixz.bus.vortex.Config
-
访问来源头,标识请求的渠道来源
- XML - Enum constant in enum class org.miaixz.bus.vortex.Format
-
XML 格式,表示响应数据以 XML 格式输出。
- XmlProvider - Class in org.miaixz.bus.vortex.provider
-
XML 序列化提供者,实现对象到 XML 字符串的转换
- XmlProvider() - Constructor for class org.miaixz.bus.vortex.provider.XmlProvider
_
- _116000 - Static variable in class org.miaixz.bus.vortex.magic.ErrorCode
-
服务未响应
- _116001 - Static variable in class org.miaixz.bus.vortex.magic.ErrorCode
-
角色异常
- _116002 - Static variable in class org.miaixz.bus.vortex.magic.ErrorCode
-
ApiKey无效
- _116003 - Static variable in class org.miaixz.bus.vortex.magic.ErrorCode
-
ApiKey已过期
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form