org.apache.dubbo.registry.integration

Class RegistryProtocol

java.lang.Object

org.apache.dubbo.registry.integration.RegistryProtocol

All Implemented Interfaces:

Protocol

public class RegistryProtocol
extends Object
implements Protocol

RegistryProtocol

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegistryProtocol.InvokerDelegate<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_REGISTER_CONSUMER_KEYS
static String[]	DEFAULT_REGISTER_PROVIDER_KEYS

Constructor Summary

Constructors

Constructor and Description
RegistryProtocol()

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy protocol: 1.
<T> Exporter<T>	export(Invoker<T> originInvoker) Export service for remote invocation: 1.
int	getDefaultPort() Get default port when user doesn't config the port.
Map<URL,NotifyListener>	getOverrideListeners()
String[]	getParamsToRegistry(String[] defaultKeys, String[] additionalParameterKeys)
URL	getRegisteredConsumerUrl(URL consumerUrl, URL registryUrl)
static RegistryProtocol	getRegistryProtocol()
<T> void	reExport(Invoker<T> originInvoker, URL newInvokerUrl)
<T> Invoker<T>	refer(Class<T> type, URL url) Refer a remote service: 1.
void	register(URL registryUrl, URL registeredProviderUrl)
void	setCluster(Cluster cluster)
void	setProtocol(Protocol protocol)
void	setProxyFactory(ProxyFactory proxyFactory)
void	setRegistryFactory(RegistryFactory registryFactory)
void	unregister(URL registryUrl, URL registeredProviderUrl)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_REGISTER_PROVIDER_KEYS

public static final String[] DEFAULT_REGISTER_PROVIDER_KEYS

DEFAULT_REGISTER_CONSUMER_KEYS

public static final String[] DEFAULT_REGISTER_CONSUMER_KEYS

Constructor Detail

RegistryProtocol

public RegistryProtocol()

Method Detail

getRegistryProtocol

public static RegistryProtocol getRegistryProtocol()

setCluster

public void setCluster(Cluster cluster)

setProtocol

public void setProtocol(Protocol protocol)

setRegistryFactory

public void setRegistryFactory(RegistryFactory registryFactory)

setProxyFactory

public void setProxyFactory(ProxyFactory proxyFactory)

getDefaultPort

public int getDefaultPort()

Description copied from interface: Protocol

Get default port when user doesn't config the port.

Specified by:

getDefaultPort in interface Protocol

Returns:

default port

getOverrideListeners

public Map<URL,NotifyListener> getOverrideListeners()

register

public void register(URL registryUrl,
                     URL registeredProviderUrl)

unregister

public void unregister(URL registryUrl,
                       URL registeredProviderUrl)

export

public <T> Exporter<T> export(Invoker<T> originInvoker)
                       throws RpcException

Description copied from interface: Protocol

Export service for remote invocation:
1. Protocol should record request source address after receive a request: RpcContext.getContext().setRemoteAddress();
2. export() must be idempotent, that is, there's no difference between invoking once and invoking twice when export the same URL
3. Invoker instance is passed in by the framework, protocol needs not to care

Specified by:

export in interface Protocol

Type Parameters:

T - Service type

Parameters:

originInvoker - Service invoker

Returns:

exporter reference for exported service, useful for unexport the service later

Throws:

RpcException - thrown when error occurs during export the service, for example: port is occupied

reExport

public <T> void reExport(Invoker<T> originInvoker,
                         URL newInvokerUrl)

refer

public <T> Invoker<T> refer(Class<T> type,
                            URL url)
                     throws RpcException

Description copied from interface: Protocol

Refer a remote service:
1. When user calls `invoke()` method of `Invoker` object which's returned from `refer()` call, the protocol needs to correspondingly execute `invoke()` method of `Invoker` object
2. It's protocol's responsibility to implement `Invoker` which's returned from `refer()`. Generally speaking, protocol sends remote request in the `Invoker` implementation.
3. When there's check=false set in URL, the implementation must not throw exception but try to recover when connection fails.

Specified by:

refer in interface Protocol

Type Parameters:

T - Service type

Parameters:

type - Service class

url - URL address for the remote service

Returns:

invoker service's local proxy

Throws:

RpcException - when there's any error while connecting to the service provider

getRegisteredConsumerUrl

public URL getRegisteredConsumerUrl(URL consumerUrl,
                                    URL registryUrl)

getParamsToRegistry

public String[] getParamsToRegistry(String[] defaultKeys,
                                    String[] additionalParameterKeys)

destroy

public void destroy()

Description copied from interface: Protocol

Destroy protocol:
1. Cancel all services this protocol exports and refers
2. Release all occupied resources, for example: connection, port, etc.
3. Protocol can continue to export and refer new service even after it's destroyed.

Specified by:

destroy in interface Protocol