Serialized Form

Package com.alibaba.dubbo.rpc.service

Exception Class com.alibaba.dubbo.rpc.service.GenericException

class GenericException extends GenericException implements Serializable

serialVersionUID:

-1182299763306599962L

Package org.apache.dubbo.common

Class org.apache.dubbo.common.URL

class URL extends Object implements Serializable

serialVersionUID:

-1985165475234910535L

Serialized Fields

attributes

Map<String,Object> attributes

hashCodeCache

int hashCodeCache

urlAddress

URLAddress urlAddress

urlParam

URLParam urlParam

Class org.apache.dubbo.common.URLBuilder

class URLBuilder extends ServiceConfigURL implements Serializable

Serialized Fields

attributes

Map<String,Object> attributes

host

String host

methodParameters

Map<String,Map<String,String>> methodParameters

parameters

Map<String,String> parameters

password

String password

path

String path

port

int port

protocol

String protocol

username

String username

Package org.apache.dubbo.common.beans

Exception Class org.apache.dubbo.common.beans.ScopeBeanException

class ScopeBeanException extends RuntimeException implements Serializable

Package org.apache.dubbo.common.beanutil

Class org.apache.dubbo.common.beanutil.JavaBeanDescriptor

class JavaBeanDescriptor extends Object implements Serializable

serialVersionUID:

-8505586483570518029L

Serialized Fields

className

String className

properties

Map<Object,Object> properties

type

int type

Package org.apache.dubbo.common.bytecode

Exception Class org.apache.dubbo.common.bytecode.NoSuchMethodException

class NoSuchMethodException extends RuntimeException implements Serializable

serialVersionUID:

-2725364246023268766L

Exception Class org.apache.dubbo.common.bytecode.NoSuchPropertyException

class NoSuchPropertyException extends RuntimeException implements Serializable

serialVersionUID:

-2725364246023268766L

Package org.apache.dubbo.common.concurrent

Exception Class org.apache.dubbo.common.concurrent.RejectException

class RejectException extends RuntimeException implements Serializable

serialVersionUID:

-3240015871717170195L

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

Class org.apache.dubbo.common.config.configcenter.ConfigChangedEvent

class ConfigChangedEvent extends EventObject implements Serializable

Serialized Fields

changeType

ConfigChangeType changeType

content

String content

group

String group

key

String key

Package org.apache.dubbo.common.threadpool

Class org.apache.dubbo.common.threadpool.MemoryLimitedLinkedBlockingQueue

class MemoryLimitedLinkedBlockingQueue extends LinkedBlockingQueue<E> implements Serializable

serialVersionUID:

1374792064759926198L

Serialized Fields

memoryLimiter

MemoryLimiter memoryLimiter

Class org.apache.dubbo.common.threadpool.MemorySafeLinkedBlockingQueue

class MemorySafeLinkedBlockingQueue extends LinkedBlockingQueue<E> implements Serializable

serialVersionUID:

8032578371739960142L

Serialized Fields

maxFreeMemory

int maxFreeMemory

rejector

Rejector<E> rejector

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

Class org.apache.dubbo.common.threadpool.support.eager.TaskQueue

class TaskQueue extends LinkedBlockingQueue<Runnable> implements Serializable

serialVersionUID:

-2635853580887179627L

Serialized Fields

executor

EagerThreadPoolExecutor executor

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

Class org.apache.dubbo.common.url.component.DubboServiceAddressURL

class DubboServiceAddressURL extends ServiceAddressURL implements Serializable

Serialized Fields

overrideURL

ServiceConfigURL overrideURL

Class org.apache.dubbo.common.url.component.PathURLAddress

class PathURLAddress extends URLAddress implements Serializable

Serialized Fields

password

String password

path

String path

protocol

String protocol

username

String username

Class org.apache.dubbo.common.url.component.ServiceAddressURL

class ServiceAddressURL extends URL implements Serializable

Class org.apache.dubbo.common.url.component.ServiceConfigURL

class ServiceConfigURL extends URL implements Serializable

Class org.apache.dubbo.common.url.component.URLAddress

class URLAddress extends Object implements Serializable

serialVersionUID:

-1985165475234910535L

Serialized Fields

host

String host

port

int port

Class org.apache.dubbo.common.url.component.URLPlainParam

class URLPlainParam extends URLParam implements Serializable

serialVersionUID:

4722019979665434393L

Package org.apache.dubbo.common.utils

Class org.apache.dubbo.common.utils.AtomicPositiveInteger

class AtomicPositiveInteger extends Number implements Serializable

serialVersionUID:

-3038533876489105940L

Serialized Fields

index

int index

Class org.apache.dubbo.common.utils.ConcurrentHashSet

class ConcurrentHashSet extends AbstractSet<E> implements Serializable

serialVersionUID:

-8672117787651310382L

Serialized Fields

map

ConcurrentMap<E,Object> map

Class org.apache.dubbo.common.utils.DefaultPage

class DefaultPage extends Object implements Serializable

serialVersionUID:

1099331838954070419L

Serialized Fields

data

List<T> data

hasNext

boolean hasNext

pageSize

int pageSize

requestOffset

int requestOffset

totalPages

int totalPages

totalSize

int totalSize

Class org.apache.dubbo.common.utils.Log

class Log extends Object implements Serializable

serialVersionUID:

-534113138054377073L

Serialized Fields

logLevel

org.apache.log4j.Level logLevel

logMessage

String logMessage

logName

String logName

logThread

String logThread

Class org.apache.dubbo.common.utils.LRU2Cache

class LRU2Cache extends LinkedHashMap<K,V> implements Serializable

serialVersionUID:

-5167631809472116969L

Serialized Fields

lock

Lock lock

maxCapacity

int maxCapacity

preCache

org.apache.dubbo.common.utils.LRU2Cache.PreCache<K,Boolean> preCache

Class org.apache.dubbo.common.utils.LRUCache

class LRUCache extends LinkedHashMap<K,V> implements Serializable

serialVersionUID:

-5167631809472116969L

Serialized Fields

lock

Lock lock

maxCapacity

int maxCapacity

Exception Class org.apache.dubbo.common.utils.ReflectionUtils.ReflectionException

class ReflectionException extends RuntimeException implements Serializable

Class org.apache.dubbo.common.utils.RegexProperties

class RegexProperties extends Properties implements Serializable

Package org.apache.dubbo.config

Class org.apache.dubbo.config.AbstractConfig

class AbstractConfig extends Object implements Serializable

serialVersionUID:

4267533505537413570L

Serialized Fields

id

String id

The config id

isDefault

Boolean isDefault

Is default config or not

refreshed

AtomicBoolean refreshed

Class org.apache.dubbo.config.AbstractInterfaceConfig

class AbstractInterfaceConfig extends AbstractMethodConfig implements Serializable

serialVersionUID:

-1559314110797223229L

Serialized Fields

application

ApplicationConfig application

The application info

auth

Boolean auth

callbacks

Integer callbacks

cluster

String cluster

Cluster type

configCenter

ConfigCenterConfig configCenter

connections

Integer connections

Connection limits, 0 means shared connection, otherwise it defines the connections delegated to the current service

filter

String filter

The Filter when the provider side exposed a service or the customer side references a remote service used, if there are more than one, you can use commas to separate them

group

String group

The remote service group the customer/provider side will reference

interfaceName

String interfaceName

The interface name of the exported service

layer

String layer

The layer of service providers

listener

String listener

The Listener when the provider side exposes a service or the customer side references a remote service used if there are more than one, you can use commas to separate them

local

String local

Local impl class name for the service interface

metadataReportConfig

MetadataReportConfig metadataReportConfig

The metadata report configuration

methods

List<MethodConfig> methods

The method configuration

module

ModuleConfig module

The module info

monitor

MonitorConfig monitor

Service monitor

onconnect

String onconnect

ondisconnect

String ondisconnect

Disconnection events

owner

String owner

The owner of the service providers

proxy

String proxy

Strategies for generating dynamic agents，there are two strategies can be chosen: jdk and javassist

registries

List<RegistryConfig> registries

The registry list the service will register to Also see AbstractInterfaceConfig.registryIds, only one of them will work.

registryIds

String registryIds

The id list of registries the service will register to Also see AbstractInterfaceConfig.registries, only one of them will work.

scope

String scope

serviceMetadata

ServiceMetadata serviceMetadata

singleton

Boolean singleton

stub

String stub

Local stub class name for the service interface

tag

String tag

version

String version

The remote service version the customer/provider side will reference

Class org.apache.dubbo.config.AbstractMethodConfig

class AbstractMethodConfig extends AbstractConfig implements Serializable

serialVersionUID:

5809761483000878437L

Serialized Fields

actives

Integer actives

max concurrent invocations

async

Boolean async

Whether to async note that: it is an unreliable asynchronous that ignores return values and does not block threads.

cache

String cache

Cache the return result with the call parameter as key, the following options are available: lru, threadlocal, jcache, etc.

forks

Integer forks

Forks for forking cluster

loadbalance

String loadbalance

The load balance

merger

String merger

Merger

mock

String mock

The name of mock class which gets called when a service fails to execute

note that: the mock doesn't support on the provider side，and the mock is executed when a non-business exception occurs after a remote service call

parameters

Map<String,String> parameters

The customized parameters

retries

Integer retries

The retry times

sent

Boolean sent

Whether to ack async-sent

timeout

Integer timeout

The timeout for remote invocation in milliseconds

validation

String validation

Whether JSR303 standard annotation validation is enabled or not, if enabled, annotations on method parameters will be validated

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 register service (milliseconds)

deprecated

Boolean deprecated

whether the service is deprecated

document

String document

Document center

dynamic

Boolean dynamic

Whether to register as a dynamic service or not on register center, the value is true, the status will be enabled after the service registered,and it needs to be disabled manually; if you want to disable the service, you also need manual processing

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

If the parameter has a value, the consumer will read the 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

The configuration supports multiple, which are separated by commas.Such as:fastjson2,fastjson,hessian2

protocolIds

String protocolIds

The id list of protocols the service will export with Also see AbstractServiceConfig.protocols, only one of them will work.

protocols

List<ProtocolConfig> protocols

The protocol list the service will export with Also see AbstractServiceConfig.protocolIds, only one of them will work.

register

Boolean register

Whether to register

serialization

String serialization

The serialization type

token

String token

Whether to use token

version

String version

The service version

warmup

Integer warmup

Warm up period

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

checkSerializable

Boolean checkSerializable

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

enableFileCache

Boolean enableFileCache

environment

String environment

Environment, e.g. dev, test or production

executorManagementMode

String executorManagementMode

thread pool management: default/isolation

hostname

String hostname

livenessProbe

String livenessProbe

used to set extensions of probe in qos

logger

String logger

The type of the 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 choose remote, you need to further specify metadata center.

monitor

MonitorConfig monitor

Monitor center

name

String name

Application name

organization

String organization

Application's organization (BU)

owner

String owner

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 which is the preferred protocol

qosAcceptForeignIp

Boolean qosAcceptForeignIp

Should we accept foreign ip or not?

qosAcceptForeignIpWhitelist

String qosAcceptForeignIpWhitelist

When we disable accept foreign ip, support specify foreign ip in the whitelist

qosAnonymousAccessPermissionLevel

String qosAnonymousAccessPermissionLevel

the anonymous(any foreign ip) access permission level, default is NONE, can not access any cmd

qosAnonymousAllowCommands

String qosAnonymousAllowCommands

the anonymous(any foreign ip) allow commands, default is empty, can not access any cmd

qosCheck

Boolean qosCheck

Whether qos should start success or not, will check qosEnable first

qosEnable

Boolean qosEnable

Whether to enable qos or not

qosHost

String qosHost

The qos host to listen

qosPort

Integer qosPort

The qos port to listen

readinessProbe

String readinessProbe

registerConsumer

Boolean registerConsumer

Used to control whether register instance to registry or not. Set to 'false' only when instance is pure consumer.

registerMode

String registerMode

registries

List<RegistryConfig> registries

Registry centers

registryIds

String registryIds

repository

String repository

serializeCheckStatus

String serializeCheckStatus

shutwait

String shutwait

Config the shutdown.wait

startupProbe

String startupProbe

trustSerializeClassLevel

Integer trustSerializeClassLevel

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

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

check

Boolean check

Decide the behaviour when initial connection try fails, 'true' means interrupt the whole process once fail. The default value is true

cluster

String cluster

The config center cluster, it's real meaning may very on different Config Center products.

configFile

String configFile

Used to specify the key that your properties file mapping to, most of the time you do not need to change this parameter. Notice that for Apollo, this parameter is meaningless, set the 'namespace' is enough. The default value is CommonConstants.DEFAULT_DUBBO_PROPERTIES

externalConfiguration

Map<String,String> externalConfiguration

group

String group

The group of the config center, generally it's used to identify an isolated space for a batch of config items, but it's real meaning depends on the actual Config Center you use. The default value is CommonConstants.DUBBO

highestPriority

Boolean highestPriority

Deprecated.

no longer used

If the Config Center is given the highest priority, it will override all the other configurations The default value is true

initialized

AtomicBoolean initialized

namespace

String namespace

The namespace of the config center, generally it's used for multi-tenant, but it's real meaning depends on the actual Config Center you use. The default value is CommonConstants.DUBBO

parameters

Map<String,String> parameters

If the Config Center product you use have some special parameters that is not covered by this class, you can add it to 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

port

Integer port

protocol

String protocol

timeout

Long timeout

The default value is 30000L;

username

String username

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:

• ModuleConfig.setBackground(Boolean)

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

metadata center address

check

Boolean check

Decide the behaviour when initial connection try fails, 'true' means interrupt the whole process once fail. The default value is true

cluster

Boolean cluster

cluster

cycleReport

Boolean cycleReport

By default, the metadata store will store full metadata repeatedly every day .

file

String file

File for saving metadata center dynamic list

group

String group

The group the metadata in . It is the same as registry

parameters

Map<String,String> parameters

Customized parameters

password

String password

Password to login metadata center

port

Integer port

Default port for metadata center

protocol

String protocol

registry

String registry

registry id

reportDefinition

Boolean reportDefinition

reportMetadata

Boolean reportMetadata

retryPeriod

Integer retryPeriod

retryTimes

Integer retryTimes

syncReport

Boolean syncReport

Sync report, default async

timeout

Integer timeout

Request timeout in milliseconds for metadata center

username

String username

Username to login 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

The metrics aggregation config

enableCollectorSync

Boolean enableCollectorSync

Enable collector sync.

enableJvm

Boolean enableJvm

Enable jvm metrics when collecting.

enableMetadata

Boolean enableMetadata

Enable metadata metrics.

enableMetricsInit

Boolean enableMetricsInit

Enable metrics init.

enableNetty

Boolean enableNetty

Enable netty metrics.

enableRegistry

Boolean enableRegistry

Enable registry metrics.

enableRpc

Boolean enableRpc

enableThreadpool

Boolean enableThreadpool

Enable threadpool metrics when collecting.

exportMetricsService

Boolean exportMetricsService

Export metrics service.

exportServicePort

Integer exportServicePort

exportServiceProtocol

String exportServiceProtocol

histogram

HistogramConfig histogram

port

String port

Deprecated.

After metrics config is refactored. This parameter should no longer use and will be deleted in the future.

prometheus

PrometheusConfig prometheus

The prometheus metrics config

protocol

String protocol

rpcLevel

String rpcLevel

The level of the metrics, the value can be "SERVICE", "METHOD", default is method.

useGlobalRegistry

Boolean useGlobalRegistry

Decide whether to use the global registry of the micrometer.

Class org.apache.dubbo.config.ModuleConfig

class ModuleConfig extends AbstractConfig implements Serializable

serialVersionUID:

5508512956753757169L

Serialized Fields

background

Boolean background

Whether start module in background. If start in background, do 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

Weather the service is export asynchronously

exportThreadNum

Integer exportThreadNum

Thread num for asynchronous export pool size

monitor

MonitorConfig monitor

Monitor center

name

String name

Module name

organization

String organization

Module's organization

owner

String owner

Module owner

referAsync

Boolean referAsync

Weather the reference is referred asynchronously

referThreadNum

Integer referThreadNum

Thread num for asynchronous refer pool size

registries

List<RegistryConfig> registries

Registry centers

version

String version

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

interval

String interval

parameters

Map<String,String> parameters

customized parameters

password

String password

The 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

Class org.apache.dubbo.config.ProtocolConfig

class ProtocolConfig extends AbstractConfig implements Serializable

serialVersionUID:

6913423882496634749L

Serialized Fields

accepts

Integer accepts

Max acceptable connections

accesslog

String accesslog

Access log

alive

Integer alive

Thread pool keepAliveTime, default unit TimeUnit.MILLISECONDS

buffer

Integer buffer

Buffer size

charset

String charset

Charset

client

String client

Client impl

codec

String codec

Protocol codec

contextpath

String contextpath

Context path

corethreads

Integer corethreads

Thread pool core thread size

dispatcher

String dispatcher

Thread dispatch mode

exchanger

String exchanger

How information is exchanged

extension

String extension

The extension

extProtocol

String extProtocol

heartbeat

Integer heartbeat

Heartbeat interval

host

String host

Service ip address (when there are multiple network cards available)

iothreads

Integer iothreads

IO thread pool size (fixed size)

jsonCheckLevel

String jsonCheckLevel

keepAlive

Boolean keepAlive

whether it is a persistent connection

name

String name

Protocol name

networker

String networker

Networker

optimizer

String optimizer

parameters

Map<String,String> parameters

The customized parameters

payload

Integer payload

Payload max length

port

Integer port

Service port

preferSerialization

String preferSerialization

If the parameter has a value, the consumer will read the 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

The configuration supports multiple, which are separated by commas.Such as:fastjson2,fastjson,hessian2

prompt

String prompt

Command line prompt

queues

Integer queues

Thread pool's queue length

register

Boolean register

Whether to register

serialization

String serialization

Serialization

server

String server

Sever impl

sslEnabled

Boolean sslEnabled

status

String status

Status check

telnet

String telnet

Supported telnet commands, separated with comma.

threadname

String threadname

Thread pool name

threadpool

String threadpool

Thread pool

threadPoolExhaustedListeners

String threadPoolExhaustedListeners

Thread pool exhausted listeners

threads

Integer threads

Thread pool size (fixed size)

transporter

String transporter

Transporter

Class org.apache.dubbo.config.ProviderConfig

class ProviderConfig extends AbstractServiceConfig implements Serializable

serialVersionUID:

6913423882496634749L

Serialized Fields

accepts

Integer accepts

Max acceptable connections

alive

Integer alive

Thread pool keepAliveTime, default unit TimeUnit.MILLISECONDS

buffer

Integer buffer

The network io buffer size

charset

String charset

The serialization charset

client

String client

The client-side implementation model of the protocol

codec

String codec

Protocol codec

contextpath

String contextpath

Context path

dispatcher

String dispatcher

Thread dispatching mode

exchanger

String exchanger

How information gets exchanged

exportBackground

Boolean exportBackground

Deprecated.

replace with ModuleConfig.setBackground(Boolean)

Whether export should run in background or not.

See Also:

• ModuleConfig.setBackground(Boolean)

exportThreadNum

Integer exportThreadNum

Thread num for asynchronous export pool size

host

String host

Service ip addresses (used when there are multiple network cards available)

iothreads

Integer iothreads

IO thread pool size (fixed size)

networker

String networker

Networker

payload

Integer payload

Payload max length

port

Integer port

Service port

prompt

String prompt

Command line prompt

queues

Integer queues

Thread pool queue length

server

String server

The server-side implementation model of the protocol

status

String status

Status check

telnet

String telnet

Supported telnet commands, separated with comma.

threadname

String threadname

Thread pool name

threadpool

String threadpool

Thread pool

threads

Integer threads

Thread pool size (fixed size)

transporter

String transporter

Transporter

wait

Integer wait

Wait time when stop

Class org.apache.dubbo.config.ReferenceConfigBase

class ReferenceConfigBase extends AbstractReferenceConfig implements Serializable

serialVersionUID:

-5864351140409987595L

Serialized Fields

consumer

ConsumerConfig consumer

The consumer config (default)

interfaceClass

Class<?> interfaceClass

The interface class of the reference service

unloadClusterRelated

Boolean unloadClusterRelated

In the mesh mode, uninstall the directory, router and load balance related to the cluster in the currently invoked invoker. Delegate 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, for example, "dubbo,rest"

address

String address

Register center address

check

Boolean check

Whether to check if register center is available when boot up

client

String client

cluster

String cluster

Affects how traffic distributes among registries, useful when subscribing multiple registries, available options: 1. 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 to register on the register center

enableEmptyProtection

Boolean enableEmptyProtection

extraKeys

String extraKeys

After simplify the registry, should add some parameter individually. just for provider.

such as: extra-keys = A,b,c,d

Since:

2.7.0

file

String file

File for saving register center dynamic list

group

String group

The group that services registry in

parameters

Map<String,String> parameters

The customized parameters

password

String password

Password to login register center

port

Integer port

Default port for register center

preferred

Boolean preferred

Always use this registry first if set to true, useful when subscribe to multiple registries

protocol

String protocol

Protocol for register center

register

Boolean register

Whether to allow exporting service on the register center

registerMode

String registerMode

secure

String secure

server

String server

session

Integer session

Session timeout in milliseconds for register center

simplified

Boolean simplified

Simple the registry. both useful for provider and consumer

Since:

2.7.0

subscribe

Boolean subscribe

Whether to allow subscribing service on the register center

timeout

Integer timeout

Connect timeout in milliseconds for register center

transporter

String transporter

Network transmission type

useAsConfigCenter

Boolean useAsConfigCenter

the address work as config center or not

useAsMetadataCenter

Boolean useAsMetadataCenter

the address work as remote metadata center or not

username

String username

Username to login register center

version

String version

wait

Integer wait

Wait time before stop

weight

Integer weight

Affects traffic distribution among registries, useful when subscribe to multiple registries Take 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

whether it is a GenericService

interfaceClass

Class<?> interfaceClass

The interface class of the exported service

path

String path

The service name

provider

ProviderConfig provider

The provider configuration

providerIds

String providerIds

The providerIds

Class org.apache.dubbo.config.SslConfig

class SslConfig extends AbstractConfig implements Serializable

Serialized Fields

caAddress

String caAddress

caCertPath

String caCertPath

clientKeyCertChainPath

String clientKeyCertChainPath

clientKeyCertChainPathStream

InputStream clientKeyCertChainPathStream

clientKeyPassword

String clientKeyPassword

clientPrivateKeyPath

String clientPrivateKeyPath

clientPrivateKeyPathStream

InputStream clientPrivateKeyPathStream

clientTrustCertCollectionPath

String clientTrustCertCollectionPath

clientTrustCertCollectionPathStream

InputStream clientTrustCertCollectionPathStream

envType

String envType

oidcTokenPath

String oidcTokenPath

serverKeyCertChainPath

String serverKeyCertChainPath

serverKeyCertChainPathStream

InputStream serverKeyCertChainPathStream

serverKeyPassword

String serverKeyPassword

serverPrivateKeyPath

String serverPrivateKeyPath

serverPrivateKeyPathStream

InputStream serverPrivateKeyPathStream

serverTrustCertCollectionPath

String serverTrustCertCollectionPath

serverTrustCertCollectionPathStream

InputStream serverTrustCertCollectionPathStream

Class org.apache.dubbo.config.TracingConfig

class TracingConfig extends AbstractConfig implements Serializable

serialVersionUID:

-9089919311611546383L

Serialized Fields

baggage

BaggageConfig baggage

Baggage configuration.

enabled

Boolean enabled

propagation

PropagationConfig propagation

Propagation configuration.

sampling

SamplingConfig sampling

Sampling configuration.

tracingExporter

ExporterConfig tracingExporter

Exporter configuration.

Package org.apache.dubbo.config.nested

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

class AggregationConfig extends Object implements Serializable

Serialized Fields

bucketNum

Integer bucketNum

Bucket num for time window quantile

enabled

Boolean enabled

Enable local aggregation or not

enableQps

Boolean enableQps

enableRequest

Boolean enableRequest

enableRt

Boolean enableRt

enableRtPxx

Boolean enableRtPxx

qpsTimeWindowMillSeconds

Integer qpsTimeWindowMillSeconds

Time window mill seconds for qps

timeWindowSeconds

Integer timeWindowSeconds

Time window seconds for time window quantile

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

class BaggageConfig extends Object implements Serializable

Serialized Fields

correlation

BaggageConfig.Correlation correlation

Correlation configuration.

enabled

Boolean enabled

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.ExporterConfig

class ExporterConfig extends Object implements Serializable

Serialized Fields

otlpConfig

ExporterConfig.OtlpConfig otlpConfig

zipkinConfig

ExporterConfig.ZipkinConfig zipkinConfig

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

Serialized Fields

bucketsMs

Integer[] bucketsMs

distributionStatisticExpiryMin

Integer distributionStatisticExpiryMin

enabled

Boolean enabled

enabledPercentiles

Boolean enabledPercentiles

maxExpectedMs

Integer maxExpectedMs

minExpectedMs

Integer minExpectedMs

percentiles

double[] percentiles

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

class PrometheusConfig extends Object implements Serializable

Serialized Fields

exporter

PrometheusConfig.Exporter exporter

Prometheus exporter configuration

pushgateway

PrometheusConfig.Pushgateway pushgateway

Prometheus Pushgateway configuration

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

Serialized Fields

type

String type

Tracing context propagation type.

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

class SamplingConfig extends Object implements Serializable

Serialized Fields

probability

float probability

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

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

Class org.apache.dubbo.metadata.definition.model.FullServiceDefinition

class FullServiceDefinition extends ServiceDefinition implements Serializable

Serialized Fields

parameters

Map<String,String> parameters

Class org.apache.dubbo.metadata.definition.model.MethodDefinition

class MethodDefinition extends Object implements Serializable

Serialized Fields

annotations

List<String> annotations

name

String name

parameters

List<TypeDefinition> parameters

Deprecated.

please use parameterTypes, and find TypeDefinition in org.apache.dubbo.metadata.definition.model.ServiceDefinition#types

parameterTypes

String[] parameterTypes

returnType

String returnType

Class org.apache.dubbo.metadata.definition.model.ServiceDefinition

class ServiceDefinition extends Object implements Serializable

Serialized Fields

annotations

List<String> annotations

the definitions of annotations

canonicalName

String canonicalName

the canonical name of interface

See Also:

• Class.getCanonicalName()

codeSource

String codeSource

the location of class file

See Also:

• ClassUtils.getCodeSource(Class)

methods

List<MethodDefinition> methods

types

List<TypeDefinition> types

the definitions of type

Class org.apache.dubbo.metadata.definition.model.TypeDefinition

class TypeDefinition extends Object implements Serializable

Serialized Fields

enums

List<String> enums

the enum's value

If this type is not enum, enums is null or empty

items

List<String> items

the items(generic parameter) of Map/List(ParameterizedType)

if this type is not ParameterizedType, the items is null or empty

properties

Map<String,String> properties

the key is property name, the value is property's type name

type

String type

the name of type

See Also:

• Class.getCanonicalName()
• ClassUtils.getCanonicalNameForParameterizedType(ParameterizedType)

Package org.apache.dubbo.rpc.service

Exception Class org.apache.dubbo.rpc.service.GenericException

class GenericException extends RuntimeException implements Serializable

serialVersionUID:

-1182299763306599962L

Serialized Fields

exceptionClass

String exceptionClass

exceptionMessage

String exceptionMessage