com.alipay.sofa.runtime.spi.component

Interface ComponentManager

All Known Implementing Classes:

ComponentManagerImpl

public interface ComponentManager

Component Manager

Author:

xuanbei 18/2/28

Method Summary

Modifier and Type	Method and Description
ComponentInfo	getComponentInfo(ComponentName name) get concrete component by component name
Collection<ComponentInfo>	getComponentInfosByType(ComponentType type) get components by component type
Collection<ComponentInfo>	getComponents() get all components in this manager
Collection<ComponentType>	getComponentTypes() get all component types in this manager
boolean	isRegistered(ComponentName name) whether the component is registered or not
void	register(ComponentInfo componentInfo)
ComponentInfo	registerAndGet(ComponentInfo componentInfo) register and get component in this manager
void	registerComponentClient(Class<?> clientType, Object client) register component client in this manager
void	resolvePendingResolveComponent(ComponentName componentName) resolve pending component
void	shutdown() Shuts down the component registry.
int	size() Gets the number of registered objects in this registry.
void	unregister(ComponentInfo componentInfo) remove component in this manager

Method Detail

getComponentTypes

Collection<ComponentType> getComponentTypes()

get all component types in this manager

Returns:

all component types

register

void register(ComponentInfo componentInfo)

registerAndGet

ComponentInfo registerAndGet(ComponentInfo componentInfo)

register and get component in this manager

Parameters:

componentInfo - component that should be registered

Returns:

component info

unregister

void unregister(ComponentInfo componentInfo)
         throws ServiceRuntimeException

remove component in this manager

Parameters:

componentInfo - component that should unregister

Throws:

ServiceRuntimeException - throws when exception occur

registerComponentClient

void registerComponentClient(Class<?> clientType,
                             Object client)

register component client in this manager

Parameters:

clientType - client type

client - client implementation

getComponentInfo

ComponentInfo getComponentInfo(ComponentName name)

get concrete component by component name

Parameters:

name - component name

Returns:

concrete component

isRegistered

boolean isRegistered(ComponentName name)

whether the component is registered or not

Parameters:

name - name

Returns:

true or false

getComponents

Collection<ComponentInfo> getComponents()

get all components in this manager

Returns:

all components

size

int size()

Gets the number of registered objects in this registry.

Returns:

the number fo registered objects

shutdown

void shutdown()

Shuts down the component registry. This unregisters all objects registered in this registry.

getComponentInfosByType

Collection<ComponentInfo> getComponentInfosByType(ComponentType type)

get components by component type

Parameters:

type - component type

Returns:

components

resolvePendingResolveComponent

void resolvePendingResolveComponent(ComponentName componentName)

resolve pending component

Parameters:

componentName - component name