Package org.apache.dubbo.config

Class ServiceConfigBase<T>

java.lang.Object

org.apache.dubbo.config.AbstractConfig

org.apache.dubbo.config.AbstractMethodConfig

org.apache.dubbo.config.AbstractInterfaceConfig

org.apache.dubbo.config.AbstractServiceConfig

org.apache.dubbo.config.ServiceConfigBase<T>

All Implemented Interfaces:

Serializable

public abstract class ServiceConfigBase<T>
extends AbstractServiceConfig

Base configuration for service.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ServiceConfigBase()
ServiceConfigBase(Service service)
ServiceConfigBase(ModuleModel moduleModel)
ServiceConfigBase(ModuleModel moduleModel, Service service)

Method Summary

Modifier and Type	Method	Description
void	checkInterface()
final void	export()	export service and auto start application instance
abstract void	export(RegisterTypeEnum registerType)	Export service to network
Optional<String>	getContextPath(ProtocolConfig protocolConfig)
Integer	getDelay()
Boolean	getExport()
String	getGeneric()
String	getGroup()
Class<?>	getInterfaceClass()
Map<String,String>	getMetaData()	The new instance of the AbstractConfig subclass should return empty metadata. The purpose is to get the attributes set by the user instead of the default value when the AbstractConfig.refresh() method handles attribute overrides.
Map<String,String>	getMetaData(String prefix)
String	getPath()
List<String>	getPrefixes()
ProviderConfig	getProvider()
String	getProviderIds()
T	getRef()
ServiceMetadata	getServiceMetadata()
String	getUniqueServiceName()
String	getVersion()
abstract boolean	isExported()
abstract boolean	isUnexported()
final void	register()	Register delay published service to registry.
abstract void	register(boolean byDeployer)	Register delay published service to registry.
void	setGeneric(String generic)
void	setInterface(Class<?> interfaceClass)
void	setInterfaceClass(Class<?> interfaceClass)	Deprecated.
void	setPath(String path)
void	setProtocols(List<? extends ProtocolConfig> protocols)
void	setProvider(ProviderConfig provider)
void	setProviderIds(String providerIds)
void	setRef(T ref)
boolean	shouldDelay()
boolean	shouldExport()
Boolean	shouldExportAsync()
abstract void	unexport()

Methods inherited from class org.apache.dubbo.config.AbstractServiceConfig

getAccesslog, getDocument, getExecutes, getExecutor, getExportAsync, getFilter, getListener, getPayload, getPreferSerialization, getProtocol, getProtocolIds, getProtocols, getSerialization, getToken, getUseJavaPackageAsPath, getWarmup, getWeight, isDeprecated, isDynamic, isRegister, setAccesslog, setAccesslog, setDelay, setDeprecated, setDocument, setDynamic, setExecutes, setExecutor, setExport, setExportAsync, setGroup, setListener, setPayload, setPreferSerialization, setProtocol, setProtocolIds, setRegister, setSerialization, setToken, setToken, setUseJavaPackageAsPath, setVersion, setWarmup, setWeight

Methods inherited from class org.apache.dubbo.config.AbstractInterfaceConfig

addMethod, appendRuntimeParameters, getApplication, getAuth, getAuthenticator, getCallbacks, getCluster, getConfigCenter, getConnections, getExportedUrls, getGroup, getInterface, getInterfaceClassLoader, getLayer, getLocal, getMetadataReportConfig, getMethods, getModule, getMonitor, getOnconnect, getOndisconnect, getOwner, getPassword, getProxy, getRegistries, getRegistry, getRegistryIds, getScope, getSingleton, getSslConfig, getStub, getTag, getUsername, getVersion, setApplication, setAuth, setAuthenticator, setCallbacks, setCluster, setConfigCenter, setConnections, setFilter, setInterface, setInterfaceClassLoader, setLayer, setLocal, setLocal, setMetadataReportConfig, setMethods, setMethodsJson, setModule, setMonitor, setMonitor, setOnconnect, setOndisconnect, setOwner, setPassword, setProxy, setRegistries, setRegistry, setRegistryIds, setScope, setSingleton, setStub, setStub, setTag, setUsername, toUrl, toUrls

Methods inherited from class org.apache.dubbo.config.AbstractMethodConfig

getActives, getCache, getForks, getLoadbalance, getMerger, getMock, getParameters, getRetries, getScopeModel, getSent, getTimeout, getValidation, isAsync, setActives, setAsync, setCache, setForks, setLoadbalance, setMerger, setMock, setMock, setParameters, setRetries, setSent, setTimeout, setValidation

Methods inherited from class org.apache.dubbo.config.AbstractConfig

appendAttributes, appendAttributes, appendParameters, appendParameters, equals, getApplicationModel, getConfigMode, getId, getPluralTagName, getTagName, getTypePrefix, hashCode, isDefault, isNeedRefresh, isRefreshed, isValid, overrideWithConfig, refresh, setDefault, setId, setNeedRefresh, setScopeModel, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ServiceConfigBase

public ServiceConfigBase()

ServiceConfigBase

public ServiceConfigBase(ModuleModel moduleModel)

ServiceConfigBase

public ServiceConfigBase(Service service)

ServiceConfigBase

public ServiceConfigBase(ModuleModel moduleModel,
 Service service)

Method Details

setProtocols

public void setProtocols(List<? extends ProtocolConfig> protocols)

Overrides:

setProtocols in class AbstractServiceConfig

shouldExport

public boolean shouldExport()

getExport

public Boolean getExport()

Overrides:

getExport in class AbstractServiceConfig

shouldDelay

public boolean shouldDelay()

getDelay

public Integer getDelay()

Overrides:

getDelay in class AbstractServiceConfig

getContextPath

public Optional<String> getContextPath(ProtocolConfig protocolConfig)

getMetaData

public Map<String,String> getMetaData()

Description copied from class: AbstractConfig

The new instance of the AbstractConfig subclass should return empty metadata. The purpose is to get the attributes set by the user instead of the default value when the AbstractConfig.refresh() method handles attribute overrides.

The default value of the field should be set in the AbstractConfig.checkDefault() method, which will be called at the end of AbstractConfig.refresh(), so that it will not affect the behavior of attribute overrides.

Should be called after Config was fully initialized.

Notice! This method should include all properties in the returning map, treat @Parameter differently compared to appendParameters?

// FIXME: this method should be completely replaced by appendParameters? // -- Url parameter may use key, but props override only use property name. So replace it with appendAttributes().

Overrides:

getMetaData in class AbstractConfig

See Also:

• AbstractConfig.checkDefault()
• AbstractConfig.appendParameters(Map, Object, String)

getMetaData

public Map<String,String> getMetaData(String prefix)

Overrides:

getMetaData in class AbstractConfig

getInterfaceClass

public Class<?> getInterfaceClass()

setInterfaceClass

public void setInterfaceClass(Class<?> interfaceClass)

Deprecated.

See Also:

• setInterface(Class)

setInterface

public void setInterface(Class<?> interfaceClass)

checkInterface

public void checkInterface()

getRef

public T getRef()

setRef

public void setRef(T ref)

getPath

@Parameter(excluded=true)
public String getPath()

setPath

public void setPath(String path)

getProvider

public ProviderConfig getProvider()

setProvider

public void setProvider(ProviderConfig provider)

getProviderIds

@Parameter(excluded=true)
public String getProviderIds()

setProviderIds

public void setProviderIds(String providerIds)

getGeneric

public String getGeneric()

setGeneric

public void setGeneric(String generic)

getServiceMetadata

public ServiceMetadata getServiceMetadata()

getPrefixes

@Parameter(excluded=true,
           attribute=false)
public List<String> getPrefixes()

Overrides:

getPrefixes in class AbstractConfig

getUniqueServiceName

@Parameter(excluded=true,
           attribute=false)
public String getUniqueServiceName()

getGroup

public String getGroup()

Overrides:

getGroup in class AbstractServiceConfig

getVersion

public String getVersion()

Overrides:

getVersion in class AbstractServiceConfig

shouldExportAsync

public Boolean shouldExportAsync()

export

public final void export()

export service and auto start application instance

unexport

public abstract void unexport()

isExported

public abstract boolean isExported()

isUnexported

public abstract boolean isUnexported()

export

public abstract void export(RegisterTypeEnum registerType)

Export service to network

Parameters:

registerType - register type of current export action.

register

public final void register()

Register delay published service to registry.

register

public abstract void register(boolean byDeployer)

Register delay published service to registry.

Parameters:

byDeployer - register by deployer or not.