DubboBootstrap (Apache Dubbo 2.7.7 API)

java.lang.Object
- org.apache.dubbo.event.GenericEventListener
- - org.apache.dubbo.config.bootstrap.DubboBootstrap

All Implemented Interfaces:

Comparable<Prioritized>, EventListener, Prioritized
```
public class DubboBootstrap
extends GenericEventListener
```
See ApplicationModel and ExtensionLoader for why this class is designed to be singleton. The bootstrap class of Dubbo Get singleton instance by calling static method getInstance(). Designed as singleton because some classes inside Dubbo, such as ExtensionLoader, are designed only for one instance per process.

Since:

2.7.5

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CONSUMER_ID`
`static String`	`DEFAULT_PROTOCOL_ID`
`static String`	`DEFAULT_PROVIDER_ID`
`static String`	`DEFAULT_REFERENCE_ID`
`static String`	`DEFAULT_REGISTRY_ID`
`static String`	`DEFAULT_SERVICE_ID`

Fields inherited from interface org.apache.dubbo.common.lang.Prioritized
COMPARATOR, MAX_PRIORITY, MIN_PRIORITY, NORMAL_PRIORITY

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DubboBootstrap`	`addEventListener(EventListener<?> listener)` Add an instance of `EventListener`
`DubboBootstrap`	`application(ApplicationConfig applicationConfig)` Set the `ApplicationConfig`
`DubboBootstrap`	`application(String name)` Set the name of application
`DubboBootstrap`	`application(String name, Consumer<ApplicationBuilder> consumerBuilder)` Set the name of application and it's future build
`DubboBootstrap`	`await()` Block current thread to be await.
`DubboBootstrap`	`awaitFinish()`
`DubboBootstrap`	`cache(ReferenceConfigCache cache)`
`DubboBootstrap`	`configCenter(ConfigCenterConfig configCenterConfig)`
`DubboBootstrap`	`configCenters(List<ConfigCenterConfig> configCenterConfigs)`
`DubboBootstrap`	`consumer(Consumer<ConsumerBuilder> builderConsumer)`
`DubboBootstrap`	`consumer(ConsumerConfig consumerConfig)`
`DubboBootstrap`	`consumer(String id, Consumer<ConsumerBuilder> builderConsumer)`
`DubboBootstrap`	`consumers(List<ConsumerConfig> consumerConfigs)`
`void`	`destroy()`
`DubboBootstrap`	`exportAsync()`
`ApplicationConfig`	`getApplication()`
`ReferenceConfigCache`	`getCache()`
`static DubboBootstrap`	`getInstance()` See `ApplicationModel` and `ExtensionLoader` for why DubboBootstrap is designed to be singleton.
`void`	`init()` Deprecated.
`boolean`	`isInitialized()`
`boolean`	`isReady()`
`boolean`	`isStarted()`
`DubboBootstrap`	`metadataReport(MetadataReportConfig metadataReportConfig)`
`DubboBootstrap`	`metadataReports(List<MetadataReportConfig> metadataReportConfigs)`
`DubboBootstrap`	`metrics(MetricsConfig metrics)`
`DubboBootstrap`	`module(ModuleConfig module)`
`DubboBootstrap`	`monitor(MonitorConfig monitor)`
`DubboBootstrap`	`protocol(Consumer<ProtocolBuilder> consumerBuilder)`
`DubboBootstrap`	`protocol(ProtocolConfig protocolConfig)`
`DubboBootstrap`	`protocol(String id, Consumer<ProtocolBuilder> consumerBuilder)`
`DubboBootstrap`	`protocols(List<ProtocolConfig> protocolConfigs)`
`DubboBootstrap`	`provider(Consumer<ProviderBuilder> builderConsumer)`
`DubboBootstrap`	`provider(ProviderConfig providerConfig)`
`DubboBootstrap`	`provider(String id, Consumer<ProviderBuilder> builderConsumer)`
`DubboBootstrap`	`providers(List<ProviderConfig> providerConfigs)`
`DubboBootstrap`	`referAsync()`
`<S> DubboBootstrap`	`reference(Consumer<ReferenceBuilder<S>> consumerBuilder)`
`DubboBootstrap`	`reference(ReferenceConfig<?> referenceConfig)`
`<S> DubboBootstrap`	`reference(String id, Consumer<ReferenceBuilder<S>> consumerBuilder)`
`DubboBootstrap`	`references(List<ReferenceConfig> referenceConfigs)`
`DubboBootstrap`	`registries(List<RegistryConfig> registryConfigs)` Add an instance of `RegistryConfig`
`DubboBootstrap`	`registry(Consumer<RegistryBuilder> consumerBuilder)` Add an instance of `RegistryConfig` with `default ID`
`DubboBootstrap`	`registry(RegistryConfig registryConfig)` Add an instance of `RegistryConfig`
`DubboBootstrap`	`registry(String id, Consumer<RegistryBuilder> consumerBuilder)` Add an instance of `RegistryConfig` with the specified ID
`<S> DubboBootstrap`	`service(Consumer<ServiceBuilder<S>> consumerBuilder)`
`DubboBootstrap`	`service(ServiceConfig<?> serviceConfig)`
`<S> DubboBootstrap`	`service(String id, Consumer<ServiceBuilder<S>> consumerBuilder)`
`DubboBootstrap`	`services(List<ServiceConfig> serviceConfigs)`
`DubboBootstrap`	`ssl(SslConfig sslConfig)`
`DubboBootstrap`	`start()` Start the bootstrap
`DubboBootstrap`	`stop()`
`void`	`unRegisterShutdownHook()`

Methods inherited from class org.apache.dubbo.event.GenericEventListener
onEvent

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

Methods inherited from interface org.apache.dubbo.event.EventListener
findEventType, findEventType, findEventType, getPriority

Methods inherited from interface org.apache.dubbo.common.lang.Prioritized
compareTo

Field Detail
- DEFAULT_REGISTRY_ID
```
public static final String DEFAULT_REGISTRY_ID
```
  See Also:
  
  Constant Field Values
- DEFAULT_PROTOCOL_ID
```
public static final String DEFAULT_PROTOCOL_ID
```
  See Also:
  
  Constant Field Values
- DEFAULT_SERVICE_ID
```
public static final String DEFAULT_SERVICE_ID
```
  See Also:
  
  Constant Field Values
- DEFAULT_REFERENCE_ID
```
public static final String DEFAULT_REFERENCE_ID
```
  See Also:
  
  Constant Field Values
- DEFAULT_PROVIDER_ID
```
public static final String DEFAULT_PROVIDER_ID
```
  See Also:
  
  Constant Field Values
- DEFAULT_CONSUMER_ID
```
public static final String DEFAULT_CONSUMER_ID
```
  See Also:
  
  Constant Field Values

Method Detail

getInstance
```
public static DubboBootstrap getInstance()
```
See ApplicationModel and ExtensionLoader for why DubboBootstrap is designed to be singleton.

unRegisterShutdownHook
```
public void unRegisterShutdownHook()
```

metadataReport

public DubboBootstrap metadataReport(MetadataReportConfig metadataReportConfig)

metadataReports

public DubboBootstrap metadataReports(List<MetadataReportConfig> metadataReportConfigs)

application
```
public DubboBootstrap application(String name)
```
Set the name of application

Parameters:

name - the name of application

Returns:

current DubboBootstrap instance

application

public DubboBootstrap application(String name,
                                  Consumer<ApplicationBuilder> consumerBuilder)

Set the name of application and it's future build

Parameters:: name - the name of application; consumerBuilder - ApplicationBuilder
Returns:: current DubboBootstrap instance

application
```
public DubboBootstrap application(ApplicationConfig applicationConfig)
```
Set the ApplicationConfig

Parameters:

applicationConfig - the ApplicationConfig

Returns:

current DubboBootstrap instance

registry
```
public DubboBootstrap registry(Consumer<RegistryBuilder> consumerBuilder)
```
Add an instance of RegistryConfig with default ID

Parameters:

consumerBuilder - the Consumer of RegistryBuilder

Returns:

current DubboBootstrap instance

registry
```
public DubboBootstrap registry(String id,
                               Consumer<RegistryBuilder> consumerBuilder)
```
Add an instance of RegistryConfig with the specified ID

Parameters:

id - the id of RegistryConfig

consumerBuilder - the Consumer of RegistryBuilder

Returns:

current DubboBootstrap instance

registry
```
public DubboBootstrap registry(RegistryConfig registryConfig)
```
Add an instance of RegistryConfig

Parameters:

registryConfig - an instance of RegistryConfig

Returns:

current DubboBootstrap instance

registries
```
public DubboBootstrap registries(List<RegistryConfig> registryConfigs)
```
Add an instance of RegistryConfig

Parameters:

registryConfigs - the multiple instances of RegistryConfig

Returns:

current DubboBootstrap instance

protocol

public DubboBootstrap protocol(Consumer<ProtocolBuilder> consumerBuilder)

protocol

public DubboBootstrap protocol(String id,
                               Consumer<ProtocolBuilder> consumerBuilder)

protocol

public DubboBootstrap protocol(ProtocolConfig protocolConfig)

protocols

public DubboBootstrap protocols(List<ProtocolConfig> protocolConfigs)

service

public <S> DubboBootstrap service(Consumer<ServiceBuilder<S>> consumerBuilder)

service

public <S> DubboBootstrap service(String id,
                                  Consumer<ServiceBuilder<S>> consumerBuilder)

service

public DubboBootstrap service(ServiceConfig<?> serviceConfig)

services

public DubboBootstrap services(List<ServiceConfig> serviceConfigs)

reference

public <S> DubboBootstrap reference(Consumer<ReferenceBuilder<S>> consumerBuilder)

reference

public <S> DubboBootstrap reference(String id,
                                    Consumer<ReferenceBuilder<S>> consumerBuilder)

reference

public DubboBootstrap reference(ReferenceConfig<?> referenceConfig)

references

public DubboBootstrap references(List<ReferenceConfig> referenceConfigs)

provider

public DubboBootstrap provider(Consumer<ProviderBuilder> builderConsumer)

provider

public DubboBootstrap provider(String id,
                               Consumer<ProviderBuilder> builderConsumer)

provider

public DubboBootstrap provider(ProviderConfig providerConfig)

providers

public DubboBootstrap providers(List<ProviderConfig> providerConfigs)

consumer

public DubboBootstrap consumer(Consumer<ConsumerBuilder> builderConsumer)

consumer

public DubboBootstrap consumer(String id,
                               Consumer<ConsumerBuilder> builderConsumer)

consumer

public DubboBootstrap consumer(ConsumerConfig consumerConfig)

consumers

public DubboBootstrap consumers(List<ConsumerConfig> consumerConfigs)

configCenter

public DubboBootstrap configCenter(ConfigCenterConfig configCenterConfig)

configCenters

public DubboBootstrap configCenters(List<ConfigCenterConfig> configCenterConfigs)

monitor

public DubboBootstrap monitor(MonitorConfig monitor)

metrics

public DubboBootstrap metrics(MetricsConfig metrics)

module

public DubboBootstrap module(ModuleConfig module)

ssl

public DubboBootstrap ssl(SslConfig sslConfig)

cache

public DubboBootstrap cache(ReferenceConfigCache cache)

getCache

public ReferenceConfigCache getCache()

exportAsync
```
public DubboBootstrap exportAsync()
```

referAsync
```
public DubboBootstrap referAsync()
```

init
```
@Deprecated
public void init()
```
Deprecated.

start
```
public DubboBootstrap start()
```
Start the bootstrap

await
```
public DubboBootstrap await()
```
Block current thread to be await.

Returns:

DubboBootstrap

awaitFinish

public DubboBootstrap awaitFinish()
                           throws Exception

Throws:: Exception

isInitialized
```
public boolean isInitialized()
```

isStarted
```
public boolean isStarted()
```

isReady
```
public boolean isReady()
```

stop

public DubboBootstrap stop()
                    throws IllegalStateException

Throws:: IllegalStateException

addEventListener
```
public DubboBootstrap addEventListener(EventListener<?> listener)
```
Add an instance of EventListener

Parameters:

listener - EventListener

Returns:

DubboBootstrap

destroy
```
public void destroy()
```

getApplication

public ApplicationConfig getApplication()

Class DubboBootstrap

Field Summary

Fields inherited from interface org.apache.dubbo.common.lang.Prioritized

Method Summary

Methods inherited from class org.apache.dubbo.event.GenericEventListener

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.dubbo.event.EventListener

Methods inherited from interface org.apache.dubbo.common.lang.Prioritized

Field Detail

DEFAULT_REGISTRY_ID

DEFAULT_PROTOCOL_ID

DEFAULT_SERVICE_ID

DEFAULT_REFERENCE_ID

DEFAULT_PROVIDER_ID

DEFAULT_CONSUMER_ID

Method Detail

getInstance

unRegisterShutdownHook

metadataReport

metadataReports

application

application

application

registry

registry

registry

registries

protocol

protocol

protocol

protocols

service

service

service

services

reference

reference

reference

references

provider

provider

provider

providers

consumer

consumer

consumer

consumers

configCenter

configCenters

monitor

metrics

module

ssl

cache

getCache

exportAsync

referAsync

init

start

await

awaitFinish

isInitialized

isStarted

isReady

stop

addEventListener

destroy

getApplication