PluginEnum (shenyu-common XLS-1.0.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<PluginEnum>
- - org.apache.shenyu.common.enums.PluginEnum

所有已实现的接口:

java.io.Serializable, java.lang.Comparable<PluginEnum>
```
public enum PluginEnum
extends java.lang.Enum<PluginEnum>
```
PluginEnum.

枚举常量概要

枚举常量
枚举常量和说明
`BASIC_AUTH` Basic-auth plugin enum.
`BUSI_LOG` BusiLog plugin enum.
`CACHE` the cache plugin enum.
`CAS` CAS plugin enum.
`CASDOOR` Casdoor plugin enum.
`CONTEXT_PATH` Context path plugin enum.
`CRYPTOR_REQUEST` Cryptor request plugin enum.
`CRYPTOR_RESPONSE` Cryptor response plugin enum.
`DIVIDE` Divide plugin enum.
`DUBBO` Dubbo plugin enum.
`GENERAL_CONTEXT` GeneralContext plugin enum.
`GLOBAL` Global plugin enum.
`GRPC` GPRC plugin enum.
`HEADER_DECRYPT_AUTH` HeaderDecryptAuth plugin enum.
`HSF` HSF plugin enum.
`HYSTRIX` Hystrix plugin enum.
`JWT` Jwt plugin enum.
`KEY_AUTH` Key-auth plugin enum.
`LOGGING_ALIYUN_SLS` Logging AliYun sls enums.
`LOGGING_CLICK_HOUSE` Logging ClickHouse plugin enum.
`LOGGING_CONSOLE` Logging console plugin enum.
`LOGGING_ELASTIC_SEARCH` Logging ElasticSearch plugin enum.
`LOGGING_HUAWEI_LTS` Logging Huawei lts enums.
`LOGGING_KAFKA` Logging Kafka plugin enum.
`LOGGING_PULSAR` Logging Pulsar plugin enum.
`LOGGING_RABBITMQ` Logging Rabbitmq plugin enum.
`LOGGING_ROCKETMQ` Logging RocketMQ plugin enum.
`LOGGING_TENCENT_CLS` Logging Tencent cls enums.
`METRICS` Monitor plugin enum.
`MOCK` the mock plugin enum.
`MODIFY_RESPONSE` ModifyResponse plugin enum.
`MOTAN` Motan plugin enum.
`MQTT` Mqtt plugin enum.
`NETTY_HTTP_CLIENT` Netty http client plugin enum.
`OAUTH2` OAuth2 plugin enum.
`OSS_PROXY` OssProxy plugin enum.
`PARAM_MAPPING` Param mapping plugin enum.
`PORTAL_AUTH` Portal auth plugin enum.
`RATE_LIMITER` Rate limiter plugin enum.
`REDIRECT` Redirect plugin enum.
`REQUEST` Request plugin enum.
`RESILIENCE4J` Resilence4J plugin enum.
`RESPONSE` Response plugin enum.
`REWRITE` Rewrite plugin enum.
`RPC_PARAM_TRANSFORM` Param transform plugin enum.
`SENTINEL` Sentinel plugin enum.
`SIGN`
`SOFA` Sofa plugin enum.
`SPRING_CLOUD` springCloud plugin enum.
`TARS` Tars plugin enum.
`TCP` Tcp plugin enum.
`TOKEN_CACHE` TokenCache plugin enum.
`URI` Uri plugin enum.
`WAF` Waf plugin enum.
`WEB_CLIENT` Web client plugin enum.
`WEB_SOCKET` webSocket plugin enum.
`X_SG_AUTH` XsgAuth plugin enum.
`X_SG_SIGN` XsgSign plugin enum.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`int`	`getCode()` get code.
`java.lang.String`	`getName()` get name.
`static PluginEnum`	`getPluginEnumByName(java.lang.String name)` get plugin enum by name.
`int`	`getRole()` get role.
`static java.util.List<java.lang.String>`	`getUpstreamNames()` get upstream plugin names.
`static PluginEnum`	`valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static PluginEnum[]`	`values()` 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

从类继承的方法 java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- 枚举常量详细资料
  - GLOBAL
```
public static final PluginEnum GLOBAL
```
    Global plugin enum.
  - TCP
```
public static final PluginEnum TCP
```
    Tcp plugin enum.
  - MQTT
```
public static final PluginEnum MQTT
```
    Mqtt plugin enum.
  - MOCK
```
public static final PluginEnum MOCK
```
    the mock plugin enum.
  - CACHE
```
public static final PluginEnum CACHE
```
    the cache plugin enum.
  - METRICS
```
public static final PluginEnum METRICS
```
    Monitor plugin enum.
  - SIGN
```
public static final PluginEnum SIGN
```
  - JWT
```
public static final PluginEnum JWT
```
    Jwt plugin enum.
  - TOKEN_CACHE
```
public static final PluginEnum TOKEN_CACHE
```
    TokenCache plugin enum. Validates opaque tokens from Redis for /rest/invoke/** and /rest/zy/** paths. sort=32: after sign(20), before HSF proxy(310), ensures auth before backend call.
  - CAS
```
public static final PluginEnum CAS
```
    CAS plugin enum. Custom plugin: sort=1035 to avoid conflict with official plugins.
  - PORTAL_AUTH
```
public static final PluginEnum PORTAL_AUTH
```
    Portal auth plugin enum. Handles AES body decryption and menu permission checking for portal requests. Custom plugin: sort=1036 to avoid conflict with official plugins.
  - HEADER_DECRYPT_AUTH
```
public static final PluginEnum HEADER_DECRYPT_AUTH
```
    HeaderDecryptAuth plugin enum. Replicates api-gateway /rest/znzs/** auth: AES decrypt header → HSF user lookup → inject X-m* headers. Custom plugin: sort=1037 to avoid conflict with official plugins.
  - X_SG_SIGN
```
public static final PluginEnum X_SG_SIGN
```
    XsgSign plugin enum. Independent x-sg-* Header MD5 signature verification for 能力平台. Matches /rest/exter/** and /rest/ability/** paths. Custom plugin: sort=1038 to avoid conflict with official plugins.
  - X_SG_AUTH
```
public static final PluginEnum X_SG_AUTH
```
    XsgAuth plugin enum. Handles x-sg-login-name header: HSF user lookup + body injection for 能力平台. Runs after sign(20) but before HSF proxy(310) to inject user info into body.
  - BUSI_LOG
```
public static final PluginEnum BUSI_LOG
```
    BusiLog plugin enum. Records call logs and business operation logs for api-gateway migration. Supports both HSF and HTTP modes for log service invocation. Custom plugin: sort=1050 to avoid conflict with official plugins.
  - OSS_PROXY
```
public static final PluginEnum OSS_PROXY
```
    OssProxy plugin enum. Proxies static resource requests to OSS via WebClient non-blocking streaming. Replaces api-gateway PagesController static file proxy. Execution order: 196 (after logging plugins at 195, before DIVIDE at 200). Must run before divide because divide's handleSelectorIfNull returns error instead of continuing the chain, blocking ossProxy from executing.
  - OAUTH2
```
public static final PluginEnum OAUTH2
```
    OAuth2 plugin enum.
  - CASDOOR
```
public static final PluginEnum CASDOOR
```
    Casdoor plugin enum.
  - WAF
```
public static final PluginEnum WAF
```
    Waf plugin enum.
  - RATE_LIMITER
```
public static final PluginEnum RATE_LIMITER
```
    Rate limiter plugin enum.
  - PARAM_MAPPING
```
public static final PluginEnum PARAM_MAPPING
```
    Param mapping plugin enum.
  - CONTEXT_PATH
```
public static final PluginEnum CONTEXT_PATH
```
    Context path plugin enum.
  - REWRITE
```
public static final PluginEnum REWRITE
```
    Rewrite plugin enum.
  - CRYPTOR_REQUEST
```
public static final PluginEnum CRYPTOR_REQUEST
```
    Cryptor request plugin enum.
  - REDIRECT
```
public static final PluginEnum REDIRECT
```
    Redirect plugin enum.
  - REQUEST
```
public static final PluginEnum REQUEST
```
    Request plugin enum.
  - GENERAL_CONTEXT
```
public static final PluginEnum GENERAL_CONTEXT
```
    GeneralContext plugin enum.
  - HYSTRIX
```
public static final PluginEnum HYSTRIX
```
    Hystrix plugin enum.
  - SENTINEL
```
public static final PluginEnum SENTINEL
```
    Sentinel plugin enum.
  - RESILIENCE4J
```
public static final PluginEnum RESILIENCE4J
```
    Resilence4J plugin enum.
  - LOGGING_CONSOLE
```
public static final PluginEnum LOGGING_CONSOLE
```
    Logging console plugin enum.
  - LOGGING_ROCKETMQ
```
public static final PluginEnum LOGGING_ROCKETMQ
```
    Logging RocketMQ plugin enum.
  - LOGGING_RABBITMQ
```
public static final PluginEnum LOGGING_RABBITMQ
```
    Logging Rabbitmq plugin enum.
  - LOGGING_ALIYUN_SLS
```
public static final PluginEnum LOGGING_ALIYUN_SLS
```
    Logging AliYun sls enums.
  - LOGGING_TENCENT_CLS
```
public static final PluginEnum LOGGING_TENCENT_CLS
```
    Logging Tencent cls enums.
  - LOGGING_HUAWEI_LTS
```
public static final PluginEnum LOGGING_HUAWEI_LTS
```
    Logging Huawei lts enums.
  - LOGGING_KAFKA
```
public static final PluginEnum LOGGING_KAFKA
```
    Logging Kafka plugin enum.
  - LOGGING_PULSAR
```
public static final PluginEnum LOGGING_PULSAR
```
    Logging Pulsar plugin enum.
  - LOGGING_ELASTIC_SEARCH
```
public static final PluginEnum LOGGING_ELASTIC_SEARCH
```
    Logging ElasticSearch plugin enum.
  - LOGGING_CLICK_HOUSE
```
public static final PluginEnum LOGGING_CLICK_HOUSE
```
    Logging ClickHouse plugin enum.
  - DIVIDE
```
public static final PluginEnum DIVIDE
```
    Divide plugin enum.
  - SPRING_CLOUD
```
public static final PluginEnum SPRING_CLOUD
```
    springCloud plugin enum.
  - WEB_SOCKET
```
public static final PluginEnum WEB_SOCKET
```
    webSocket plugin enum.
  - URI
```
public static final PluginEnum URI
```
    Uri plugin enum.
  - WEB_CLIENT
```
public static final PluginEnum WEB_CLIENT
```
    Web client plugin enum.
  - NETTY_HTTP_CLIENT
```
public static final PluginEnum NETTY_HTTP_CLIENT
```
    Netty http client plugin enum.
  - MODIFY_RESPONSE
```
public static final PluginEnum MODIFY_RESPONSE
```
    ModifyResponse plugin enum.
  - RPC_PARAM_TRANSFORM
```
public static final PluginEnum RPC_PARAM_TRANSFORM
```
    Param transform plugin enum.
  - DUBBO
```
public static final PluginEnum DUBBO
```
    Dubbo plugin enum.
  - SOFA
```
public static final PluginEnum SOFA
```
    Sofa plugin enum.
  - TARS
```
public static final PluginEnum TARS
```
    Tars plugin enum.
  - GRPC
```
public static final PluginEnum GRPC
```
    GPRC plugin enum.
  - MOTAN
```
public static final PluginEnum MOTAN
```
    Motan plugin enum.
  - HSF
```
public static final PluginEnum HSF
```
    HSF plugin enum.
  - CRYPTOR_RESPONSE
```
public static final PluginEnum CRYPTOR_RESPONSE
```
    Cryptor response plugin enum.
  - RESPONSE
```
public static final PluginEnum RESPONSE
```
    Response plugin enum.
  - KEY_AUTH
```
public static final PluginEnum KEY_AUTH
```
    Key-auth plugin enum.
  - BASIC_AUTH
```
public static final PluginEnum BASIC_AUTH
```
    Basic-auth plugin enum.
- 方法详细资料
  - values
```
public static PluginEnum[] values()
```
    按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。该方法可用于迭代常量, 如下所示:
```
for (PluginEnum c : PluginEnum.values())
    System.out.println(c);
```
    返回:
    
    按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
  - valueOf
```
public static PluginEnum valueOf(java.lang.String name)
```
    返回带有指定名称的该类型的枚举常量。字符串必须与用于声明该类型的枚举常量的标识符完全匹配。(不允许有多余的空格字符。)
    
    参数:
    
    name - 要返回的枚举常量的名称。
    
    返回:
    
    返回带有指定名称的枚举常量
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量
    
    java.lang.NullPointerException - 如果参数为空值
  - getCode
```
public int getCode()
```
    get code.
    
    返回:
    
    code code
  - getRole
```
public int getRole()
```
    get role.
    
    返回:
    
    role role
  - getName
```
public java.lang.String getName()
```
    get name.
    
    返回:
    
    name name
  - getPluginEnumByName
```
public static PluginEnum getPluginEnumByName(java.lang.String name)
```
    get plugin enum by name.
    
    参数:
    
    name - plugin name.
    
    返回:
    
    plugin enum.
  - getUpstreamNames
```
public static java.util.List<java.lang.String> getUpstreamNames()
```
    get upstream plugin names.
    
    返回:
    
    List string

枚举 PluginEnum

枚举常量概要

方法概要

从类继承的方法 java.lang.Enum

从类继承的方法 java.lang.Object

枚举常量详细资料

GLOBAL

TCP

MQTT

MOCK

CACHE

METRICS

SIGN

JWT

TOKEN_CACHE

CAS

PORTAL_AUTH

HEADER_DECRYPT_AUTH

X_SG_SIGN

X_SG_AUTH

BUSI_LOG

OSS_PROXY

OAUTH2

CASDOOR

WAF

RATE_LIMITER

PARAM_MAPPING

CONTEXT_PATH

REWRITE

CRYPTOR_REQUEST

REDIRECT

REQUEST

GENERAL_CONTEXT

HYSTRIX

SENTINEL

RESILIENCE4J

LOGGING_CONSOLE

LOGGING_ROCKETMQ

LOGGING_RABBITMQ

LOGGING_ALIYUN_SLS

LOGGING_TENCENT_CLS

LOGGING_HUAWEI_LTS

LOGGING_KAFKA

LOGGING_PULSAR

LOGGING_ELASTIC_SEARCH

LOGGING_CLICK_HOUSE

DIVIDE

SPRING_CLOUD

WEB_SOCKET

URI

WEB_CLIENT

NETTY_HTTP_CLIENT

MODIFY_RESPONSE

RPC_PARAM_TRANSFORM

DUBBO

SOFA

TARS

GRPC

MOTAN

HSF

CRYPTOR_RESPONSE

RESPONSE

KEY_AUTH

BASIC_AUTH

方法详细资料

values

valueOf

getCode

getRole

getName

getPluginEnumByName

getUpstreamNames