PluginEnum (shenyu-common 2.6.1 API)

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

All Implemented Interfaces:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BASIC_AUTH` Basic-auth plugin enum.
`CACHE` the cache 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.
`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.
`PARAM_MAPPING` Param mapping 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` Sign plugin enum.
`SOFA` Sofa plugin enum.
`SPRING_CLOUD` springCloud plugin enum.
`TARS` Tars plugin enum.
`TCP` Tcp plugin enum.
`URI` Uri plugin enum.
`WAF` Waf plugin enum.
`WEB_CLIENT` Web client plugin enum.
`WEB_SOCKET` webSocket plugin enum.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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)` Returns the enum constant of this type with the specified name.
`static PluginEnum[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - 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
```
    Sign plugin enum.
  - JWT
```
public static final PluginEnum JWT
```
    Jwt plugin enum.
  - 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.
  - 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.
- Method Detail
  - values
```
public static PluginEnum[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (PluginEnum c : PluginEnum.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PluginEnum valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getCode
```
public int getCode()
```
    get code.
    
    Returns:
    
    code code
  - getRole
```
public int getRole()
```
    get role.
    
    Returns:
    
    role role
  - getName
```
public java.lang.String getName()
```
    get name.
    
    Returns:
    
    name name
  - getPluginEnumByName
```
public static PluginEnum getPluginEnumByName(java.lang.String name)
```
    get plugin enum by name.
    
    Parameters:
    
    name - plugin name.
    
    Returns:
    
    plugin enum.
  - getUpstreamNames
```
public static java.util.List<java.lang.String> getUpstreamNames()
```
    get upstream plugin names.
    
    Returns:
    
    List string

Enum PluginEnum

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

GLOBAL

TCP

MQTT

MOCK

CACHE

METRICS

SIGN

JWT

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

CRYPTOR_RESPONSE

RESPONSE

KEY_AUTH

BASIC_AUTH

Method Detail

values

valueOf

getCode

getRole

getName

getPluginEnumByName

getUpstreamNames