Serialized Form

  • Package org.apache.dubbo.common

  • Package org.apache.dubbo.common.beans

  • Package org.apache.dubbo.common.beanutil

  • Package org.apache.dubbo.common.bytecode

  • Package org.apache.dubbo.common.concurrent

  • Package org.apache.dubbo.common.config.configcenter

  • Package org.apache.dubbo.common.threadpool

  • Package org.apache.dubbo.common.threadpool.support.eager

  • Package org.apache.dubbo.common.url.component

  • Package org.apache.dubbo.common.utils

  • Package org.apache.dubbo.config

    • Class org.apache.dubbo.config.AbstractConfig

      class AbstractConfig extends Object implements Serializable
      serialVersionUID:
      4267533505537413570L

      • Serialized Fields

        • id
          String id
          Identifier for this configuration.
        • isDefault
          Boolean isDefault
          Indicates if this is the default configuration (true for default).
        • refreshed
          AtomicBoolean refreshed
          Indicates whether the configuration has been refreshed (true if refreshed).

    • Class org.apache.dubbo.config.AbstractInterfaceConfig

      class AbstractInterfaceConfig extends AbstractMethodConfig implements Serializable
      serialVersionUID:
      -1559314110797223229L

      • Serialized Fields

        • application
          ApplicationConfig application
          Application configuration for the service.
        • auth
          Boolean auth
          Enable service authentication.
        • authenticator
          String authenticator
          Authenticator for authentication
        • callbacks
          Integer callbacks
          Callback limits for the service.
        • cluster
          String cluster
          Cluster type for service.
        • configCenter
          ConfigCenterConfig configCenter
          Configuration center settings.
        • connections
          Integer connections
          Connection limits: 0 for shared connection, otherwise specifying connections for the service.
        • filter
          String filter
          Filters for service exposure or reference (multiple filters can be separated by commas).
        • group
          String group
          Group of the remote service referenced by the consumer/provider.
        • interfaceName
          String interfaceName
          Interface name of the exported service.
        • layer
          String layer
          Layer of service providers.
        • listener
          String listener
          Listeners for service exposure or reference (multiple listeners can be separated by commas).
        • local
          String local
          Local implementation class name for the service interface.
        • metadataReportConfig
          MetadataReportConfig metadataReportConfig
          Metadata report configuration.
        • methods
          List<MethodConfig> methods
          Method-specific configuration.
        • module
          ModuleConfig module
          Module configuration for the service.
        • monitor
          MonitorConfig monitor
          Service monitoring configuration.
        • onconnect
          String onconnect
          Event handler for connection establishment.
        • ondisconnect
          String ondisconnect
          Event handler for disconnection.
        • owner
          String owner
          Owner of the service providers.
        • password
          String password
          Password for basic authenticator
        • proxy
          String proxy
          Strategy for generating dynamic agents (options: "jdk" or "javassist").
        • registries
          List<RegistryConfig> registries
          Registries where the service will be registered (use this or registryIds, not both).
        • registryIds
          String registryIds
          Registry IDs for service registration (use this or registries, not both).
        • scope
          String scope
          Service scope ("local" implies searching in the current JVM only).
        • serviceMetadata
          ServiceMetadata serviceMetadata
          Service metadata configuration.
        • singleton
          Boolean singleton
          Use separate instances for services with the same serviceKey (applies when using ReferenceConfig and SimpleReferenceCache together). Directly calling ReferenceConfig.get() will not check this attribute.
        • stub
          String stub
          Local stub class name for the service interface.
        • tag
          String tag
          Custom tag for the service configuration.
        • username
          String username
          Username for basic authenticator
        • version
          String version
          Version of the remote service referenced by the consumer/provider.

    • Class org.apache.dubbo.config.AbstractMethodConfig

      class AbstractMethodConfig extends AbstractConfig implements Serializable
      serialVersionUID:
      5809761483000878437L

      • Serialized Fields

        • actives
          Integer actives
          Maximum concurrent invocations allowed.
        • async
          Boolean async
          Enable asynchronous invocation. Note that it is unreliable asynchronous, ignoring return values and not blocking threads.
        • cache
          String cache
          Cache provider for caching return results. available options: lru, threadlocal, jcache etc.
        • forks
          Integer forks
          Forks for forking cluster.
        • loadbalance
          String loadbalance
          Load balancing strategy for service invocation.
        • merger
          String merger
          Merger for result data.
        • mock
          String mock
          Mock class name to be called when a service fails to execute. The mock doesn't support on the provider side, and it is executed when a non-business exception occurs after a remote service call.
        • parameters
          Map<String,String> parameters
          Customized parameters for configuration.
        • retries
          Integer retries
          Retry times for failed invocations.
        • sent
          Boolean sent
          Acknowledge asynchronous-sent invocations.
        • timeout
          Integer timeout
          Timeout for remote invocation in milliseconds.
        • validation
          String validation
          Enable JSR303 standard annotation validation for method parameters.

    • Class org.apache.dubbo.config.AbstractReferenceConfig

      class AbstractReferenceConfig extends AbstractInterfaceConfig implements Serializable
      serialVersionUID:
      -2786526984373031126L

      • Serialized Fields

        • check
          Boolean check
          Check if service provider exists, if not exists, it will be fast fail
        • client
          String client
          client type
        • generic
          String generic
          Whether to use generic interface
        • init
          Boolean init
          Whether to eagle-init
        • injvm
          Boolean injvm
          Whether to find reference's instance from the current JVM
        • lazy
          Boolean lazy
          Lazy create connection
        • protocol
          String protocol
          Only the service provider of the specified protocol is invoked, and other protocols are ignored.
        • providedBy
          String providedBy
          declares which app or service this interface belongs to
        • providerNamespace
          String providerNamespace
          assign the namespace that provider belong to
          Since:
          3.1.1
        • providerPort
          Integer providerPort
          By VirtualService and DestinationRule, envoy will generate a new route rule,such as 'demo.default.svc.cluster.local:80',the default port is 80. When you want to specify the provider port,you can use this config.
          Since:
          3.1.0
        • reconnect
          String reconnect
        • referAsync
          Boolean referAsync
          Deprecated.
          Weather the reference is referred asynchronously
          See Also:
          • ModuleConfig.referAsync
        • router
          String router
        • sticky
          Boolean sticky
        • stubevent
          Boolean stubevent
          Whether to support event in stub.

    • Class org.apache.dubbo.config.AbstractServiceConfig

      class AbstractServiceConfig extends AbstractInterfaceConfig implements Serializable
      serialVersionUID:
      -9026290350363878309L

      • Serialized Fields

        • accesslog
          String accesslog
          Whether to export access logs to logs.
        • delay
          Integer delay
          The time delay to register the service (in milliseconds).
        • deprecated
          Boolean deprecated
          Whether the service is deprecated.
        • document
          String document
          Document center for the service.
        • dynamic
          Boolean dynamic
          Whether to register the service as a dynamic service on the registry. If true, the service will be enabled automatically after registration, and manual disabling is required to stop it.
        • executes
          Integer executes
          Max allowed executing times.
        • executor
          Executor executor
          used for thread pool isolation between services
        • export
          Boolean export
          Whether to export the service.
        • exportAsync
          Boolean exportAsync
          Deprecated.
          Weather the service is export asynchronously
          See Also:
          • ModuleConfig.exportAsync
        • group
          String group
          The service group.
        • payload
          Integer payload
          Payload max length.
        • preferSerialization
          String preferSerialization
          Specifies the preferred serialization method for the consumer. If specified, the consumer will use this parameter first. If the Dubbo Sdk you are using contains the serialization type, the serialization method specified by the argument is used.

          When this parameter is null or the serialization type specified by this parameter does not exist in the Dubbo SDK, the serialization type specified by serialization is used. If the Dubbo SDK if still does not exist, the default type of the Dubbo SDK is used. For Dubbo SDK >= 3.2, preferSerialization takes precedence over serialization

          Supports multiple values separated by commas, e.g., "fastjson2,fastjson,hessian2".

        • protocolIds
          String protocolIds
          Id list of protocols the service will export with (use this or protocols, not both).
        • protocols
          List<ProtocolConfig> protocols
          List of protocols the service will export with (use this or protocolIds, not both).
        • register
          Boolean register
          Whether to register the service.
        • serialization
          String serialization
          Serialization type for service communication.
        • token
          String token
          Whether to use a token for authentication.
        • useJavaPackageAsPath
          Boolean useJavaPackageAsPath
          Whether to use java_package in IDL as path. Default use package. This param only available when service using native stub.
        • version
          String version
          The service version.
        • warmup
          Integer warmup
          Warm-up period for the service.
        • weight
          Integer weight
          The service weight.

    • Class org.apache.dubbo.config.ApplicationConfig

      class ApplicationConfig extends AbstractConfig implements Serializable
      serialVersionUID:
      5508512956753757169L

      • Serialized Fields

        • architecture
          String architecture
          Architecture layer.
        • autoTrustSerializeClass
          Boolean autoTrustSerializeClass
          Whether to automatically trust serialized classes.
        • checkSerializable
          Boolean checkSerializable
          Whether to check serializable.
        • compiler
          String compiler
          Java compiler.
        • dumpDirectory
          String dumpDirectory
          Directory for saving thread dump.
        • dumpEnable
          Boolean dumpEnable
          Whether to enable saving thread dump or not.
        • enableEmptyProtection
          Boolean enableEmptyProtection
          Whether to enable protection against empty objects.
        • enableFileCache
          Boolean enableFileCache
          Whether to enable file caching.
        • environment
          String environment
          Environment, e.g., dev, test, or production.
        • executorManagementMode
          String executorManagementMode
          Thread pool management mode: 'default' or 'isolation'.
        • hostname
          String hostname
          Hostname.
        • livenessProbe
          String livenessProbe
          Used to set extensions of the probe in QoS.
        • logger
          String logger
          The type of log access.
        • mappingRetryInterval
          Integer mappingRetryInterval
          The retry interval of service name mapping.
        • metadataServicePort
          Integer metadataServicePort
          Metadata Service, used in Service Discovery.
        • metadataServiceProtocol
          String metadataServiceProtocol
          The protocol used for peer-to-peer metadata transmission.
        • metadataType
          String metadataType
          Metadata type, local or remote. If 'remote' is chosen, you need to specify a metadata center further.
        • monitor
          MonitorConfig monitor
          Monitor center.
        • name
          String name
          The Application name.
        • onlyUseMetadataV2
          Boolean onlyUseMetadataV2
          Only use the new version of metadataService (MetadataServiceV2).
          MetadataServiceV2 have better compatibility with other language's dubbo implement (dubbo-go).
          If set to false (default):
          1. If your services are using triple protocol and ApplicationConfig.metadataServiceProtocol is not set
          - Dubbo will export both MetadataService and MetadataServiceV2 with triple
          2. Set ApplicationConfig.metadataServiceProtocol = tri
          - Dubbo will export both MetadataService and MetadataServiceV2 with triple
          3. Set ApplicationConfig.metadataServiceProtocol != tri
          - Dubbo will only export MetadataService
          4. Your services are not using triple protocol, and ApplicationConfig.metadataServiceProtocol is not set
          - Dubbo will only export MetadataService

          If set to true, dubbo will try to only use MetadataServiceV2.
          It only activates when meet at least one of the following cases:
          1. Manually set ApplicationConfig.metadataServiceProtocol = tri
          2. Your services are using triple protocol
        • organization
          String organization
          The application's organization (BU).
        • owner
          String owner
          The application owner.
        • parameters
          Map<String,String> parameters
          Customized parameters.
        • protocol
          String protocol
          The preferred protocol (name) of this application, convenient for places where it's hard to determine the preferred protocol.
        • qosAcceptForeignIp
          Boolean qosAcceptForeignIp
          Should we accept foreign IP or not?
        • qosAcceptForeignIpWhitelist
          String qosAcceptForeignIpWhitelist
          When we disable accepting foreign IP, support specifying foreign IPs in the whitelist.
        • qosAnonymousAccessPermissionLevel
          String qosAnonymousAccessPermissionLevel
          The anonymous (any foreign IP) access permission level, default is NONE, which means no access to any command.
        • qosAnonymousAllowCommands
          String qosAnonymousAllowCommands
          The anonymous (any foreign IP) allowed commands, default is empty, which means no access to any command.
        • qosCheck
          Boolean qosCheck
          Whether QoS should start successfully or not, will check qosEnable first.
        • qosEnable
          Boolean qosEnable
          Whether to enable Quality of Service (QoS) or not.
        • qosHost
          String qosHost
          The QoS host to listen.
        • qosPort
          Integer qosPort
          The QoS port to listen.
        • readinessProbe
          String readinessProbe
          The probe for checking the readiness of the application.
        • registerConsumer
          Boolean registerConsumer
          Used to control whether to register the instance with the registry or not. Set to 'false' only when the instance is a pure consumer.
        • registerMode
          String registerMode
          Register mode.
        • registries
          List<RegistryConfig> registries
          Registry centers.
        • registryIds
          String registryIds
          The comma-separated list of registry IDs to which the service will be registered.
        • repository
          String repository
          Repository.
        • serializeCheckStatus
          String serializeCheckStatus
          The status of class serialization checking.
        • shutwait
          String shutwait
          Config the shutdown wait.
        • startupProbe
          String startupProbe
          The probe for checking the startup of the application.
        • trustSerializeClassLevel
          Integer trustSerializeClassLevel
          The trust level for serialized classes.
        • version
          String version
          The application version.

    • Class org.apache.dubbo.config.ArgumentConfig

      class ArgumentConfig extends Object implements Serializable
      serialVersionUID:
      -2165482463925213595L

      • Serialized Fields

        • callback
          Boolean callback
          Whether the argument is the callback interface
        • index
          Integer index
          The argument index: index -1 represents not set
        • type
          String type
          Argument type

    • Class org.apache.dubbo.config.ConfigCenterConfig

      class ConfigCenterConfig extends AbstractConfig implements Serializable

      • Serialized Fields

        • address
          String address
          The address (URL or hostname) of the config center server.
        • appConfigFile
          String appConfigFile
          The properties file under 'configFile' is global shared, while '.properties' under this one is limited only to this application.
        • appExternalConfiguration
          Map<String,String> appExternalConfiguration
          Application-specific external configuration for the config center.
        • check
          Boolean check
          Behavior when the initial connection attempt to the config center fails. 'true' means interrupt the whole process once a failure occurs. Default value is true.
        • cluster
          String cluster
          The config center cluster, its actual meaning may vary depending on the specific config center product.
        • configFile
          String configFile
          Key mapping for properties files. Most of the time, you do not need to change this parameter. Default value is CommonConstants.DEFAULT_DUBBO_PROPERTIES.
        • externalConfiguration
          Map<String,String> externalConfiguration
          External configuration for the config center.
        • group
          String group
          The group of the config center, often used to identify an isolated space for a batch of config items. Its actual meaning depends on the specific config center you use. Default value is CommonConstants.DUBBO.
        • highestPriority
          Boolean highestPriority
          If the config center should have the highest priority and override all other configurations. Deprecated and no longer used. Default value is true.
        • initialized
          AtomicBoolean initialized
        • namespace
          String namespace
          The namespace of the config center, generally used for multi-tenancy. Its actual meaning depends on the specific config center you use. Default value is CommonConstants.DUBBO.
        • parameters
          Map<String,String> parameters
          Additional parameters specific to your config center product can be added here. For example, with XML: invalid input: '<'dubbo:config-center> invalid input: '<'dubbo:parameter key="{your key}" value="{your value}" /> invalid input: '<'/dubbo:config-center>
        • password
          String password
          Password for authentication with the config center.
        • port
          Integer port
          The port number for the config center server.
        • protocol
          String protocol
          The protocol used for accessing the config center.
        • timeout
          Long timeout
          The timeout for accessing the config center. Default value is 30000L.
        • username
          String username
          Username for authentication with the config center.

    • Class org.apache.dubbo.config.ConsumerConfig

      class ConsumerConfig extends AbstractReferenceConfig implements Serializable
      serialVersionUID:
      2827274711143680600L

      • Serialized Fields

        • corethreads
          Integer corethreads
          Consumer threadpool core thread size
        • meshEnable
          Boolean meshEnable
          enable mesh mode
          Since:
          3.1.0
        • queues
          Integer queues
          Consumer threadpool queue size
        • referBackground
          Boolean referBackground
          Deprecated.
          replace with ModuleConfig.setBackground(Boolean)
          Whether refer should run in background or not.
          See Also:
        • referThreadNum
          Integer referThreadNum
          Thread num for asynchronous refer pool size
        • shareconnections
          Integer shareconnections
          By default, a TCP long-connection communication is shared between the consumer process and the provider process. This property can be set to share multiple TCP long-connection communications. Note that only the dubbo protocol takes effect.
        • threadpool
          String threadpool
          Consumer thread pool type: cached, fixed, limit, eager
        • threads
          Integer threads
          Consumer threadpool thread size
        • urlMergeProcessor
          String urlMergeProcessor
          Url Merge Processor Used to customize the URL merge of consumer and provider

    • Class org.apache.dubbo.config.MetadataReportConfig

      class MetadataReportConfig extends AbstractConfig implements Serializable
      serialVersionUID:
      55233L

      • Serialized Fields

        • address
          String address
          The address of the metadata center.
        • check
          Boolean check
          Decide the behavior when the initial connection attempt fails, where 'true' means interrupt the whole process once it fails. The default value is true.
        • cluster
          Boolean cluster
          Whether to use a cluster configuration for the metadata center.
        • cycleReport
          Boolean cycleReport
          By default, the metadata store will store full metadata repeatedly every day.
        • file
          String file
          The file path for saving the metadata center's dynamic list.
        • group
          String group
          The group for the metadata center, which is similar to the registry group.
        • parameters
          Map<String,String> parameters
          Customized parameters for the metadata center.
        • password
          String password
          The password used to log in to the metadata center.
        • port
          Integer port
          The default port for the metadata center.
        • protocol
          String protocol
          The protocol for the metadata center.
        • registry
          String registry
          The registry ID for the metadata center.
        • reportDefinition
          Boolean reportDefinition
          Whether to report definition.
        • reportMetadata
          Boolean reportMetadata
          Whether to report metadata.
        • retryPeriod
          Integer retryPeriod
          The retry period in milliseconds when connecting to the metadata center.
        • retryTimes
          Integer retryTimes
          The number of retry times when connecting to the metadata center.
        • syncReport
          Boolean syncReport
          Synchronization report, with the default value as asynchronous.
        • timeout
          Integer timeout
          The request timeout in milliseconds for the metadata center.
        • username
          String username
          The username used to log in to the metadata center.

    • Class org.apache.dubbo.config.MethodConfig

      class MethodConfig extends AbstractMethodConfig implements Serializable
      serialVersionUID:
      884908855422675941L

      • Serialized Fields

        • arguments
          List<ArgumentConfig> arguments
          The method arguments
        • deprecated
          Boolean deprecated
          If it's deprecated
        • executes
          Integer executes
          Thread limits for method invocations
        • isReturn
          Boolean isReturn
          Whether you need to return
        • name
          String name
          The method name
        • oninvoke
          Object oninvoke
          Callback instance when async-call is invoked
        • oninvokeMethod
          String oninvokeMethod
          Callback method when async-call is invoked
        • onreturn
          Object onreturn
          Callback instance when async-call is returned
        • onreturnMethod
          String onreturnMethod
          Callback method when async-call is returned
        • onthrow
          Object onthrow
          Callback instance when async-call has exception thrown
        • onthrowMethod
          String onthrowMethod
          Callback method when async-call has exception thrown
        • parentPrefix
          String parentPrefix
          The preferred prefix of parent
        • reliable
          Boolean reliable
          If it's reliable
        • retry
          Boolean retry
          Whether to retry
        • service
          String service
          TODO remove service and serviceId These properties come from MethodConfig's parent Config module, they will neither be collected directly from xml or API nor be delivered to url
        • serviceId
          String serviceId
        • stat
          Integer stat
          Stat
        • sticky
          Boolean sticky
          Whether to enable sticky

    • Class org.apache.dubbo.config.MetricsConfig

      class MetricsConfig extends AbstractConfig implements Serializable
      serialVersionUID:
      -9089919311611546383L

      • Serialized Fields

        • aggregation
          AggregationConfig aggregation
          Configuration for metrics aggregation.
        • collectorSyncPeriod
          Integer collectorSyncPeriod
          Collector synchronization period.
        • enableCollectorSync
          Boolean enableCollectorSync
          Whether to enable collector synchronization.
        • enableJvm
          Boolean enableJvm
          Whether to enable JVM metrics collection.
        • enableMetadata
          Boolean enableMetadata
          Whether to enable metadata metrics collection.
        • enableMetricsInit
          Boolean enableMetricsInit
          Whether to enable metrics initialization.
        • enableNetty
          Boolean enableNetty
          Whether to enable Netty metrics collection.
        • enableRegistry
          Boolean enableRegistry
          Whether to enable registry metrics collection.
        • enableRpc
          Boolean enableRpc
          Whether to enable RPC (Remote Procedure Call) metrics collection.
        • enableThreadpool
          Boolean enableThreadpool
          Whether to enable thread pool metrics collection.
        • exportMetricsService
          Boolean exportMetricsService
          Whether to export metrics service.
        • exportServicePort
          Integer exportServicePort
          Port used for exporting metrics services.
        • exportServiceProtocol
          String exportServiceProtocol
          Protocol used for metrics collection and export.
        • histogram
          HistogramConfig histogram
          Configuration for metrics histogram.
        • prometheus
          PrometheusConfig prometheus
          Configuration for Prometheus metrics collection.
        • protocol
          String protocol
          Protocol used for metrics.
        • rpcLevel
          String rpcLevel
          The level of metrics collection, which can be "SERVICE" or "METHOD". The default is "METHOD".
        • useGlobalRegistry
          Boolean useGlobalRegistry
          Decide whether to use the global registry of Micrometer.

    • Class org.apache.dubbo.config.ModuleConfig

      class ModuleConfig extends AbstractConfig implements Serializable
      serialVersionUID:
      5508512956753757169L

      • Serialized Fields

        • background
          Boolean background
          Whether to start the module in the background. If started in the background, it does not await finish on Spring ContextRefreshedEvent.
          See Also:
          • invalid reference 
            org.apache.dubbo.config.spring.context.DubboDeployApplicationListener
        • checkReferenceTimeout
          Long checkReferenceTimeout
          The timeout to check references.
        • exportAsync
          Boolean exportAsync
          Whether the service is exported asynchronously.
        • exportThreadNum
          Integer exportThreadNum
          The thread number for asynchronous export pool size.
        • monitor
          MonitorConfig monitor
          Monitor center
        • name
          String name
          The module name
        • organization
          String organization
          The module's organization
        • owner
          String owner
          The module owner
        • referAsync
          Boolean referAsync
          Whether the reference is referred asynchronously.
        • referThreadNum
          Integer referThreadNum
          The thread number for asynchronous reference pool size.
        • registries
          List<RegistryConfig> registries
          Registry centers
        • version
          String version
          The module version

    • Class org.apache.dubbo.config.MonitorConfig

      class MonitorConfig extends AbstractConfig implements Serializable
      serialVersionUID:
      -1184681514659198203L

      • Serialized Fields

        • address
          String address
          The monitor address
        • group
          String group
          The monitor group
        • interval
          String interval
          The monitor reporting interval
        • parameters
          Map<String,String> parameters
          Customized parameters
        • password
          String password
          The monitor password
        • protocol
          String protocol
          The protocol of the monitor. If the value is "registry" it will search the monitor address from the registry center. Otherwise, it will directly connect to the monitor center.
        • username
          String username
          The monitor username
        • version
          String version
          The monitor version

    • Class org.apache.dubbo.config.ProtocolConfig

      class ProtocolConfig extends AbstractConfig implements Serializable
      serialVersionUID:
      6913423882496634749L

      • Serialized Fields

        • accepts
          Integer accepts
          The maximum acceptable connections.
        • accesslog
          String accesslog
          The access log configuration.
        • alive
          Integer alive
          The keep-alive time for threads in the thread pool (default unit is TimeUnit.MILLISECONDS).
        • buffer
          Integer buffer
          The buffer size.
        • charset
          String charset
          The character set used for communication.
        • client
          String client
          The client implementation.
        • codec
          String codec
          The protocol codec.
        • contextpath
          String contextpath
          The context path for the service.
        • corethreads
          Integer corethreads
          The core thread size of the thread pool.
        • dispatcher
          String dispatcher
          The thread dispatch mode.
        • exchanger
          String exchanger
          The method of information exchange.
        • extension
          String extension
          Additional extensions.
        • extProtocol
          String extProtocol
          Extra protocol for this service, using Port Unification Server.
        • heartbeat
          Integer heartbeat
          The interval for sending heartbeats.
        • host
          String host
          The service's IP address (useful when there are multiple network cards available).
        • iothreads
          Integer iothreads
          The fixed size of the IO thread pool.
        • jsonCheckLevel
          String jsonCheckLevel
          JSON check level for serialization.
        • keepAlive
          Boolean keepAlive
          Indicates whether it is a persistent connection.
        • name
          String name
          The name of the protocol.
        • networker
          String networker
          The networker implementation.
        • noInterfaceSupport
          Boolean noInterfaceSupport
          Indicates whether to support no interface.
        • optimizer
          String optimizer
          The optimizer used for dubbo protocol.
        • parameters
          Map<String,String> parameters
          Custom parameters.
        • payload
          Integer payload
          The maximum payload length.
        • port
          Integer port
          The service's port number.
        • preferredProtocol
          String preferredProtocol
        • preferSerialization
          String preferSerialization
          Specifies the preferred serialization method for the consumer. If specified, the consumer will use this parameter first. If the Dubbo Sdk you are using contains the serialization type, the serialization method specified by the argument is used.

          When this parameter is null or the serialization type specified by this parameter does not exist in the Dubbo SDK, the serialization type specified by serialization is used. If the Dubbo SDK if still does not exist, the default type of the Dubbo SDK is used. For Dubbo SDK >= 3.2, preferSerialization takes precedence over serialization

          Supports multiple values separated by commas, e.g., "fastjson2,fastjson,hessian2".

        • prompt
          String prompt
          The command line prompt.
        • queues
          Integer queues
          The length of the thread pool's queue.
        • register
          Boolean register
          Indicates whether the service should be registered.
        • serialization
          String serialization
          The serialization method.
        • server
          String server
          The server implementation.
        • sslEnabled
          Boolean sslEnabled
          Indicates whether SSL is enabled.
        • status
          String status
          The status check configuration.
        • telnet
          String telnet
          Supported Telnet commands, separated by commas.
        • threadpool
          String threadpool
          The name of the thread pool.
        • threadPoolExhaustedListeners
          String threadPoolExhaustedListeners
          Listeners for exhausted thread pool.
        • threads
          Integer threads
          The fixed size of the thread pool.
        • transporter
          String transporter
          The transporter used for communication.
        • triple
          TripleConfig triple

    • Class org.apache.dubbo.config.ProviderConfig

      class ProviderConfig extends AbstractServiceConfig implements Serializable
      serialVersionUID:
      6913423882496634749L

      • Serialized Fields

        • accepts
          Integer accepts
          The maximum number of acceptable connections.
        • alive
          Integer alive
          The keep-alive time of the thread pool, default unit: TimeUnit.MILLISECONDS.
        • buffer
          Integer buffer
          The size of the network I/O buffer.
        • charset
          String charset
          The charset used for serialization.
        • client
          String client
          The client-side implementation model of the protocol.
        • codec
          String codec
          The codec used by the protocol.
        • contextpath
          String contextpath
          The context path of the service.
        • dispatcher
          String dispatcher
          The mode of thread dispatching.
        • exchanger
          String exchanger
          The method of information exchange.
        • exportBackground
          Boolean exportBackground
          Deprecated.
          Replace with ModuleConfig.setBackground(Boolean)
          Whether the export should run in the background or not.
          See Also:
        • exportThreadNum
          Integer exportThreadNum
          The number of threads for the asynchronous export pool.
        • host
          String host
          The IP addresses of the service (used when there are multiple network cards available).
        • iothreads
          Integer iothreads
          The size of the I/O thread pool (fixed size).
        • networker
          String networker
          The networker used by the protocol.
        • payload
          Integer payload
          The maximum payload length.
        • port
          Integer port
          The port of the service.
        • prompt
          String prompt
          The command line prompt.
        • queues
          Integer queues
          The length of the thread pool queue.
        • server
          String server
          The server-side implementation model of the protocol.
        • status
          String status
          The status check configuration.
        • telnet
          String telnet
          Supported telnet commands, separated by commas.
        • threadname
          String threadname
          The name of the thread pool.
        • threadpool
          String threadpool
          The thread pool configuration.
        • threads
          Integer threads
          The size of the thread pool (fixed size).
        • transporter
          String transporter
          The transporter used by the protocol.
        • wait
          Integer wait
          The wait time when stopping the service.

    • Class org.apache.dubbo.config.ReferenceConfigBase

      class ReferenceConfigBase extends AbstractReferenceConfig implements Serializable
      serialVersionUID:
      -5864351140409987595L

      • Serialized Fields

        • consumer
          ConsumerConfig consumer
          The default consumer configuration.
        • interfaceClass
          Class<?> interfaceClass
          The interface class of the reference service.
        • unloadClusterRelated
          Boolean unloadClusterRelated
          In mesh mode, this flag uninstalls the directory, router, and load balancing configurations related to the cluster in the currently invoked invoker. It delegates retry, load balancing, timeout, and other traffic management capabilities to Sidecar.
        • url
          String url
          The URL for peer-to-peer invocation.

    • Class org.apache.dubbo.config.RegistryConfig

      class RegistryConfig extends AbstractConfig implements Serializable
      serialVersionUID:
      5508512956753757169L

      • Serialized Fields

        • accepts
          String accepts
          List of RPC protocols accepted by this registry, e.g., "dubbo,rest".
        • address
          String address
          Register center address.
        • check
          Boolean check
          Whether to check if the register center is available when booting up.
        • client
          String client
          Client implementation.
        • cluster
          String cluster
          Affects how traffic distributes among registries, useful when subscribing to multiple registries. Available options: - "zone-aware": A certain type of traffic always goes to one Registry according to where the traffic is originated.
        • dynamic
          Boolean dynamic
          Whether to allow dynamic service registration on the register center.
        • enableEmptyProtection
          Boolean enableEmptyProtection
          Enable empty protection.
        • extraKeys
          String extraKeys
          After simplifying the registry, add some parameters individually, useful for providers. Example: extra-keys = "A, b, c, d".
          Since:
          2.7.0
        • file
          String file
          File for saving the register center dynamic list.
        • group
          String group
          The group that services registry belongs to.
        • parameters
          Map<String,String> parameters
          Customized parameters.
        • password
          String password
          Password to login the register center.
        • port
          Integer port
          Default port for the register center.
        • preferred
          Boolean preferred
          Always use this registry first if set to true, useful when subscribing to multiple registries.
        • protocol
          String protocol
          Protocol used for the register center.
        • register
          Boolean register
          Whether to allow exporting service on the register center.
        • registerMode
          String registerMode
          Register mode.
        • secure
          String secure
          Security settings.
        • server
          String server
          Server implementation.
        • session
          Integer session
          Session timeout in milliseconds for the register center.
        • simplified
          Boolean simplified
          Simplify the registry, useful for both providers and consumers.
          Since:
          2.7.0
        • subscribe
          Boolean subscribe
          Whether to allow subscribing to services on the register center.
        • timeout
          Integer timeout
          Connect timeout in milliseconds for the register center.
        • transporter
          String transporter
          Network transmission type.
        • useAsConfigCenter
          Boolean useAsConfigCenter
          Indicates whether the address works as a configuration center or not.
        • useAsMetadataCenter
          Boolean useAsMetadataCenter
          Indicates whether the address works as a remote metadata center or not.
        • username
          String username
          Username to login the register center.
        • version
          String version
          Version of the registry.
        • wait
          Integer wait
          Wait time before stopping.
        • weight
          Integer weight
          Affects traffic distribution among registries, useful when subscribing to multiple registries. Takes effect only when no preferred registry is specified.
        • zone
          String zone
          The region where the registry belongs, usually used to isolate traffics.

    • Class org.apache.dubbo.config.ServiceConfigBase

      class ServiceConfigBase extends AbstractServiceConfig implements Serializable
      serialVersionUID:
      3033787999037024738L

      • Serialized Fields

        • generic
          String generic
          Indicates whether the service is a GenericService. If set, this means that the service is a generic service that can handle multiple types.
        • interfaceClass
          Class<?> interfaceClass
          The interface class of the exported service.
        • path
          String path
          The service name, which is used to uniquely identify the service.
        • provider
          ProviderConfig provider
          The provider configuration for this service.
        • providerIds
          String providerIds
          A comma-separated list of provider IDs.

    • Class org.apache.dubbo.config.SslConfig

      class SslConfig extends AbstractConfig implements Serializable
      serialVersionUID:
      4072725016922915851L

      • Serialized Fields

        • caAddress
          String caAddress
          Address for Certificate Authority (CA).
        • caCertPath
          String caCertPath
          Path to the CA certificate file.
        • clientKeyCertChainPath
          String clientKeyCertChainPath
          Path to the client's key certificate chain file.
        • clientKeyCertChainPathStream
          InputStream clientKeyCertChainPathStream
          Input stream for the client's key certificate chain (if provided).
        • clientKeyPassword
          String clientKeyPassword
          Password for the client's private key (if applicable).
        • clientPrivateKeyPath
          String clientPrivateKeyPath
          Path to the client's private key file.
        • clientPrivateKeyPathStream
          InputStream clientPrivateKeyPathStream
          Input stream for the client's private key (if provided).
        • clientTrustCertCollectionPath
          String clientTrustCertCollectionPath
          Path to the client's trust certificate collection file.
        • clientTrustCertCollectionPathStream
          InputStream clientTrustCertCollectionPathStream
          Input stream for the client's trust certificate collection (if provided).
        • envType
          String envType
          Environment type for SSL configuration.
        • oidcTokenPath
          String oidcTokenPath
          Path to the OIDC (OpenID Connect) token file.
        • serverKeyCertChainPath
          String serverKeyCertChainPath
          Path to the server's key certificate chain file.
        • serverKeyCertChainPathStream
          InputStream serverKeyCertChainPathStream
          Input stream for the server's key certificate chain (if provided).
        • serverKeyPassword
          String serverKeyPassword
          Password for the server's private key (if applicable).
        • serverPrivateKeyPath
          String serverPrivateKeyPath
          Path to the server's private key file.
        • serverPrivateKeyPathStream
          InputStream serverPrivateKeyPathStream
          Input stream for the server's private key (if provided).
        • serverTrustCertCollectionPath
          String serverTrustCertCollectionPath
          Path to the server's trust certificate collection file.
        • serverTrustCertCollectionPathStream
          InputStream serverTrustCertCollectionPathStream
          Input stream for the server's trust certificate collection (if provided).

    • Class org.apache.dubbo.config.TracingConfig

      class TracingConfig extends AbstractConfig implements Serializable
      serialVersionUID:
      -9089919311611546383L

      • Serialized Fields

        • baggage
          BaggageConfig baggage
          Configuration for baggage.
        • enabled
          Boolean enabled
          Indicates whether the feature is enabled (default is false).
        • propagation
          PropagationConfig propagation
          Configuration for propagation.
        • sampling
          SamplingConfig sampling
          Configuration for sampling.
        • tracingExporter
          ExporterConfig tracingExporter
          Configuration for the tracing exporter.

  • Package org.apache.dubbo.config.nested

    • Class org.apache.dubbo.config.nested.AggregationConfig

      class AggregationConfig extends Object implements Serializable
      serialVersionUID:
      4878693820314125085L

      • Serialized Fields

        • bucketNum
          Integer bucketNum
          The number of buckets for time window quantile.
        • enabled
          Boolean enabled
          Enable aggregation or not.
        • enableQps
          Boolean enableQps
          Enable QPS (Queries Per Second) aggregation or not.
        • enableRequest
          Boolean enableRequest
          Enable Request aggregation or not.
        • enableRt
          Boolean enableRt
          Enable Response Time aggregation or not.
        • enableRtPxx
          Boolean enableRtPxx
          Enable Response Time Percentile (Pxx) aggregation or not.
        • qpsTimeWindowMillSeconds
          Integer qpsTimeWindowMillSeconds
          The time window in milliseconds for QPS (Queries Per Second) aggregation.
        • timeWindowSeconds
          Integer timeWindowSeconds
          The time window in seconds for time window quantile.

    • Class org.apache.dubbo.config.nested.BaggageConfig

      class BaggageConfig extends Object implements Serializable
      serialVersionUID:
      -4750259290735346439L

      • Serialized Fields

        • correlation
          BaggageConfig.Correlation correlation
          Correlation configuration.
        • enabled
          Boolean enabled
          Whether baggage is enabled or not.
        • remoteFields
          List<String> remoteFields
          List of fields that are referenced the same in-process as it is on the wire. For example, the field "x-vcap-request-id" would be set as-is including the prefix.

    • Class org.apache.dubbo.config.nested.BaggageConfig.Correlation

      class Correlation extends Object implements Serializable

      • Serialized Fields

        • enabled
          boolean enabled
          Whether to enable correlation of the baggage context with logging contexts.
        • fields
          List<String> fields
          List of fields that should be correlated with the logging context. That means that these fields would end up as key-value pairs in e.g. MDC.

    • Class org.apache.dubbo.config.nested.CorsConfig

      class CorsConfig extends Object implements Serializable
      serialVersionUID:
      -7106481576053641726L

      • Serialized Fields

        • allowCredentials
          Boolean allowCredentials
          Whether user credentials are supported.

          By default this is not set (i.e. user credentials are not supported).

        • allowedHeaders
          String[] allowedHeaders
          /** Set the list of headers that a pre-flight request can list as allowed for use during an actual request. The special value "*" allows actual requests to send any header.

          By default this is not set.

        • allowedMethods
          String[] allowedMethods
          Set the HTTP methods to allow, e.g. "GET", "POST", "PUT", etc. The special value "*" allows all methods.

          If not set, only "GET" and "HEAD" are allowed.

          By default this is not set.

        • allowedOrigins
          String[] allowedOrigins
          A list of origins for which cross-origin requests are allowed. Values may be a specific domain, e.g. "https://domain1.com", or the CORS defined special value "*" for all origins.

          By default this is not set which means that no origins are allowed. However, an instance of this class is often initialized further, e.g. for @CrossOrigin, via org.apache.dubbo.rpc.protocol.tri.rest.mapping.meta.CorsMeta.Builder#applyDefault().

        • exposedHeaders
          String[] exposedHeaders
          Set the list of response headers that an actual response might have and can be exposed to the client. The special value "*" allows all headers to be exposed.

          By default this is not set.

        • maxAge
          Long maxAge
          Configure how long, as a duration, the response from a pre-flight request can be cached by clients.

    • Class org.apache.dubbo.config.nested.ExporterConfig

      class ExporterConfig extends Object implements Serializable
      serialVersionUID:
      -559392305178067845L

    • Class org.apache.dubbo.config.nested.ExporterConfig.OtlpConfig

      class OtlpConfig extends Object implements Serializable

      • Serialized Fields

        • compressionMethod
          String compressionMethod
          The method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include "gzip" and "none".
        • endpoint
          String endpoint
          URL to the Otlp API.
        • headers
          Map<String,String> headers
        • timeout
          Duration timeout
          The maximum time to wait for the collector to process an exported batch of spans. (seconds)

    • Class org.apache.dubbo.config.nested.ExporterConfig.ZipkinConfig

      class ZipkinConfig extends Object implements Serializable

      • Serialized Fields

        • connectTimeout
          Duration connectTimeout
          Connection timeout for requests to Zipkin. (seconds)
        • endpoint
          String endpoint
          URL to the Zipkin API.
        • readTimeout
          Duration readTimeout
          Read timeout for requests to Zipkin. (seconds)

    • Class org.apache.dubbo.config.nested.HistogramConfig

      class HistogramConfig extends Object implements Serializable
      serialVersionUID:
      8152538916051803031L

      • Serialized Fields

        • bucketsMs
          Integer[] bucketsMs
          Buckets in milliseconds for the histograms. Defines the histogram bucket boundaries.
        • distributionStatisticExpiryMin
          Integer distributionStatisticExpiryMin
          Expiry time in minutes for distribution statistics. After this time, the statistics are expired.
        • enabled
          Boolean enabled
          Whether histograms are enabled or not. Default is not enabled (false).
        • enabledPercentiles
          Boolean enabledPercentiles
          Whether enabledPercentiles are enabled or not. Default is not enabled (false).
        • maxExpectedMs
          Integer maxExpectedMs
          Maximum expected value in milliseconds for the histograms. Values higher than this will be considered outliers.
        • minExpectedMs
          Integer minExpectedMs
          Minimum expected value in milliseconds for the histograms. Values lower than this will be considered outliers.
        • percentiles
          double[] percentiles
          Array of percentiles to be calculated for the histograms. Each percentile is a double value.

    • Class org.apache.dubbo.config.nested.Http3Config

      class Http3Config extends Object implements Serializable
      serialVersionUID:
      -4443828713331129834L

    • Class org.apache.dubbo.config.nested.OpenAPIConfig

      class OpenAPIConfig extends Object implements Serializable
      serialVersionUID:
      6943417456345001947L

      • Serialized Fields

        • cache
          Boolean cache
          Whether to cache the OpenAPI document.

          The default value is 'true'.

        • defaultConsumesMediaTypes
          String[] defaultConsumesMediaTypes
          The default media types that are consumed.
        • defaultHttpMethods
          String[] defaultHttpMethods
          The default HTTP methods are used.
        • defaultHttpStatusCodes
          String[] defaultHttpStatusCodes
          The default HTTP status codes are returned.
        • defaultProducesMediaTypes
          String[] defaultProducesMediaTypes
          The default media types that are produced.
        • enabled
          Boolean enabled
          Whether to enable OpenAPI support

          The default value is 'true'.

        • externalDocsDescription
          String externalDocsDescription
          A description of the external documentation.
        • externalDocsUrl
          String externalDocsUrl
          The URL of the external documentation.
        • infoContactEmail
          String infoContactEmail
          The email address of the contact.
        • infoContactName
          String infoContactName
          The name of the contact.
        • infoContactUrl
          String infoContactUrl
          The url of the contact.
        • infoDescription
          String infoDescription
          A brief description of the OpenAPI information.
        • infoTitle
          String infoTitle
          The title of the OpenAPI information.
        • infoVersion
          String infoVersion
          The version number of the OpenAPI information.
        • nameStrategy
          String nameStrategy
          The strategy used to generate operation id and schema name.
        • path
          String path
          The HTTP path where OpenAPI will be registered.

          The default value is '/dubbo/openapi'.

        • schemaClassExcludes
          String[] schemaClassExcludes
          Specifies the classes to be excluded from schema generation.

          For example:

          • com.example.MyClass - Exclude the MyClass class.
          • com.example. - Exclude all classes in the com.example package.
          • !com.example.exclude. - Exclude all classes except those in the com.example.exclude package.
          Note that the package name should end with a dot (.) or an exclamation mark (!) to indicate the exclusion scope.

          Multiple classes or package names can be separated by commas, for example: com.example.MyClass,com.example.,!com.example.exclude

        • schemaFlatten
          Boolean schemaFlatten
          Whether to flatten the inherited fields from the parent class into the schema.

          The default value is false.

        • security
          String security
          The security.
        • securityScheme
          String securityScheme
          The security scheme.
        • servers
          String[] servers
          A list of servers.
        • settings
          Map<String,String> settings
          The custom settings.

    • Class org.apache.dubbo.config.nested.PrometheusConfig

      class PrometheusConfig extends Object implements Serializable
      serialVersionUID:
      2238807632335823129L

    • Class org.apache.dubbo.config.nested.PrometheusConfig.Exporter

      class Exporter extends Object implements Serializable

      • Serialized Fields

        • enabled
          Boolean enabled
          Enable prometheus exporter
        • enableHttpServiceDiscovery
          Boolean enableHttpServiceDiscovery
          Enable http service discovery for prometheus
        • httpServiceDiscoveryUrl
          String httpServiceDiscoveryUrl
          Http service discovery url

    • Class org.apache.dubbo.config.nested.PrometheusConfig.Pushgateway

      class Pushgateway extends Object implements Serializable

      • Serialized Fields

        • baseUrl
          String baseUrl
          Base URL for the Pushgateway
        • enabled
          Boolean enabled
          Enable publishing via a Prometheus Pushgateway
        • job
          String job
          Job identifier for this application instance
        • password
          String password
          Login password of the Prometheus Pushgateway
        • pushInterval
          Integer pushInterval
          Frequency with which to push metrics
        • username
          String username
          Login user of the Prometheus Pushgateway

    • Class org.apache.dubbo.config.nested.PropagationConfig

      class PropagationConfig extends Object implements Serializable
      serialVersionUID:
      -2570106396211532046L

      • Serialized Fields

        • type
          String type
          Tracing context propagation type.

    • Class org.apache.dubbo.config.nested.RestConfig

      class RestConfig extends Object implements Serializable
      serialVersionUID:
      -8068568976367034755L

      • Serialized Fields

        • caseSensitiveMatch
          Boolean caseSensitiveMatch
          Whether path matching should be case-sensitive. If enabled, a method mapped to "/users" won't match to "/Users/".

          The default value is true.

        • cors
          CorsConfig cors
          The cors configuration.
        • disallowedContentTypes
          String[] disallowedContentTypes
          The disallowed content-types.
        • enabled
          Boolean enabled
          Whether to enable rest support

          The default value is 'true'.

        • enableDefaultMapping
          Boolean enableDefaultMapping
          Whether to enable the default mapping '/{interfaceName}/{methodName}'.

          The default value is 'true'.

        • formatParameterName
          String formatParameterName
          The parameter name that can be used to specify the response format.

          The default value is 'format'.

        • jsonFramework
          String jsonFramework
          The json framework to use, make sure that dependencies are imported.
        • openapi
          OpenAPIConfig openapi
          The openapi configuration.
        • openapis
          Map<String,OpenAPIConfig> openapis
          Multiple configurations for openapi.
        • suffixPatternMatch
          Boolean suffixPatternMatch
          Whether path matching uses suffix pattern matching (".*"). If enabled, a method mapped to "/users" also matches to "/users.*".

          This also enables suffix content negotiation, with the media-type inferred from the URL suffix, e.g., ".json" for "application/json".

          The default value is true.

        • trailingSlashMatch
          Boolean trailingSlashMatch
          Whether path matching should be match paths with a trailing slash. If enabled, a method mapped to "/users" also matches to "/users/".

          The default value is true.

    • Class org.apache.dubbo.config.nested.SamplingConfig

      class SamplingConfig extends Object implements Serializable
      serialVersionUID:
      -7456034528275916549L

      • Serialized Fields

        • probability
          float probability
          Probability in the range from 0.0 to 1.0 that a trace will be sampled.

    • Class org.apache.dubbo.config.nested.ServletConfig

      class ServletConfig extends Object implements Serializable
      serialVersionUID:
      1091478303358670173L

      • Serialized Fields

        • enabled
          Boolean enabled
          Whether to enable servlet support, requests are transport through the servlet container

          The default value is false.

        • filterOrder
          Integer filterOrder
          The order of the servlet filter.

          The default value is -1000000.

        • filterUrlPatterns
          String[] filterUrlPatterns
          The URL patterns that the servlet filter will be registered for.

          The default value is '/*'.

        • maxConcurrentStreams
          Integer maxConcurrentStreams
          Maximum concurrent streams.

          For HTTP/2

          Note that the default value for tomcat is 20. Highly recommended to change it to Integer.MAX_VALUE

          If set to zero or a negative number, the actual value will be set to Integer.MAX_VALUE.

    • Class org.apache.dubbo.config.nested.TripleConfig

      class TripleConfig extends Object implements Serializable
      serialVersionUID:
      -3682252713701362155L

      • Serialized Fields

        • connectionInitialWindowSize
          Integer connectionInitialWindowSize
          Connection initial window size.

          For HTTP/2

        • enablePush
          Boolean enablePush
          Whether to enable push

          The default value is false.

          For HTTP/2

        • headerTableSize
          Integer headerTableSize
          The header table size.

          For HTTP/1

        • http3
          Http3Config http3
        • initialBufferSize
          Integer initialBufferSize
          Set the initial size of the temporary buffer used when parsing the lines of the HTTP headers.

          The default value is 16384 octets.

          For HTTP/1

        • initialWindowSize
          Integer initialWindowSize
          Initial window size.

          For HTTP/2

        • maxBodySize
          Integer maxBodySize
          Maximum allowed size for HTTP request bodies. Limits the size of request to prevent excessively large request.

          The default value is 8MiB.

        • maxChunkSize
          Integer maxChunkSize
          Set the maximum chunk size. HTTP requests and responses can be quite large, in which case it's better to process the data as a stream of chunks. This sets the limit, in bytes, at which Netty will send a chunk down the pipeline.

          The default value is 8MiB.

          For HTTP/1

        • maxConcurrentStreams
          Integer maxConcurrentStreams
          Maximum concurrent streams.

          For HTTP/2

        • maxFrameSize
          Integer maxFrameSize
          Maximum frame size.

          For HTTP/2

        • maxHeaderListSize
          Integer maxHeaderListSize
          Maximum header list size.

          For HTTP/2

        • maxHeaderSize
          Integer maxHeaderSize
          Set the maximum line length of header lines. This limits how much memory Netty will use when parsing HTTP header key-value pairs. You would typically set this to the same value as TripleConfig.setMaxInitialLineLength(Integer).

          The default value is 8KiB.

          For HTTP/1

        • maxInitialLineLength
          Integer maxInitialLineLength
          Set the maximum length of the first line of the HTTP header. This limits how much memory Netty will use when parsed the initial HTTP header line. You would typically set this to the same value as TripleConfig.setMaxHeaderSize(Integer).

          The default value is 4096.

          For HTTP/1

        • maxResponseBodySize
          Integer maxResponseBodySize
          Maximum allowed size for HTTP response bodies. Limits the size of responses to prevent excessively large response.

          The default value is 8MiB.

        • rest
          RestConfig rest
        • servlet
          ServletConfig servlet
        • verbose
          Boolean verbose
          Whether enable verbose mode. When true, the application will produce detailed logging output to help with debugging and monitoring. This is useful for troubleshooting and understanding the application's behavior in detail.

          The default value is false.

        • websocket
          WebSocketConfig websocket

    • Class org.apache.dubbo.config.nested.WebSocketConfig

      class WebSocketConfig extends Object implements Serializable
      serialVersionUID:
      -2504271061733141988L

      • Serialized Fields

        • enabled
          Boolean enabled
          Whether to enable websocket support, requests are transport through the websocket container

          The default value is false.

        • filterOrder
          Integer filterOrder
          The order of the websocket filter.

          The default value is -1000000.

        • filterUrlPatterns
          String[] filterUrlPatterns
          The URL patterns that the websocket filter will be registered for.

          The default value is '/*'.

  • Package org.apache.dubbo.metadata.definition.model

  • Package org.apache.dubbo.rpc.service